Import rules from monorepo (#326)

Author: fregante

no-restricted-syntax.js

@@ -47,6 +47,23 @@ module.exports = [
 		selector:
 			"JSXOpeningElement[name.name='div'][attributes.0.name.name='onClick']",
 	},
+	{
+		message:
+		  "Prefer importing `getSelectionRange()` helper or check `selection.rangeCount` first: https://github.com/pixiebrix/pixiebrix-extension/pull/7989",
+		selector: "CallExpression[callee.property.name='getRangeAt']",
+	},
+	{
+	  message:
+		"Use the chrome.* APIs (browser.* is now only used for for messaging)",
+	  selector:
+		"MemberExpression[object.object.name='browser']:not(:has(Identifier[name=/runtime|tabs/]):has(Identifier[name=/Message/]))",
+	},
+	{
+	  message:
+		"Use the browser.* APIs for messaging (chrome.* for everything else)",
+	  selector:
+		"MemberExpression[object.object.name='chrome']:has(Identifier[name=/runtime|tabs/]):has(Identifier[name=/Message/])",
+	},
 
 	// NOTE: If you add more rules, add the tests to no-restricted-syntax.test.ts
 ];

no-restricted-syntax.test.ts

@@ -5,10 +5,11 @@
 /* eslint-disable unicorn/no-useless-undefined */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 
 // eslint-disable-next-line no-restricted-syntax
 import classnames from "classnames";
-import cx from "classnames";
+import cx from "classnames"; // Ok
 
 // eslint-disable-next-line no-restricted-syntax
 export const id = crypto.randomUUID();
@@ -24,3 +25,32 @@ export const mockPromise = jest.fn().mockResolvedValue(undefined);
 
 // eslint-disable-next-line no-restricted-syntax
 export type MyObject = Record<string, unknown>;
+
+const selection = getSelection(); // Ok
+// eslint-disable-next-line no-restricted-syntax
+export const range = selection?.getRangeAt(0).startContainer;
+export const string = selection?.toString(); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+browser.runtime.getURL("options.html");
+chrome.runtime.getURL("options.html"); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+browser.tabs.query({ active: true });
+chrome.tabs.query({ active: true }); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+browser.scripting.getRegisteredContentScripts();
+chrome.scripting.getRegisteredContentScripts(); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+chrome.runtime.sendMessage("good soup");
+browser.runtime.sendMessage("good soup"); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+chrome.tabs.sendMessage(1, "u e e a i");
+browser.tabs.sendMessage(1, "u e e a i"); // Ok
+
+// eslint-disable-next-line no-restricted-syntax -- necessary to define rule
+chrome.runtime.onMessage.addListener(() => undefined);
+browser.runtime.onMessage.addListener(() => undefined); // Ok

plugins/import.js

@@ -48,3 +48,12 @@ module.exports = {
 		},
 	],
 };
+
+// `npm run lint:fast` will skip the (slow) import/* rules
+// Useful if you're trying to iterate fixes over other rules
+if (process.env.ESLINT_NO_IMPORTS) {
+	const importRules = Object.keys(require("eslint-plugin-import").rules);
+	for (const ruleName of importRules) {
+		module.exports.rules[`import/${ruleName}`] = "off";
+	}
+}

plugins/typescript.js

@@ -31,6 +31,9 @@ module.exports = {
 					}
 				),
 
+				// TODO: Remove after https://github.com/xojs/eslint-config-xo-typescript/pull/92
+				"@typescript-eslint/no-unsafe-member-access": "error",
+
 				// Reason: https://github.com/pixiebrix/pixiebrix-extension/pull/7703
 				"@typescript-eslint/restrict-template-expressions": [
 					"error",

tests.js

@@ -32,6 +32,9 @@ module.exports = {
 		"@typescript-eslint/no-non-null-assertion": "off",
 		"react/jsx-key": "off",
 
+		// Conflicts with Redux' .concat()
+		"unicorn/prefer-spread": "off",
+
 		// Common and required usage in tests
 		"unicorn/no-useless-undefined": "off",