Skip to content

Commit dbd96b2

Browse files
FloEdelmannaladdin-add
FloEdelmann
and
aladdin-add
authoredDec 18, 2024··
feat: Add new no-meta-schema-default rule (#503)
* Add new `no-meta-schema-default` rule * Disable rule locally * Compare `type` rather than `key` Co-authored-by: 唯然 <weiran.zsd@outlook.com> --------- Co-authored-by: 唯然 <weiran.zsd@outlook.com>
·
v6.4.0
1 parent 8de68ec commit dbd96b2

File tree

5 files changed

+449
-0
lines changed

5 files changed

+449
-0
lines changed
 

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ module.exports = [
8686
| [meta-property-ordering](docs/rules/meta-property-ordering.md) | enforce the order of meta properties | | 🔧 | | |
8787
| [no-deprecated-context-methods](docs/rules/no-deprecated-context-methods.md) | disallow usage of deprecated methods on rule context objects | ✅ | 🔧 | | |
8888
| [no-deprecated-report-api](docs/rules/no-deprecated-report-api.md) | disallow the version of `context.report()` with multiple arguments | ✅ | 🔧 | | |
89+
| [no-meta-schema-default](docs/rules/no-meta-schema-default.md) | disallow rules `meta.schema` properties to include defaults | | | | |
8990
| [no-missing-message-ids](docs/rules/no-missing-message-ids.md) | disallow `messageId`s that are missing from `meta.messages` | ✅ | | | |
9091
| [no-missing-placeholders](docs/rules/no-missing-placeholders.md) | disallow missing placeholders in rule report messages | ✅ | | | |
9192
| [no-property-in-node](docs/rules/no-property-in-node.md) | disallow using `in` to narrow node types instead of looking at properties | | | | 💭 |

‎docs/rules/no-meta-schema-default.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Disallow rules `meta.schema` properties to include defaults (`eslint-plugin/no-meta-schema-default`)
2+
3+
<!-- end auto-generated rule header -->
4+
5+
Since ESLint v9.15.0, rules' default options are supported using `meta.defaultOptions`. Additionally defining them using the `default` property in `meta.schema` is confusing, error-prone, and can be ambiguous for complex schemas.
6+
7+
## Rule Details
8+
9+
This rule disallows the `default` property in rules' `meta.schema`.
10+
11+
Examples of **incorrect** code for this rule:
12+
13+
```js
14+
/* eslint eslint-plugin/no-meta-schema-default: error */
15+
16+
module.exports = {
17+
meta: {
18+
schema: [
19+
{
20+
elements: { type: 'string' },
21+
type: 'array',
22+
default: [],
23+
},
24+
],
25+
},
26+
create() {},
27+
};
28+
29+
module.exports = {
30+
meta: {
31+
schema: {
32+
type: 'object',
33+
properties: {
34+
foo: { type: 'string', default: 'bar' },
35+
baz: { type: 'number', default: 42 },
36+
},
37+
},
38+
},
39+
create() {},
40+
};
41+
```
42+
43+
Examples of **correct** code for this rule:
44+
45+
```js
46+
/* eslint eslint-plugin/no-meta-schema-default: error */
47+
48+
module.exports = {
49+
meta: {
50+
schema: [
51+
{
52+
elements: { type: 'string' },
53+
type: 'array',
54+
},
55+
],
56+
defaultOptions: [[]],
57+
},
58+
create() {},
59+
};
60+
61+
module.exports = {
62+
meta: {
63+
schema: {
64+
type: 'object',
65+
properties: {
66+
foo: { type: 'string' },
67+
baz: { type: 'number' },
68+
},
69+
},
70+
defaultOptions: [{ foo: 'bar', baz: 42 }],
71+
},
72+
create() {},
73+
};
74+
```
75+
76+
## When Not To Use It
77+
78+
When using [`eslint-doc-generator`](https://github.com/bmish/eslint-doc-generator) to generate documentation for your rules, you may want to disable this rule to include the `default` property in the generated documentation. This is because `eslint-doc-generator` does not yet support `meta.defaultOptions`, see [bmish/eslint-doc-generator#513](https://github.com/bmish/eslint-doc-generator/issues/513).
79+
80+
## Further Reading
81+
82+
- [ESLint rule docs: Option Defaults](https://eslint.org/docs/latest/extend/custom-rules#option-defaults)
83+
- [RFC introducing `meta.defaultOptions`](https://github.com/eslint/rfcs/blob/main/designs/2023-rule-options-defaults/README.md)

‎eslint.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ module.exports = [
4141
plugins: eslintPluginConfig.plugins,
4242
rules: {
4343
...eslintPluginConfig.rules,
44+
'eslint-plugin/no-meta-schema-default': 'off', // TODO: enable once https://github.com/bmish/eslint-doc-generator/issues/513 is fixed and released
4445
'eslint-plugin/report-message-format': ['error', '^[^a-z].*.$'],
4546
'eslint-plugin/require-meta-docs-url': [
4647
'error',

‎lib/rules/no-meta-schema-default.js

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
'use strict';
2+
3+
const { getStaticValue } = require('@eslint-community/eslint-utils');
4+
const utils = require('../utils');
5+
6+
// ------------------------------------------------------------------------------
7+
// Rule Definition
8+
// ------------------------------------------------------------------------------
9+
10+
/** @type {import('eslint').Rule.RuleModule} */
11+
module.exports = {
12+
meta: {
13+
type: 'suggestion',
14+
docs: {
15+
description:
16+
'disallow rules `meta.schema` properties to include defaults',
17+
category: 'Rules',
18+
recommended: false,
19+
url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-meta-schema-default.md',
20+
},
21+
schema: [],
22+
messages: {
23+
foundDefault: 'Disallowed default value in schema.',
24+
},
25+
},
26+
27+
create(context) {
28+
const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
29+
const { scopeManager } = sourceCode;
30+
const ruleInfo = utils.getRuleInfo(sourceCode);
31+
if (!ruleInfo) {
32+
return {};
33+
}
34+
35+
const schemaNode = utils.getMetaSchemaNode(ruleInfo.meta, scopeManager);
36+
if (!schemaNode) {
37+
return {};
38+
}
39+
40+
const schemaProperty = utils.getMetaSchemaNodeProperty(
41+
schemaNode,
42+
scopeManager,
43+
);
44+
45+
if (schemaProperty?.type === 'ObjectExpression') {
46+
checkSchemaElement(schemaProperty, true);
47+
} else if (schemaProperty?.type === 'ArrayExpression') {
48+
for (const element of schemaProperty.elements) {
49+
checkSchemaElement(element, true);
50+
}
51+
}
52+
53+
return {};
54+
55+
function checkSchemaElement(node) {
56+
if (node.type !== 'ObjectExpression') {
57+
return;
58+
}
59+
60+
for (const { type, key, value } of node.properties) {
61+
if (type !== 'Property') {
62+
continue;
63+
}
64+
const staticKey =
65+
key.type === 'Identifier' ? { value: key.name } : getStaticValue(key);
66+
if (!staticKey?.value) {
67+
continue;
68+
}
69+
70+
switch (key.name ?? key.value) {
71+
case 'allOf':
72+
case 'anyOf':
73+
case 'oneOf': {
74+
if (value.type === 'ArrayExpression') {
75+
for (const element of value.elements) {
76+
checkSchemaElement(element);
77+
}
78+
}
79+
80+
break;
81+
}
82+
83+
case 'properties': {
84+
if (Array.isArray(value.properties)) {
85+
for (const property of value.properties) {
86+
if (property.value?.type === 'ObjectExpression') {
87+
checkSchemaElement(property.value);
88+
}
89+
}
90+
}
91+
92+
break;
93+
}
94+
95+
case 'elements': {
96+
checkSchemaElement(value);
97+
98+
break;
99+
}
100+
101+
case 'default': {
102+
context.report({
103+
messageId: 'foundDefault',
104+
node: key,
105+
});
106+
107+
break;
108+
}
109+
}
110+
}
111+
}
112+
},
113+
};

‎tests/lib/rules/no-meta-schema-default.js

+251
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
'use strict';
2+
3+
// ------------------------------------------------------------------------------
4+
// Requirements
5+
// ------------------------------------------------------------------------------
6+
7+
const rule = require('../../../lib/rules/no-meta-schema-default');
8+
const RuleTester = require('../eslint-rule-tester').RuleTester;
9+
10+
// ------------------------------------------------------------------------------
11+
// Tests
12+
// ------------------------------------------------------------------------------
13+
14+
const ruleTester = new RuleTester({
15+
languageOptions: { sourceType: 'commonjs' },
16+
});
17+
18+
ruleTester.run('no-meta-schema-default', rule, {
19+
valid: [
20+
``,
21+
`
22+
module.exports = {};
23+
`,
24+
`
25+
module.exports = {
26+
create() {}
27+
};
28+
`,
29+
`
30+
module.exports = {
31+
meta: {
32+
schema: false,
33+
},
34+
create() {}
35+
};
36+
`,
37+
`
38+
module.exports = {
39+
meta: {
40+
schema: [false],
41+
},
42+
create() {}
43+
};
44+
`,
45+
`
46+
module.exports = {
47+
meta: {
48+
schema: [
49+
{
50+
description: 'Elements to allow.',
51+
elements: { type: 'string' },
52+
type: 'array',
53+
},
54+
],
55+
},
56+
};
57+
`,
58+
`
59+
module.exports = {
60+
meta: {
61+
schema: [
62+
{
63+
oneOf: [
64+
{
65+
description: 'Elements to allow.',
66+
elements: { type: 'string' },
67+
type: 'array',
68+
}
69+
],
70+
},
71+
],
72+
},
73+
create() {}
74+
};
75+
`,
76+
`
77+
module.exports = {
78+
meta: {
79+
schema: [
80+
{
81+
type: 'object',
82+
properties: null,
83+
additionalProperties: false
84+
}
85+
],
86+
},
87+
create() {}
88+
}
89+
`,
90+
`
91+
const schemaProperties = Object.freeze({});
92+
93+
module.exports = {
94+
meta: {
95+
schema: [
96+
{
97+
type: 'object',
98+
properties: {
99+
...schemaProperties,
100+
},
101+
}
102+
],
103+
},
104+
create() {}
105+
}
106+
`,
107+
`
108+
module.exports = {
109+
meta: {
110+
schema: [
111+
{
112+
type: 'object',
113+
properties: Object.fromEntries(
114+
Object.keys(DEFAULT_OPTIONS).map((code) => [
115+
code,
116+
{ type: 'boolean' }
117+
])
118+
),
119+
additionalProperties: false
120+
}
121+
],
122+
},
123+
create() {}
124+
}
125+
`,
126+
],
127+
128+
invalid: [
129+
{
130+
code: `
131+
module.exports = {
132+
meta: {
133+
schema: [
134+
{
135+
elements: { type: 'string' },
136+
type: 'array',
137+
default: [],
138+
},
139+
],
140+
},
141+
create() {}
142+
};
143+
`,
144+
errors: [
145+
{
146+
messageId: 'foundDefault',
147+
line: 8,
148+
column: 17,
149+
endLine: 8,
150+
endColumn: 24,
151+
},
152+
],
153+
},
154+
{
155+
code: `
156+
module.exports = {
157+
meta: {
158+
schema: [
159+
{
160+
elements: { type: 'string', default: 'foo' },
161+
type: 'array',
162+
},
163+
],
164+
},
165+
create() {}
166+
};
167+
`,
168+
errors: [
169+
{
170+
messageId: 'foundDefault',
171+
line: 6,
172+
column: 45,
173+
endLine: 6,
174+
endColumn: 52,
175+
},
176+
],
177+
},
178+
{
179+
code: `
180+
module.exports = {
181+
meta: {
182+
schema: {
183+
anyOf: [
184+
{
185+
elements: { type: 'string' },
186+
type: 'array',
187+
default: [],
188+
},
189+
{
190+
type: 'string',
191+
default: 'foo',
192+
}
193+
],
194+
},
195+
},
196+
create() {}
197+
};
198+
`,
199+
errors: [
200+
{
201+
messageId: 'foundDefault',
202+
line: 9,
203+
column: 19,
204+
endLine: 9,
205+
endColumn: 26,
206+
},
207+
{
208+
messageId: 'foundDefault',
209+
line: 13,
210+
column: 19,
211+
endLine: 13,
212+
endColumn: 26,
213+
},
214+
],
215+
},
216+
{
217+
code: `
218+
module.exports = {
219+
meta: {
220+
schema: [
221+
{
222+
type: 'object',
223+
properties: {
224+
foo: { type: 'string', default: 'bar' },
225+
baz: { type: 'number', default: 42 },
226+
},
227+
},
228+
]
229+
},
230+
create() {}
231+
};
232+
`,
233+
errors: [
234+
{
235+
messageId: 'foundDefault',
236+
line: 8,
237+
column: 42,
238+
endLine: 8,
239+
endColumn: 49,
240+
},
241+
{
242+
messageId: 'foundDefault',
243+
line: 9,
244+
column: 42,
245+
endLine: 9,
246+
endColumn: 49,
247+
},
248+
],
249+
},
250+
],
251+
});

0 commit comments

Comments
 (0)
Please sign in to comment.