Skip to content

Commit 1cdcbca

Browse files
snitin315snitin315
authoredJul 28, 2022
feat: add deprecation warnings for legacy API in RuleTester (#16063)
* feat: add deprecation warnings for legacy API in `RuleTester` * fix: use unique deprecation code for rules * refactor: avoid using deprecation codes * refactor: use object-style syntax * refactor: use process.emitWarning() * test: add more cases * fix: improve check for missing schema * refactor: update fixtures * test: add test cases when schema is undefined or null * fix: lint
·
v9.24.0v8.21.0
1 parent 0396775 commit 1cdcbca

13 files changed

+498
-214
lines changed
 

‎lib/rule-tester/rule-tester.js

+42
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,36 @@ function getCommentsDeprecation() {
305305
);
306306
}
307307

308+
/**
309+
* Emit a deprecation warning if function-style format is being used.
310+
* @param {string} ruleName Name of the rule.
311+
* @returns {void}
312+
*/
313+
function emitLegacyRuleAPIWarning(ruleName) {
314+
if (!emitLegacyRuleAPIWarning[`warned-${ruleName}`]) {
315+
emitLegacyRuleAPIWarning[`warned-${ruleName}`] = true;
316+
process.emitWarning(
317+
`"${ruleName}" rule is using the deprecated function-style format and will stop working in ESLint v9. Please use object-style format: https://eslint.org/docs/developer-guide/working-with-rules`,
318+
"DeprecationWarning"
319+
);
320+
}
321+
}
322+
323+
/**
324+
* Emit a deprecation warning if rule has options but is missing the "meta.schema" property
325+
* @param {string} ruleName Name of the rule.
326+
* @returns {void}
327+
*/
328+
function emitMissingSchemaWarning(ruleName) {
329+
if (!emitMissingSchemaWarning[`warned-${ruleName}`]) {
330+
emitMissingSchemaWarning[`warned-${ruleName}`] = true;
331+
process.emitWarning(
332+
`"${ruleName}" rule has options but is missing the "meta.schema" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas`,
333+
"DeprecationWarning"
334+
);
335+
}
336+
}
337+
308338
//------------------------------------------------------------------------------
309339
// Public Interface
310340
//------------------------------------------------------------------------------
@@ -521,6 +551,9 @@ class RuleTester {
521551
].concat(scenarioErrors).join("\n"));
522552
}
523553

554+
if (typeof rule === "function") {
555+
emitLegacyRuleAPIWarning(ruleName);
556+
}
524557

