jsonschema2md icon indicating copy to clipboard operation
jsonschema2md copied to clipboard

Additional fields meta schema / JSON Schema linting rules?

Open Relequestual opened this issue 6 years ago • 2 comments

Background: I work on JSON Schema the specification. I'm developing a "JSON Schema Linter" rule listing, and collaborating with an existing tool for linting.

I've been further testing jsonschema2md, and found that using my existing schemas, I've encountered issues such as the main readme.md didn't include links to the files, which was because my schemas had no title.

Linting, to check the schemas have a title, would be useful, right? You could add a warning or even enable via option, a mode which errors should specific linting rules fail.

It would be super if you could create one of or both of the following.

  • A meta-schema for the additional fields you've added to make more useful documentation
  • A list of linting rules which would be useful to this tool

Relequestual avatar Apr 01 '19 12:04 Relequestual

Good idea. Do you have a Schema Linter you are using right now?

trieloff avatar Apr 15 '19 08:04 trieloff

There's a JSON linter at https://github.com/stoplightio/spectral which is what I'm planning to use for JSON Schema Lint. A member of the JSON Schema SC works there now, so let me know if you have any issues or queries. I haven't tested it myself yet.

Relequestual avatar Apr 15 '19 08:04 Relequestual