Proposal for additional APIs
See original GitHub issueI 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.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:4
- Comments:28 (26 by maintainers)
Top Results From Across the Web
API Design, Proposal and Evaluation
API Design and Evaluation Considerations · There is no "recipe" for designing or evaluating an API. · An API is a clean, clear...
Read more >API documentation proposal · WebPlatform Docs
Template and forms changes that need to be implemented; Priorities and project management; Additional documents. Current state of the WPD API documentation.
Read more >Guide to building an enterprise API strategy | TechTarget
APIs enable enterprises to better deliver diverse data and services to internal and external customers, and open up new revenue streams.
Read more >GSoC proposal: v2 API development - Public Lab
V2 API development and 3rd party app integrations. Abstract/summary. Further development of the RESTful API to migrate old legacy code to the new...
Read more >API Improvement Proposals: Google's Take on the API Style ...
API Improvement Proposals, or AIPs, are documents outlining Google's guidelines for API design. Most AIPs focus on universal design standards — ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
TSC Summary: This is the proposal to add two new API methods:
version
in bothlinter
andCLIEngine
objects. Would return current ESLint versiongetRules
inlinter
object. Would return an array of all rules currently loaded.There’s nothing preventing us from doing that right now.
I think we only need
version
andgetRules
, since you can get metadata directly off of the rules.