Comments (4)
Exactly, yeah. Something defined in the schema as:
schema: [{
type: "string",
description: "..."
}]
I'm able to use an object property for now (which may be a better api for my case)
from eslint-doc-generator.
Unless I'm missing something, options defined as type: "string"
will also not show up in the docs automatically
from eslint-doc-generator.
@TheSonOfThomp I assume you mean a rule like quotes that is configured with a string value instead of an object: quotes: ["error", "double"]
. Yes, we haven't supported that type of rule config yet.
from eslint-doc-generator.
An object API for rules is almost always a better choice as it allows you to add additional options later (much more future-proof). However, it would still be good for us to support the basic string scenario.
from eslint-doc-generator.
Related Issues (20)
- Support plugins without rule docs
- Sort emojis before badges HOT 1
- Center emojis in column HOT 1
- Remove Node 14, 16, 19 from CI matrix
- Documentation for Shared Configuration HOT 1
- Monorepo support? HOT 6
- Poor error message for package.json exports pointing to non-existent path HOT 1
- Specify rule `type` (needed for `--fix-type`) in rule doc
- Default to using colored emojis instead of badges for configs without emojis
- Consider unified option for controlling what features are required
- Re-evaluate `--path-rule-list` option in the context of config lists
- Consider addition config list columns
- Process fails with `--init-rule-docs` when no docs need to be created HOT 1
- Add more default config emojis
- Deprecate and remove support for badges defined in READMEs
- Make the `path-rule-doc` parameter can accept a function HOT 2
- Support ESM HOT 6
- Custom properties like `description` not allowed on ESLint flat configs
- Docs get regenerated HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from eslint-doc-generator.