525558
linter.defineRule(ruleName, Object.assign({}, rule, {
526559

@@ -578,6 +611,15 @@ class RuleTester {
578611

579612
if (hasOwnProperty(item, "options")) {
580613
assert(Array.isArray(item.options), "options must be an array");
614+
if (
615+
item.options.length > 0 &&
616+
typeof rule === "object" &&
617+
(
618+
!rule.meta || (rule.meta && (typeof rule.meta.schema === "undefined" || rule.meta.schema === null))
619+
)
620+
) {
621+
emitMissingSchemaWarning(ruleName);
622+
}
581623
config.rules[ruleName] = [1].concat(item.options);
582624
} else {
583625
config.rules[ruleName] = 1;

‎tests/fixtures/testers/rule-tester/modify-ast-at-first.js

+29-23
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,36 @@
99
// Rule Definition
1010
//------------------------------------------------------------------------------
1111

12-
module.exports = function(context) {
13-
return {
14-
"Program": function(node) {
15-
node.body.push({
16-
"type": "Identifier",
17-
"name": "modified",
18-
"range": [0, 8],
19-
"loc": {
20-
"start": {
21-
"line": 1,
22-
"column": 0
23-
},
24-
"end": {
25-
"line": 1,
26-
"column": 8
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: []
16+
},
17+
create(context) {
18+
return {
19+
"Program": function(node) {
20+
node.body.push({
21+
"type": "Identifier",
22+
"name": "modified",
23+
"range": [0, 8],
24+
"loc": {
25+
"start": {
26+
"line": 1,
27+
"column": 0
28+
},
29+
"end": {
30+
"line": 1,
31+
"column": 8
32+
}
2733
}
28-
}
29-
});
30-
},
34+
});
35+
},
3136

32-
"Identifier": function(node) {
33-
if (node.name === "bar") {
34-
context.report({message: "error", node: node});
37+
"Identifier": function(node) {
38+
if (node.name === "bar") {
39+
context.report({message: "error", node: node});
40+
}
3541
}
36-
}
37-
};
42+
};
43+
},
3844
};

‎tests/fixtures/testers/rule-tester/modify-ast-at-last.js

+29-23
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,36 @@
99
// Rule Definition
1010
//------------------------------------------------------------------------------
1111

12-
module.exports = function(context) {
13-
return {
14-
"Program:exit": function(node) {
15-
node.body.push({
16-
"type": "Identifier",
17-
"name": "modified",
18-
"range": [0, 8],
19-
"loc": {
20-
"start": {
21-
"line": 1,
22-
"column": 0
23-
},
24-
"end": {
25-
"line": 1,
26-
"column": 8
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: []
16+
},
17+
create(context) {
18+
return {
19+
"Program:exit": function(node) {
20+
node.body.push({
21+
"type": "Identifier",
22+
"name": "modified",
23+
"range": [0, 8],
24+
"loc": {
25+
"start": {
26+
"line": 1,
27+
"column": 0
28+
},
29+
"end": {
30+
"line": 1,
31+
"column": 8
32+
}
2733
}
28-
}
29-
});
30-
},
34+
});
35+
},
3136

32-
"Identifier": function(node) {
33-
if (node.name === "bar") {
34-
context.report({message: "error", node: node});
37+
"Identifier": function(node) {
38+
if (node.name === "bar") {
39+
context.report({message: "error", node: node});
40+
}
3541
}
36-
}
37-
};
42+
};
43+
},
3844
};

‎tests/fixtures/testers/rule-tester/modify-ast.js

+14-8
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@
99
// Rule Definition
1010
//------------------------------------------------------------------------------
1111

12-
module.exports = function(context) {
13-
return {
14-
"Identifier": function(node) {
15-
node.name += "!";
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: []
16+
},
17+
create(context) {
18+
return {
19+
"Identifier": function(node) {
20+
node.name += "!";
1621

17-
if (node.name === "bar!") {
18-
context.report({message: "error", node: node});
22+
if (node.name === "bar!") {
23+
context.report({message: "error", node: node});
24+
}
1925
}
20-
}
21-
};
26+
};
27+
},
2228
};

‎tests/fixtures/testers/rule-tester/no-eval.js

+16-12
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,24 @@
33
* @author Nicholas C. Zakas
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
12-
"use strict";
13-
14-
return {
15-
"CallExpression": function(node) {
16-
if (node.callee.name === "eval") {
17-
context.report(node, "eval sucks.");
18-
}
19-
}
20-
};
21-
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [],
16+
},
17+
create(context) {
18+
return {
19+
CallExpression: function (node) {
20+
if (node.callee.name === "eval") {
21+
context.report(node, "eval sucks.");
22+
}
23+
},
24+
};
25+
},
2226
};

‎tests/fixtures/testers/rule-tester/no-invalid-args.js

+18-10
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,28 @@
33
* @author Mathias Schreck
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
"use strict";
12-
13-
var config = context.options[0];
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [{
16+
type: "boolean"
17+
}]
18+
},
19+
create(context) {
20+
var config = context.options[0];
1421

15-
return {
16-
"Program": function(node) {
17-
if (config === true) {
18-
context.report(node, "Invalid args");
22+
return {
23+
"Program": function(node) {
24+
if (config === true) {
25+
context.report(node, "Invalid args");
26+
}
1927
}
20-
}
21-
};
28+
};
29+
}
2230
};

‎tests/fixtures/testers/rule-tester/no-invalid-schema.js

+17-17
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
* @author Brandon Mills
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
"use strict";
12-
13-
var config = context.options[0];
14-
15-
return {
16-
"Program": function(node) {
17-
if (config) {
18-
context.report(node, "Expected nothing.");
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [{
16+
"enum": []
17+
}]
18+
},
19+
create(context) {
20+
return {
21+
"Program": function(node) {
22+
if (config) {
23+
context.report(node, "Expected nothing.");
24+
}
1925
}
20-
}
21-
};
26+
};
27+
},
2228
};
23-
24-
module.exports.schema = [
25-
{
26-
"enum": []
27-
}
28-
];

‎tests/fixtures/testers/rule-tester/no-schema-violation.js

+18-17
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,27 @@
33
* @author Brandon Mills
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
"use strict";
12-
13-
var config = context.options[0];
14-
15-
return {
16-
"Program": function(node) {
17-
if (config && config !== "foo") {
18-
context.report(node, "Expected foo.");
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [{
16+
"enum": ["foo"]
17+
}]
18+
},
19+
create(context) {
20+
const config = context.options[0];
21+
return {
22+
"Program": function(node) {
23+
if (config && config !== "foo") {
24+
context.report(node, "Expected foo.");
25+
}
1926
}
20-
}
21-
};
27+
};
28+
},
2229
};
23-
24-
module.exports.schema = [
25-
{
26-
"enum": ["foo"]
27-
}
28-
];

‎tests/fixtures/testers/rule-tester/no-test-filename

+15-9
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,24 @@
33
* @author Stefan Lau
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
"use strict";
12-
13-
return {
14-
"Program": function(node) {
15-
if (context.getFilename() === '<input>') {
16-
context.report(node, "Filename test was not defined.");
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: []
16+
},
17+
create(context) {
18+
return {
19+
"Program": function(node) {
20+
if (context.getFilename() === '<input>') {
21+
context.report(node, "Filename test was not defined.");
22+
}
1723
}
18-
}
19-
};
24+
};
25+
}
2026
};

‎tests/fixtures/testers/rule-tester/no-test-global.js

+20-14
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,27 @@
77
// Rule Definition
88
//------------------------------------------------------------------------------
99

10-
module.exports = function(context) {
11-
"use strict";
10+
"use strict";
1211

13-
return {
14-
"Program": function(node) {
15-
var globals = context.getScope().variables.map(function (variable) {
16-
return variable.name;
17-
});
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [],
16+
},
17+
create(context) {
18+
return {
19+
"Program": function(node) {
20+
var globals = context.getScope().variables.map(function (variable) {
21+
return variable.name;
22+
});
1823

19-
if (globals.indexOf("test") === -1) {
20-
context.report(node, "Global variable test was not defined.");
24+
if (globals.indexOf("test") === -1) {
25+
context.report(node, "Global variable test was not defined.");
26+
}
27+
if (globals.indexOf("foo") !== -1) {
28+
context.report(node, "Global variable foo should not be used.");
29+
}
2130
}
22-
if (globals.indexOf("foo") !== -1) {
23-
context.report(node, "Global variable foo should not be used.");
24-
}
25-
}
26-
};
31+
};
32+
},
2733
};

‎tests/fixtures/testers/rule-tester/no-test-settings.js

+19-10
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,27 @@
33
* @author Ilya Volodin
44
*/
55

6+
"use strict";
7+
68
//------------------------------------------------------------------------------
79
// Rule Definition
810
//------------------------------------------------------------------------------
911

10-
module.exports = function(context) {
11-
"use strict";
12-
13-
return {
14-
"Program": function(node) {
15-
if (!context.settings || !context.settings.test) {
16-
context.report(node, "Global settings test was not defined.");
17-
}
18-
}
19-
};
12+
module.exports = {
13+
meta: {
14+
type: "problem",
15+
schema: [],
16+
},
17+
create(context) {
18+
return {
19+
Program: function (node) {
20+
if (!context.settings || !context.settings.test) {
21+
context.report(
22+
node,
23+
"Global settings test was not defined."
24+
);
25+
}
26+
},
27+
};
28+
},
2029
};

‎tests/fixtures/testers/rule-tester/no-var.js

+2-4
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,11 @@
1010
"use strict";
1111

1212
module.exports = {
13-
1413
meta: {
15-
fixable: "code"
14+
fixable: "code",
15+
schema: []
1616
},
17-
1817
create(context) {
19-
2018
var sourceCode = context.getSourceCode();
2119

2220
return {

‎tests/lib/rule-tester/rule-tester.js

+259-67
Original file line numberDiff line numberDiff line change
@@ -1710,73 +1710,6 @@ describe("RuleTester", () => {
17101710
}, "Error must specify 'messageId' if 'data' is used.");
17111711
});
17121712

1713-
// fixable rules with or without `meta` property
1714-
it("should not throw an error if a rule that has `meta.fixable` produces fixes", () => {
1715-
const replaceProgramWith5Rule = {
1716-
meta: {
1717-
fixable: "code"
1718-
},
1719-
create(context) {
1720-
return {
1721-
Program(node) {
1722-
context.report({ node, message: "bad", fix: fixer => fixer.replaceText(node, "5") });
1723-
}
1724-
};
1725-
}
1726-
};
1727-
1728-
ruleTester.run("replaceProgramWith5", replaceProgramWith5Rule, {
1729-
valid: [],
1730-
invalid: [
1731-
{ code: "var foo = bar;", output: "5", errors: 1 }
1732-
]
1733-
});
1734-
});
1735-
it("should throw an error if a new-format rule that doesn't have `meta` produces fixes", () => {
1736-
const replaceProgramWith5Rule = {
1737-
create(context) {
1738-
return {
1739-
Program(node) {
1740-
context.report({ node, message: "bad", fix: fixer => fixer.replaceText(node, "5") });
1741-
}
1742-
};
1743-
}
1744-
};
1745-
1746-
assert.throws(() => {
1747-
ruleTester.run("replaceProgramWith5", replaceProgramWith5Rule, {
1748-
valid: [],
1749-
invalid: [
1750-
{ code: "var foo = bar;", output: "5", errors: 1 }
1751-
]
1752-
});
1753-
}, /Fixable rules must set the `meta\.fixable` property/u);
1754-
});
1755-
it("should throw an error if a legacy-format rule produces fixes", () => {
1756-
1757-
/**
1758-
* Legacy-format rule (a function instead of an object with `create` method).
1759-
* @param {RuleContext} context The ESLint rule context object.
1760-
* @returns {Object} Listeners.
1761-
*/
1762-
function replaceProgramWith5Rule(context) {
1763-
return {
1764-
Program(node) {
1765-
context.report({ node, message: "bad", fix: fixer => fixer.replaceText(node, "5") });
1766-
}
1767-
};
1768-
}
1769-
1770-
assert.throws(() => {
1771-
ruleTester.run("replaceProgramWith5", replaceProgramWith5Rule, {
1772-
valid: [],
1773-
invalid: [
1774-
{ code: "var foo = bar;", output: "5", errors: 1 }
1775-
]
1776-
});
1777-
}, /Fixable rules must set the `meta\.fixable` property/u);
1778-
});
1779-
17801713
describe("suggestions", () => {
17811714
it("should pass with valid suggestions (tested using desc)", () => {
17821715
ruleTester.run("suggestions-basic", require("../../fixtures/testers/rule-tester/suggestions").basic, {
@@ -2295,6 +2228,265 @@ describe("RuleTester", () => {
22952228
});
22962229
});
22972230

2231+
describe("deprecations", () => {
2232+
let processStub;
2233+
const ruleWithNoSchema = {
2234+
meta: {
2235+
type: "suggestion"
2236+
},
2237+
create(context) {
2238+
return {
2239+
Program(node) {
2240+
context.report({ node, message: "bad" });
2241+
}
2242+
};
2243+
}
2244+
};
2245+
const ruleWithNoMeta = {
2246+
create(context) {
2247+
return {
2248+
Program(node) {
2249+
context.report({ node, message: "bad" });
2250+
}
2251+
};
2252+
}
2253+
};
2254+
2255+
beforeEach(() => {
2256+
processStub = sinon.stub(process, "emitWarning");
2257+
});
2258+
2259+
afterEach(() => {
2260+
processStub.restore();
2261+
});
2262+
2263+
it("should log a deprecation warning when using the legacy function-style API for rule", () => {
2264+
2265+
/**
2266+
* Legacy-format rule (a function instead of an object with `create` method).
2267+
* @param {RuleContext} context The ESLint rule context object.
2268+
* @returns {Object} Listeners.
2269+
*/
2270+
function functionStyleRule(context) {
2271+
return {
2272+
Program(node) {
2273+
context.report({ node, message: "bad" });
2274+
}
2275+
};
2276+
}
2277+
2278+
ruleTester.run("function-style-rule", functionStyleRule, {
2279+
valid: [],
2280+
invalid: [
2281+
{ code: "var foo = bar;", errors: 1 }
2282+
]
2283+
});
2284+
2285+
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
2286+
assert.deepStrictEqual(
2287+
processStub.getCall(0).args,
2288+
[
2289+
"\"function-style-rule\" rule is using the deprecated function-style format and will stop working in ESLint v9. Please use object-style format: https://eslint.org/docs/developer-guide/working-with-rules",
2290+
"DeprecationWarning"
2291+
]
2292+
);
2293+
});
2294+
2295+
it("should log a deprecation warning when meta is not defined for the rule", () => {
2296+
ruleTester.run("rule-with-no-meta-1", ruleWithNoMeta, {
2297+
valid: [],
2298+
invalid: [
2299+
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
2300+
]
2301+
});
2302+
2303+
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
2304+
assert.deepStrictEqual(
2305+
processStub.getCall(0).args,
2306+
[
2307+
"\"rule-with-no-meta-1\" rule has options but is missing the \"meta.schema\" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas",
2308+
"DeprecationWarning"
2309+
]
2310+
);
2311+
});
2312+
2313+
it("should log a deprecation warning when schema is not defined for the rule", () => {
2314+
ruleTester.run("rule-with-no-schema-1", ruleWithNoSchema, {
2315+
valid: [],
2316+
invalid: [
2317+
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
2318+
]
2319+
});
2320+
2321+
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
2322+
assert.deepStrictEqual(
2323+
processStub.getCall(0).args,
2324+
[
2325+
"\"rule-with-no-schema-1\" rule has options but is missing the \"meta.schema\" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas",
2326+
"DeprecationWarning"
2327+
]
2328+
);
2329+
});
2330+
2331+
it("should log a deprecation warning when schema is `undefined`", () => {
2332+
const ruleWithUndefinedSchema = {
2333+
meta: {
2334+
type: "problem",
2335+
// eslint-disable-next-line no-undefined -- intentioally added for test case
2336+
schema: undefined
2337+
},
2338+
create(context) {
2339+
return {
2340+
Program(node) {
2341+
context.report({ node, message: "bad" });
2342+
}
2343+
};
2344+
}
2345+
};
2346+
2347+
ruleTester.run("rule-with-undefined-schema", ruleWithUndefinedSchema, {
2348+
valid: [],
2349+
invalid: [
2350+
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
2351+
]
2352+
});
2353+
2354+
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
2355+
assert.deepStrictEqual(
2356+
processStub.getCall(0).args,
2357+
[
2358+
"\"rule-with-undefined-schema\" rule has options but is missing the \"meta.schema\" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas",
2359+
"DeprecationWarning"
2360+
]
2361+
);
2362+
});
2363+
2364+
it("should log a deprecation warning when schema is `null`", () => {
2365+
const ruleWithNullSchema = {
2366+
meta: {
2367+
type: "problem",
2368+
schema: null
2369+
},
2370+
create(context) {
2371+
return {
2372+
Program(node) {
2373+
context.report({ node, message: "bad" });
2374+
}
2375+
};
2376+
}
2377+
};
2378+
2379+
ruleTester.run("rule-with-null-schema", ruleWithNullSchema, {
2380+
valid: [],
2381+
invalid: [
2382+
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
2383+
]
2384+
});
2385+
2386+
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
2387+
assert.deepStrictEqual(
2388+
processStub.getCall(0).args,
2389+
[
2390+
"\"rule-with-null-schema\" rule has options but is missing the \"meta.schema\" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas",
2391+
"DeprecationWarning"
2392+
]
2393+
);
2394+
});
2395+
2396+
it("should not log a deprecation warning when schema is an empty array", () => {
2397+
const ruleWithEmptySchema = {
2398+
meta: {
2399+
type: "suggestion",
2400+
schema: []
2401+
},
2402+
create(context) {
2403+
return {
2404+
Program(node) {
2405+
context.report({ node, message: "bad" });
2406+
}
2407+
};
2408+
}
2409+
};
2410+
2411+
ruleTester.run("rule-with-no-options", ruleWithEmptySchema, {
2412+
valid: [],
2413+
invalid: [{ code: "var foo = bar;", errors: 1 }]
2414+
});
2415+
2416+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2417+
});
2418+
2419+
it("When the rule is an object-style rule, the legacy rule API warning is not emitted", () => {
2420+
ruleTester.run("rule-with-no-schema-2", ruleWithNoSchema, {
2421+
valid: [],
2422+
invalid: [
2423+
{ code: "var foo = bar;", errors: 1 }
2424+
]
2425+
});
2426+
2427+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2428+
});
2429+
2430+
it("When the rule has meta.schema and there are test cases with options, the missing schema warning is not emitted", () => {
2431+
const ruleWithSchema = {
2432+
meta: {
2433+
type: "suggestion",
2434+
schema: [{
2435+
type: "boolean"
2436+
}]
2437+
},
2438+
create(context) {
2439+
return {
2440+
Program(node) {
2441+
context.report({ node, message: "bad" });
2442+
}
2443+
};
2444+
}
2445+
};
2446+
2447+
ruleTester.run("rule-with-schema", ruleWithSchema, {
2448+
valid: [],
2449+
invalid: [
2450+
{ code: "var foo = bar;", options: [true], errors: 1 }
2451+
]
2452+
});
2453+
2454+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2455+
});
2456+
2457+
it("When the rule does not have meta, but there are no test cases with options, the missing schema warning is not emitted", () => {
2458+
ruleTester.run("rule-with-no-meta-2", ruleWithNoMeta, {
2459+
valid: [],
2460+
invalid: [
2461+
{ code: "var foo = bar;", errors: 1 }
2462+
]
2463+
});
2464+
2465+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2466+
});
2467+
2468+
it("When the rule has meta without meta.schema, but there are no test cases with options, the missing schema warning is not emitted", () => {
2469+
ruleTester.run("rule-with-no-schema-3", ruleWithNoSchema, {
2470+
valid: [],
2471+
invalid: [
2472+
{ code: "var foo = bar;", errors: 1 }
2473+
]
2474+
});
2475+
2476+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2477+
});
2478+
it("When the rule has meta without meta.schema, and some test cases have options property but it's an empty array, the missing schema warning is not emitted", () => {
2479+
ruleTester.run("rule-with-no-schema-4", ruleWithNoSchema, {
2480+
valid: [],
2481+
invalid: [
2482+
{ code: "var foo = bar;", options: [], errors: 1 }
2483+
]
2484+
});
2485+
2486+
assert.strictEqual(processStub.callCount, 0, "never calls `process.emitWarning()`");
2487+
});
2488+
});
2489+
22982490
/**
22992491
* Asserts that a particular value will be emitted from an EventEmitter.
23002492
* @param {EventEmitter} emitter The emitter that should emit a value

0 commit comments

Comments
 (0)
Please sign in to comment.