@open-xchange/linter-presets 0.7.1 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## `0.8.1` – 2024-Sep-04
+
+- change: (ESLint) relax a few strict rules of `@typescript-eslint`
+
+## `0.8.0` – 2024-Sep-04
+
+- change: (ESLint) raise `@typescript-eslint` rules to "strict" preset
+
 ## `0.7.1` – 2024-Aug-30
 
 - chore: bump dependencies

package/dist/eslint/config/base.js

@@ -1,6 +1,7 @@
 import eslintJs from "@eslint/js";
 import babelParser from "@babel/eslint-parser";
 import { JS_GLOB, SRC_GLOB, extGlob } from "../shared/env-utils.js";
+import { builtinRestrictedRules } from "../shared/restricted.js";
 // functions ==================================================================
 /**
  * Defines standard module settings and additional rules targeting JavaScript
@@ -127,6 +128,8 @@ export default function base(options) {
                 "prefer-spread": "error",
                 radix: "error",
                 "symbol-description": "error",
+                // built-in restricted items
+                ...builtinRestrictedRules(options),
             },
         },
     ];

package/dist/eslint/config/ts.js

@@ -23,7 +23,7 @@ export default function ts() {
         },
         // recommended rules
         extends: [
-            ...typescriptEslint.configs.recommendedTypeChecked,
+            ...typescriptEslint.configs.strictTypeChecked,
             ...typescriptEslint.configs.stylisticTypeChecked,
         ],
         // reconfigure plugin rules
@@ -39,9 +39,9 @@ export default function ts() {
                     allowHigherOrderFunctions: true,
                     allowConciseArrowFunctionExpressionsStartingWithVoid: true,
                 }],
-            "@typescript-eslint/no-array-constructor": "error",
-            "@typescript-eslint/no-deprecated": "error",
-            "@typescript-eslint/no-duplicate-type-constituents": "error",
+            "@typescript-eslint/explicit-member-accessibility": ["error", { accessibility: "no-public", overrides: { constructors: "off" } }],
+            "@typescript-eslint/no-confusing-void-expression": "off",
+            "@typescript-eslint/no-dynamic-delete": "off",
             "@typescript-eslint/no-empty-function": ["error", {
                     allow: ["private-constructors", "protected-constructors", "decoratedFunctions", "overrideMethods"],
                 }],
@@ -49,22 +49,23 @@ export default function ts() {
             "@typescript-eslint/no-explicit-any": "off",
             "@typescript-eslint/no-import-type-side-effects": "error",
             "@typescript-eslint/no-invalid-this": "error",
+            "@typescript-eslint/no-invalid-void-type": "off",
             "@typescript-eslint/no-loop-func": "error",
-            "@typescript-eslint/no-mixed-enums": "error",
             "@typescript-eslint/no-namespace": ["error", { allowDeclarations: true }],
             "@typescript-eslint/no-non-null-assertion": "off",
             "@typescript-eslint/no-redeclare": "error",
             "@typescript-eslint/no-shadow": ["error", { ignoreOnInitialization: true }],
-            "@typescript-eslint/no-unnecessary-template-expression": "error",
+            "@typescript-eslint/no-unnecessary-qualifier": "error",
+            "@typescript-eslint/no-unnecessary-type-parameters": "off",
             "@typescript-eslint/no-unused-vars": ["error", NO_UNUSED_VARS_OPTIONS],
-            "@typescript-eslint/no-useless-constructor": "error",
-            "@typescript-eslint/prefer-literal-enum-member": "error",
+            "@typescript-eslint/parameter-properties": "error",
             "@typescript-eslint/prefer-nullish-coalescing": ["error", { ignorePrimitives: true }],
             "@typescript-eslint/prefer-readonly": "error",
+            "@typescript-eslint/prefer-reduce-type-parameter": "off",
             "@typescript-eslint/restrict-template-expressions": "off",
             "@typescript-eslint/return-await": ["error", "always"],
             "@typescript-eslint/switch-exhaustiveness-check": "error",
-            "@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
+            "@typescript-eslint/unified-signatures": ["error", { ignoreDifferentlyNamedParameters: true }],
         },
     }, 
     // fixes for module definition files

package/dist/eslint/env/browser.js

@@ -1,7 +1,7 @@
 import JAVASCRIPT_GLOBALS from "globals";
 import CONFUSING_BROWSER_GLOBALS from "confusing-browser-globals";
 import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
-import { restrictedRules } from "../shared/restricted.js";
+import { restrictedRulesConfig } from "../shared/restricted.js";
 // constants ==================================================================
 /**
  * Global builtin symbols that are confusing or deprecated.
@@ -100,7 +100,7 @@ export default function browser(envOptions) {
         },
     }), 
     // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRules(envOptions, {
+    restrictedRulesConfig(envOptions, {
         globals: RESTRICTED_GLOBALS,
         properties: RESTRICTED_PROPERTIES,
         syntax: RESTRICTED_SYNTAX,

package/dist/eslint/env/node.js

@@ -1,6 +1,6 @@
 import nodePlugin from "eslint-plugin-n";
 import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
-import { restrictedRules } from "../shared/restricted.js";
+import { restrictedRulesConfig } from "../shared/restricted.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with global symbols and linter rules for
@@ -30,7 +30,7 @@ export default function node(envOptions) {
         },
     }), 
     // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRules(envOptions), 
+    restrictedRulesConfig(envOptions), 
     // custom rules
     customRules(envOptions, {
         "no-console": "off",

package/dist/eslint/rules/no-invalid-hierarchy.js

@@ -73,6 +73,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
                     }
                 }
                 // report package hierarchy errors
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- rule does not see assignment in callback function
                 if (invalidStatic) {
                     context.report({ messageId: "UNEXPECTED_OPTIONAL_STATIC", node: importWrapper.sourceNode });
                 }

package/dist/eslint/shared/restricted.d.ts

@@ -1,5 +1,5 @@
 import type { TSESLint } from "@typescript-eslint/utils";
-import type { EnvFilesOptions, EnvBaseOptions } from "../shared/env-utils.js";
+import type { LanguageOptions, EnvFilesOptions, EnvBaseOptions } from "../shared/env-utils.js";
 /**
  * Configuration for a single banned global or import.
  */
