Skip to content

Commit

Permalink
refactor: avoid using deprecation codes
Browse files Browse the repository at this point in the history
  • Loading branch information
@snitin315
snitin315 committed Jul 2, 2022
1 parent 6905616 commit c7a8100
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 27 deletions.
50 changes: 39 additions & 11 deletions lib/rule-tester/rule-tester.js
View file
Expand Up @@ -305,6 +305,36 @@ function getCommentsDeprecation() {
);
}

/**
* Emit a deprecation warning if function-style format is being used.
* @param {string} ruleName Name of the rule.
* @returns {void}
*/
function emitLegacyRuleAPIWarning(ruleName) {
if (!emitLegacyRuleAPIWarning[`warned-${ruleName}`]) {
emitLegacyRuleAPIWarning[`warned-${ruleName}`] = true;
util.deprecate(
() => {},
`"${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`
)();
}
}

/**
* Emit a deprecation warning if rule has options but is missing the "meta.schema" property
* @param {string} ruleName Name of the rule.
* @returns {void}
*/
function emitMissingSchemaWarning(ruleName) {
if (!emitMissingSchemaWarning[`warned-${ruleName}`]) {
emitMissingSchemaWarning[`warned-${ruleName}`] = true;
util.deprecate(
() => {},
`"${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`
)();
}
}

//------------------------------------------------------------------------------
// Public Interface
//------------------------------------------------------------------------------
Expand Down Expand Up @@ -522,11 +552,7 @@ class RuleTester {
}

if (typeof rule === "function") {
util.deprecate(
() => {},
`"${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`,
`DEP_ESLINT_LEGACY_RULE_API_${ruleName.replace(/-/giu, "_").toUpperCase()}`
)();
emitLegacyRuleAPIWarning(ruleName);
}

linter.defineRule(ruleName, Object.assign({}, rule, {
Expand Down Expand Up @@ -585,12 +611,14 @@ class RuleTester {

if (hasOwnProperty(item, "options")) {
assert(Array.isArray(item.options), "options must be an array");
if (item.options.length > 0 && typeof rule === "object" && rule.meta && typeof rule.meta.schema === "undefined") {
util.deprecate(
() => {},
`"${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`,
`DEP_ESLINT_MISSING_SCHEMA_${ruleName.replace(/-/giu, "_").toUpperCase()}`
)();
if (
item.options.length > 0 &&
typeof rule === "object" &&
(
!rule.meta || (rule.meta && typeof rule.meta.schema === "undefined")
)
) {
emitMissingSchemaWarning(ruleName);
}
config.rules[ruleName] = [1].concat(item.options);
} else {
Expand Down
53 changes: 37 additions & 16 deletions tests/lib/rule-tester/rule-tester.js
View file
Expand Up @@ -2297,6 +2297,16 @@ describe("RuleTester", () => {
});

describe("deprecations", () => {
let spy;

beforeEach(() => {
spy = sinon.spy(util, "deprecate");
});

afterEach(() => {
spy.restore();
});

it("should log a deprecation warning when using the legacy function-style API for rule", () => {

/**
Expand All @@ -2312,8 +2322,6 @@ describe("RuleTester", () => {
};
}

const spy = sinon.spy(util, "deprecate");

ruleTester.run("function-style-rule", functionStyleRule, {
valid: [],
invalid: [
Expand All @@ -2326,9 +2334,31 @@ describe("RuleTester", () => {
spy.getCall(0).args[1],
"\"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"
);
assert.strictEqual(spy.getCall(0).args[2], "DEP_ESLINT_LEGACY_RULE_API_FUNCTION_STYLE_RULE");
});

spy.restore();
it("should log a deprecation warning when meta is not defined for the rule", () => {
const ruleWithNoMeta = {
create(context) {
return {
Program(node) {
context.report({ node, message: "bad" });
}
};
}
};

ruleTester.run("rule-with-no-meta", ruleWithNoMeta, {
valid: [],
invalid: [
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
]
});

assert.strictEqual(spy.callCount, 1, "calls `util.deprecate` once");
assert.strictEqual(
spy.getCall(0).args[1],
"\"rule-with-no-meta\" 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"
);
});

it("should log a deprecation warning when schema is not defined for the rule", () => {
Expand All @@ -2345,23 +2375,18 @@ describe("RuleTester", () => {
}
};

const spy = sinon.spy(util, "deprecate");

ruleTester.run("rule-with-no-options", ruleWithNoSchema, {
ruleTester.run("rule-with-no-schema", ruleWithNoSchema, {
valid: [],
invalid: [
{ code: "var foo = bar;", options: [{ foo: true }], errors: 1 }
]
});

assert.strictEqual(spy.callCount, 1, "calls `console.warn` once");
assert.strictEqual(spy.callCount, 1, "calls `util.deprecate` once");
assert.strictEqual(
spy.getCall(0).args[1],
"\"rule-with-no-options\" 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"
"\"rule-with-no-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"
);
assert.strictEqual(spy.getCall(0).args[2], "DEP_ESLINT_MISSING_SCHEMA_RULE_WITH_NO_OPTIONS");

spy.restore();
});

it("should not log a deprecation warning when schema is an empty array", () => {
Expand All @@ -2379,16 +2404,12 @@ describe("RuleTester", () => {
}
};

const spy = sinon.spy(util, "deprecate");

ruleTester.run("rule-with-no-options", ruleWithEmptySchema, {
valid: [],
invalid: [{ code: "var foo = bar;", errors: 1 }]
});

assert.strictEqual(spy.callCount, 0, "never calls `util.deprecate`");

spy.restore();
});
});

Expand Down

0 comments on commit c7a8100

Please sign in to comment.