tcort / markdown-link-check

checks all of the hyperlinks in a markdown text to determine if they are alive or dead
ISC License
577 stars 116 forks source link

Update JSON Schema Store to include projectBaseUrl #355

Closed wesley-dean-gsa closed 1 month ago

wesley-dean-gsa commented 1 month ago

Bonjour hi,

While using v8r through MegaLinter, I started receiving the following error message:

ℹ No config file found
ℹ Processing ./.markdown-link-check.json
ℹ Found schema in https://www.schemastore.org/api/json/catalog.json ...
ℹ Validating ./.markdown-link-check.json against schema from https://json.schemastore.org/markdown-link-check.json ...
✖ ./.markdown-link-check.json is invalid

./.markdown-link-check.json# must NOT have additional properties

The JSON file being validated is:

{
  "retryOn429": true,
  "retryCount": 5,
  "aliveStatusCodes": [
    200,
    203,
    206
  ],
  "projectBaseUrl": "https://github.com/org/repo/",
  "ignorePatterns": [
    {
      "pattern": "^https?://github.com/"
    }
  ]
}

I then went to the markdown-link-check entry on SchemaStore and noticed that the projectBaseUrl item isn't present. I was expecting to see something like:

    "projectBaseUrl": {
      "type": "string"
    },

The markdown-link-check.json file is hosted on GitHub.

wesley-dean-gsa commented 1 month ago

@tcort, I submitted a PR to address this: SchemaStore/schemastore#3972

If you disagree with what I submitted or if you would rather submit something your self, that's totally cool with me. If you want to drop a comment on the PR as the author of the tool, I'm pretty sure it wouldn't hurt.

wesley-dean-gsa commented 1 month ago

SchemaStore/schemastore#3972 has been merged and the aforementioned .markdown-link-check.json with the projectBaseUrl field validates properly.

ℹ No config file found
ℹ Processing ./.markdown-link-check.json
ℹ Found schema in https://www.schemastore.org/api/json/catalog.json ...
ℹ Validating ./.markdown-link-check.json against schema from https://json.schemastore.org/markdown-link-check.json ...
✔ ./.markdown-link-check.json is valid

Thank you for your most excellent tool and all of your hard word. Folks like you who put so much time and effort into good tooling are the unsung heroes of IT world.