@@ -73,6 +73,16 @@ export interface EnvRestrictedOptions extends EnvBaseOptions {
      */
     restricted?: EnvRestrictedOption;
 }
+/**
+ * Creates restricted rules with built-in restricted items only.
+ *
+ * @param languageOptions
+ *  The language options passed with the Linter configuration.
+ *
+ * @returns
+ *  The rules dictionary with all needed restricted rules.
+ */
+export declare function builtinRestrictedRules(languageOptions: LanguageOptions): TSESLint.FlatConfig.Rules;
 /**
  * Generates various "no-restricted-?" rules from the passed configuration.
  *
@@ -86,4 +96,4 @@ export interface EnvRestrictedOptions extends EnvBaseOptions {
  * @returns
  *  The flat configuration objects needed to forbid the restricted items.
  */
-export declare function restrictedRules(envOptions: EnvRestrictedOptions, fixed?: EnvRestrictedItems): TSESLint.FlatConfig.ConfigArray;
+export declare function restrictedRulesConfig(envOptions: EnvRestrictedOptions, fixed?: EnvRestrictedItems): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/shared/restricted.js

@@ -14,7 +14,7 @@ function createRulesRecord(generator) {
     const rules = {};
     for (const key of ["globals", "imports", "properties", "syntax"]) {
         const items = generator(key);
-        if (items?.length) {
+        if (items.length) {
             rules[`no-restricted-${key}`] = ["error", ...items];
         }
     }
@@ -24,7 +24,50 @@ function createRulesRecord(generator) {
     }
     return rules;
 }
+/**
+ * Merges built-in items and custom items for restricted rules.
+ *
+ * @param nativeDecorators
+ *  Whether to support native decorators in the code.
+ *
+ * @param restrictedItems
+ *  The custom items for restricted rules to be merged.
+ *
+ * @returns
+ *  The rules dictionary with all needed restricted rules.
+ */
+function mergeRestrictedItems(nativeDecorators, ...restrictedItems) {
+    const RESTRICTED_GLOBALS = [
+        { name: "isFinite", message: "Use 'Number.isFinite' instead." },
+        { name: "isNaN", message: "Use 'Number.isNaN' instead." },
+    ];
+    const RESTRICTED_SYNTAX = [
+        { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='private']" + (nativeDecorators ? "" : "[decorators.length=0]"), message: "Use #private syntax instead." },
+    ];
+    // restricted items for all files in the environment
+    return {
+        globals: flatArray(RESTRICTED_GLOBALS, ...restrictedItems.map(item => item?.globals)),
+        imports: flatArray(...restrictedItems.map(item => item?.imports)),
+        properties: flatArray(...restrictedItems.map(item => item?.properties)),
+        syntax: flatArray(RESTRICTED_SYNTAX, ...restrictedItems.map(item => item?.syntax)),
+    };
+}
 // ----------------------------------------------------------------------------
+/**
+ * Creates restricted rules with built-in restricted items only.
+ *
+ * @param languageOptions
+ *  The language options passed with the Linter configuration.
+ *
+ * @returns
+ *  The rules dictionary with all needed restricted rules.
+ */
+export function builtinRestrictedRules(languageOptions) {
+    // built-in restricted items
+    const items = mergeRestrictedItems(!!languageOptions.nativeDecorators);
+    // generate the rules dictionary
+    return createRulesRecord(key => items[key]);
+}
 /**
  * Generates various "no-restricted-?" rules from the passed configuration.
  *
@@ -38,24 +81,10 @@ function createRulesRecord(generator) {
  * @returns
  *  The flat configuration objects needed to forbid the restricted items.
  */
-export function restrictedRules(envOptions, fixed) {
-    const { restricted = {} } = envOptions;
-    const RESTRICTED_GLOBALS = [
-        { name: "isFinite", message: "Use 'Number.isFinite' instead." },
-        { name: "isNaN", message: "Use 'Number.isNaN' instead." },
-    ];
-    const RESTRICTED_SYNTAX = [
-        { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='public']", message: "Remove 'public' keyword." },
-        { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='private']" + (restricted.nativeDecorators ? "" : "[decorators.length=0]"), message: "Use #private syntax instead." },
-        { selector: "MethodDefinition[kind='constructor'] TSParameterProperty[accessibility]", message: "Use explicit class properties." },
-    ];
+export function restrictedRulesConfig(envOptions, fixed) {
+    const { restricted } = envOptions;
     // restricted items for all files in the environment
-    const items = {
-        globals: flatArray(RESTRICTED_GLOBALS, fixed?.globals, restricted.globals),
-        imports: flatArray(fixed?.imports, restricted.imports),
-        properties: flatArray(fixed?.properties, restricted.properties),
-        syntax: flatArray(RESTRICTED_SYNTAX, fixed?.syntax, restricted.syntax),
-    };
+    const items = mergeRestrictedItems(!!restricted?.nativeDecorators, fixed, restricted);
     // generate the configuration objects
     return concatConfigs(
     // base rules for all files in the environment
@@ -63,7 +92,7 @@ export function restrictedRules(envOptions, fixed) {
         rules: createRulesRecord(key => items[key]),
     }), 
     // generate the override entries (join with base items)
-    restricted.overrides?.map(override => createConfig(override, {
+    restricted?.overrides?.map(override => createConfig(override, {
         rules: createRulesRecord(key => flatArray(items[key], override[key])),
     })));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",