Add $id to configuration schema, switch to version-specific repositor…

…y links.
DavidAnson · Nov 24, 2023 · 04c26d8 · 04c26d8
1 parent 8524909
commit 04c26d8
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -455,12 +455,12 @@ See [CHANGELOG.md][changelog].
 [markdown-it-plugins]: https://www.npmjs.com/search?q=keywords:markdown-it-plugin
 [markdown-it-syntax-extensions]: https://github.com/markdown-it/markdown-it#syntax-extensions
 [markdownlint]: https://github.com/DavidAnson/markdownlint
-[markdownlint-config]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#optionsconfig
-[markdownlint-configuration]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#configuration
-[markdownlint-custom-rules]: https://github.com/DavidAnson/markdownlint/blob/main/doc/CustomRules.md
-[markdownlint-options]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#options
-[markdownlint-rules-aliases]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
-[markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#tags
+[markdownlint-config]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#optionsconfig
+[markdownlint-configuration]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#configuration
+[markdownlint-custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/CustomRules.md
+[markdownlint-options]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#options
+[markdownlint-rules-aliases]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#rules--aliases
+[markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/README.md#tags
 [markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2
 [markdownlint-cli2-action]: https://github.com/marketplace/actions/markdownlint-cli2-action
@@ -471,10 +471,10 @@ See [CHANGELOG.md][changelog].
 [markdownlint-cli2-mjs]: test/markdownlint-cli2-mjs/.markdownlint-cli2.mjs
 [markdownlint-cli2-yaml]: test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
 [markdownlint-cjs]: test/markdownlint-cjs/.markdownlint.cjs
-[markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc
+[markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/schema/.markdownlint.jsonc
 [markdownlint-mjs]: test/markdownlint-mjs/.markdownlint.mjs
 [markdownlint-rule]: https://www.npmjs.com/search?q=keywords:markdownlint-rule
-[markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+[markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/schema/.markdownlint.yaml
 [nodejs]: https://nodejs.org/
 [nodejs-docker]: https://github.com/nodejs/docker-node
 [nodejs-docker-non-root]: https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#non-root-user

diff --git a/doc/OutputFormatters.md b/doc/OutputFormatters.md
@@ -63,4 +63,4 @@ For a `.markdownlint-cli2.jsonc` like:
 [formatter-junit]: ../formatter-junit/markdownlint-cli2-formatter-junit.js
 [formatter-sarif]: ../formatter-sarif/markdownlint-cli2-formatter-sarif.js
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
-[markdownlint-d-ts]: https://github.com/DavidAnson/markdownlint/blob/main/lib/markdownlint.d.ts
+[markdownlint-d-ts]: https://github.com/DavidAnson/markdownlint/blob/v0.32.1/lib/markdownlint.d.ts
diff --git a/schema/markdownlint-cli2-config-schema.json b/schema/markdownlint-cli2-config-schema.json
@@ -1,12 +1,13 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.11.0/schema/markdownlint-cli2-config-schema.json",
   "title": "markdownlint-cli2 configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
-      "description": "JSON Schema URI (used by some editors)",
+      "description": "JSON Schema URI (expected by some editors)",
       "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.11.0/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
       "description": "markdownlint-cli2 configuration schema",

diff --git a/test/markdownlint-cli2-test.js b/test/markdownlint-cli2-test.js
@@ -9,12 +9,9 @@ const { "main": markdownlintCli2 } = require("../markdownlint-cli2.js");
 const FsMock = require("./fs-mock");
 
 const jsonSchemaVersion = "http://json-schema.org/draft-07/schema#";
-const markdownlintConfigSchemaUri = "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-config-schema.json";
-const markdownlintConfigSchemaDefinition =
-  require("../schema/markdownlint-config-schema.json");
-const markdownlintCli2ConfigSchemaUri = "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json";
-const markdownlintCli2ConfigSchemaDefinition =
-  require("../schema/markdownlint-cli2-config-schema.json");
+const markdownlintConfigSchemaUri = "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.11.0/schema/markdownlint-config-schema.json";
+const markdownlintConfigSchemaDefinition = require("../schema/markdownlint-config-schema.json");
+const markdownlintCli2ConfigSchemaDefinition = require("../schema/markdownlint-cli2-config-schema.json");
 
 const outputFormatterLengthIs = (t, length) => (options) => {
   const { results } = options;
@@ -121,12 +118,9 @@ test("validateMarkdownlintCli2ConfigSchema", async (t) => {
   // Validate instances
   // @ts-ignore
   addSchema(markdownlintConfigSchemaDefinition, markdownlintConfigSchemaUri);
-  addSchema(
-    // @ts-ignore
-    markdownlintCli2ConfigSchemaDefinition,
-    markdownlintCli2ConfigSchemaUri
-  );
-  const validateConfigSchema = await validate(markdownlintCli2ConfigSchemaUri);
+  // @ts-ignore
+  addSchema(markdownlintCli2ConfigSchemaDefinition);
+  const validateConfigSchema = await validate(markdownlintCli2ConfigSchemaDefinition.$id);
   const { "default": stripJsonComments } = await import("strip-json-comments");
   const { globby } = await import("globby");
   const files = await globby(