Bug 1875216 - part 2: Remove linting for XPCOMUtils.defineLazyGetter r=arai,Standard8,frontend-codestyle-reviewers,mossop

Differential Revision: https://phabricator.services.mozilla.com/D202127
This commit is contained in:
Gregory Pappas
2025-02-03 14:49:37 +00:00
parent adf404cba5
commit cbb36dfedd
9 changed files with 2 additions and 120 deletions

View File

@@ -1,22 +0,0 @@
use-chromeutils-definelazygetter
================================
Require use of ``ChromeUtils.defineLazyGetter`` rather than ``XPCOMUtils.defineLazyGetter``.
Examples of incorrect code for this rule:
-----------------------------------------
.. code-block:: js
XPCOMUtils.defineLazyGetter(lazy, "textEncoder", function () {
return new TextEncoder();
});
Examples of correct code for this rule:
---------------------------------------
.. code-block:: js
ChromeUtils.defineLazyGetter(lazy, "textEncoder", function () {
return new TextEncoder();
});

View File

@@ -76,7 +76,6 @@ const coreRules = {
"mozilla/reject-scriptableunicodeconverter": "warn", "mozilla/reject-scriptableunicodeconverter": "warn",
"mozilla/rejects-requires-await": "error", "mozilla/rejects-requires-await": "error",
"mozilla/use-cc-etc": "error", "mozilla/use-cc-etc": "error",
"mozilla/use-chromeutils-definelazygetter": "error",
"mozilla/use-chromeutils-generateqi": "error", "mozilla/use-chromeutils-generateqi": "error",
"mozilla/use-console-createInstance": "error", "mozilla/use-console-createInstance": "error",
"mozilla/use-default-preference-values": "error", "mozilla/use-default-preference-values": "error",

View File

@@ -18,7 +18,6 @@ const callExpressionDefinitions = [
/^loader\.lazyGetter\((?:globalThis|this), "(\w+)"/, /^loader\.lazyGetter\((?:globalThis|this), "(\w+)"/,
/^loader\.lazyServiceGetter\((?:globalThis|this), "(\w+)"/, /^loader\.lazyServiceGetter\((?:globalThis|this), "(\w+)"/,
/^loader\.lazyRequireGetter\((?:globalThis|this), "(\w+)"/, /^loader\.lazyRequireGetter\((?:globalThis|this), "(\w+)"/,
/^XPCOMUtils\.defineLazyGetter\((?:globalThis|this), "(\w+)"/,
/^ChromeUtils\.defineLazyGetter\((?:globalThis|this), "(\w+)"/, /^ChromeUtils\.defineLazyGetter\((?:globalThis|this), "(\w+)"/,
/^XPCOMUtils\.defineLazyPreferenceGetter\((?:globalThis|this), "(\w+)"/, /^XPCOMUtils\.defineLazyPreferenceGetter\((?:globalThis|this), "(\w+)"/,
/^XPCOMUtils\.defineLazyScriptGetter\((?:globalThis|this), "(\w+)"/, /^XPCOMUtils\.defineLazyScriptGetter\((?:globalThis|this), "(\w+)"/,

View File

@@ -75,7 +75,6 @@ const plugin = {
"reject-top-level-await": require("./rules/reject-top-level-await"), "reject-top-level-await": require("./rules/reject-top-level-await"),
"rejects-requires-await": require("./rules/rejects-requires-await"), "rejects-requires-await": require("./rules/rejects-requires-await"),
"use-cc-etc": require("./rules/use-cc-etc"), "use-cc-etc": require("./rules/use-cc-etc"),
"use-chromeutils-definelazygetter": require("./rules/use-chromeutils-definelazygetter"),
"use-chromeutils-generateqi": require("./rules/use-chromeutils-generateqi"), "use-chromeutils-generateqi": require("./rules/use-chromeutils-generateqi"),
"use-console-createInstance": require("./rules/use-console-createInstance"), "use-console-createInstance": require("./rules/use-console-createInstance"),
"use-default-preference-values": require("./rules/use-default-preference-values"), "use-default-preference-values": require("./rules/use-default-preference-values"),

View File

@@ -1,58 +0,0 @@
/**
* @fileoverview Reject use of XPCOMUtils.defineLazyGetter in favor of ChromeUtils.defineLazyGetter.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
function isIdentifier(node, id) {
return node && node.type === "Identifier" && node.name === id;
}
function isMemberExpression(node, object, member) {
return (
node.type === "MemberExpression" &&
isIdentifier(node.object, object) &&
isIdentifier(node.property, member)
);
}
module.exports = {
meta: {
docs: {
url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/rules/use-chromeutils-definelazygetter.html",
},
fixable: "code",
messages: {
useChromeUtilsDefineLazyGetter:
"Please use ChromeUtils.defineLazyGetter instead of XPCOMUtils.defineLazyGetter",
},
schema: [],
type: "problem",
},
create(context) {
return {
CallExpression(node) {
if (node.callee.type !== "MemberExpression") {
return;
}
let { callee } = node;
if (isMemberExpression(callee, "XPCOMUtils", "defineLazyGetter")) {
context.report({
node,
messageId: "useChromeUtilsDefineLazyGetter",
fix(fixer) {
return fixer.replaceText(callee, "ChromeUtils.defineLazyGetter");
},
});
}
},
};
},
};

View File

@@ -24,7 +24,6 @@ const callExpressionDefinitions = [
/^loader\.lazyGetter\(lazy, "(\w+)"/, /^loader\.lazyGetter\(lazy, "(\w+)"/,
/^loader\.lazyServiceGetter\(lazy, "(\w+)"/, /^loader\.lazyServiceGetter\(lazy, "(\w+)"/,
/^loader\.lazyRequireGetter\(lazy, "(\w+)"/, /^loader\.lazyRequireGetter\(lazy, "(\w+)"/,
/^XPCOMUtils\.defineLazyGetter\(lazy, "(\w+)"/,
/^Integration\.downloads\.defineESModuleGetter\(lazy, "(\w+)"/, /^Integration\.downloads\.defineESModuleGetter\(lazy, "(\w+)"/,
/^ChromeUtils\.defineLazyGetter\(lazy, "(\w+)"/, /^ChromeUtils\.defineLazyGetter\(lazy, "(\w+)"/,
/^XPCOMUtils\.defineLazyPreferenceGetter\(lazy, "(\w+)"/, /^XPCOMUtils\.defineLazyPreferenceGetter\(lazy, "(\w+)"/,

View File

@@ -1,6 +1,6 @@
{ {
"name": "eslint-plugin-mozilla", "name": "eslint-plugin-mozilla",
"version": "4.1.0", "version": "4.2.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {

View File

@@ -1,6 +1,6 @@
{ {
"name": "eslint-plugin-mozilla", "name": "eslint-plugin-mozilla",
"version": "4.1.0", "version": "4.2.0",
"description": "A collection of rules that help enforce JavaScript coding standard in the Mozilla project.", "description": "A collection of rules that help enforce JavaScript coding standard in the Mozilla project.",
"keywords": [ "keywords": [
"eslint", "eslint",

View File

@@ -1,34 +0,0 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
var rule = require("../lib/rules/use-chromeutils-definelazygetter");
var RuleTester = require("eslint").RuleTester;
const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: "latest" } });
// ------------------------------------------------------------------------------
// Tests
// ------------------------------------------------------------------------------
function callError(messageId) {
return [{ messageId, type: "CallExpression" }];
}
ruleTester.run("use-chromeutils-definelazygetter", rule, {
valid: [
`ChromeUtils.defineLazyGetter(lazy, "textEncoder", function () { return new TextEncoder(); });`,
],
invalid: [
{
code: `XPCOMUtils.defineLazyGetter(lazy, "textEncoder", function () { return new TextEncoder(); });`,
output: `ChromeUtils.defineLazyGetter(lazy, "textEncoder", function () { return new TextEncoder(); });`,
errors: callError("useChromeUtilsDefineLazyGetter"),
},
],
});