Consider adding meta.schema

[MrHBS]

It would be equivalent to ESLint’s meta.schema. This can be used for generating plugin/rule documentation websites and typegens.

[ybiquitous]

Sounds good 👍🏼

Maybe one downside is increasing a dependency that processes the JSON schema, right?

[MrHBS]

Yeah, I believe ESLint uses Ajv JSON schema validator for this.

[ybiquitous]

Great. ajv is already included in our runtime dependency tree (stylelint depends on table).

$ npm ls ajv
stylelint@16.3.1 /Users/masafumi.koba/git/stylelint/stylelint
├─┬ eslint@8.57.0
│ ├─┬ @eslint/eslintrc@2.1.4
│ │ └── ajv@6.12.6 deduped
│ └── ajv@6.12.6
└─┬ table@6.8.2
  └── ajv@8.12.0

[ybiquitous]

@MrHBS If you're interested, could you please show more specific idea to implement this feature so that others could image it easily?

[MrHBS]

Sure. Here is an example of the schema of the accessor-pairs rule:

https://github.com/eslint/eslint/blob/1cbe1f6d38272784307c260f2375ab30e68716e8/lib/rules/accessor-pairs.js#L148-L165

And you can see here how ESLint validates the rule based on its schema.

Finally, an example of tools that utilize this schema: eslint-doc-generator and eslint-typegen.

[ybiquitous]

@MrHBS Thanks for the helpful info.

@ota-meshi Do you have any ideas to bring this feature from ESLint?

[Mouvedia]

Here's another use case for autocompletion: knowing the message arguments' names and positions.