Proposal for additional APIs

I would like to propose additional APIs. I’m not sure which object they should be attached to, as they don’t seem to fit any of the current ones we have. Maybe linter, since they are all global.

version

Should return current ESLint version. This is necessary to correctly invalidate session storage data in the online demo, and probably useful for tools as well

getRules()

Should return all currently loaded rules. If CLIEngine.addPlugin has been called prior to this API call, it should also return rules from plugin. Return should be an array of object with rule name, rule schema and current configuration.

getRuleMetadata(null|string)

Should return metadata for all currently loaded rules (plugins included). Can be merged with getRules command.

[ilyavolodin]

TSC Summary: This is the proposal to add two new API methods:

• version in both linter and CLIEngine objects. Would return current ESLint version
• getRules in linter object. Would return an array of all rules currently loaded.

[nzakas]

If we do, then we can have eslint:recommended be a dynamic JS file that iterates through rules and returns those with meta.recommended = true, so we would only need to update one location (per rule) to add them to eslint:recommended.

There’s nothing preventing us from doing that right now.

I think we only need version and getRules, since you can get metadata directly off of the rules.