Add a config schema

This enables auto-completion for the `csharpier` section of `dprint.json` when using the dprint vscode extension.
Phault · Feb 24, 2024 · 53e2db7 · 53e2db7
1 parent e89977e
commit 53e2db7
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -74,6 +74,9 @@ jobs:
         id: get_plugin_file_checksum
         run: echo "::set-output name=CHECKSUM::$(shasum -a 256 plugin.json | awk '{print $1}')"
 
+      - name: Update Config Schema Version
+        run: 'sed -i '''' ''s/csharpier\/0.0.0/csharpier\/${{ steps.get_tag_version.outputs.TAG_VERSION }}/'' deployment/schema.json'
+
       - name: Create release notes
         if: startsWith(github.ref, 'refs/tags/')
         run: deno run -A ./scripts/generate_release_notes.ts ${{ steps.get_tag_version.outputs.TAG_VERSION }} ${{ steps.get_plugin_file_checksum.outputs.CHECKSUM }} > ${{ github.workspace }}-CHANGELOG.txt
@@ -93,5 +96,6 @@ jobs:
             dprint-plugin-csharpier-aarch64-unknown-linux-musl.zip
             dprint-plugin-csharpier-x86_64-pc-windows-msvc.zip
             plugin.json
+            deployment/schema.json
           body_path: ${{ github.workspace }}-CHANGELOG.txt
           draft: false
diff --git a/DprintPluginCsharpier/DprintPluginCsharpier.csproj b/DprintPluginCsharpier/DprintPluginCsharpier.csproj
@@ -6,7 +6,7 @@
     <RootNamespace>Dprint.Plugins.Csharpier</RootNamespace>
     <AssemblyName>dprint-plugin-csharpier</AssemblyName>
     <Nullable>enable</Nullable>
-    <Version>0.2.1</Version>
+    <Version>0.2.2</Version>
     <Authors>Casper Lindschouw</Authors>
   </PropertyGroup>
 

diff --git a/DprintPluginCsharpier/MessageProcessor.cs b/DprintPluginCsharpier/MessageProcessor.cs
@@ -197,7 +197,7 @@ private static string GetPluginInfo()
               "version": "{{GetAssemblyVersion()}}",
               "configKey": "csharpier",
               "helpUrl": "https://github.com/Phault/dprint-plugin-csharpier",
-              "configSchemaUrl": "",
+              "configSchemaUrl": "https://plugins.dprint.dev/Phault/dprint-plugin-csharpier/{{GetAssemblyVersion()}}/schema.json",
               "updateUrl": "https://plugins.dprint.dev/Phault/dprint-plugin-csharpier/latest.json"
             }
             """;

diff --git a/deployment/schema.json b/deployment/schema.json
@@ -0,0 +1,51 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://plugins.dprint.dev/Phault/dprint-plugin-csharpier/0.0.0/schema.json",
+  "type": "object",
+  "properties": {
+    "printWidth": {
+      "description": "Specify at what point the printer will wrap content. This is not a hard limit. Some lines will be shorter or longer.",
+      "default": 100,
+      "type": "number"
+    },
+    "useTabs": {
+      "description": "Indent lines with tabs instead of spaces.",
+      "type": "boolean",
+      "default": false,
+      "oneOf": [
+        {
+          "const": true,
+          "description": ""
+        },
+        {
+          "const": false,
+          "description": ""
+        }
+      ]
+    },
+    "tabWidth": {
+      "description": "Specify the number of spaces used per indentation level.",
+      "default": 4,
+      "type": "number"
+    },
+    "endOfLine": {
+      "description": "The kind of newline to use.",
+      "type": "string",
+      "default": "auto",
+      "oneOf": [
+        {
+          "const": "auto",
+          "description": "Maintain existing line endings (mixed values within one file are normalised by looking at what's used after the first line)"
+        },
+        {
+          "const": "lf",
+          "description": "Line Feed only (\\n), common on Linux and macOS as well as inside git repos"
+        },
+        {
+          "const": "crlf",
+          "description": "Carriage Return + Line Feed characters (\\r\\n), common on Windows"
+        }
+      ]
+    }
+  }
+}