@open-xchange/linter-presets 0.0.6 → 0.1.0

package/{lib → dist}/eslint/config/ts.js

@@ -4,41 +4,33 @@
 * This program is proprietary software and licensed to you under Open-Xchange
 * GmbH's Software License Agreement.
 */
-
 import typescriptEslint from "typescript-eslint";
-
 import { NO_UNUSED_VARS_OPTIONS } from "../shared/env-utils.js";
-
 // functions ==================================================================
-
 /**
  * Defines standard rules for TypeScript source files.
  *
  * Wraps the following packages:
  * - `typescript-eslint`
  *
- * @returns {import("../shared/types.js").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function ts() {
-
     // plugin configuration, additional rules
     return typescriptEslint.config({
         files: ["**/*.{ts,tsx,mts,cts}"],
-
         // suppress warning for new TypeScript versions
         languageOptions: {
             parserOptions: {
                 warnOnUnsupportedTypeScriptVersion: false,
             },
         },
-
         // recommended rules
         extends: [
             ...typescriptEslint.configs.recommendedTypeChecked,
             ...typescriptEslint.configs.stylisticTypeChecked,
         ],
-
         // reconfigure plugin rules
         rules: {
             "@typescript-eslint/array-type": ["error", { default: "array-simple" }],
@@ -48,17 +40,17 @@ export default function ts() {
             "@typescript-eslint/default-param-last": "error",
             "@typescript-eslint/dot-notation": "error",
             "@typescript-eslint/explicit-function-return-type": ["error", {
-                allowExpressions: true,
-                allowTypedFunctionExpressions: true,
-                allowHigherOrderFunctions: true,
-                allowConciseArrowFunctionExpressionsStartingWithVoid: true,
-            }],
+                    allowExpressions: true,
+                    allowTypedFunctionExpressions: true,
+                    allowHigherOrderFunctions: true,
+                    allowConciseArrowFunctionExpressionsStartingWithVoid: true,
+                }],
             "@typescript-eslint/no-array-constructor": "error",
             "@typescript-eslint/no-array-delete": "error",
             "@typescript-eslint/no-duplicate-type-constituents": "error",
             "@typescript-eslint/no-empty-function": ["error", {
-                allow: ["private-constructors", "protected-constructors", "decoratedFunctions", "overrideMethods"],
-            }],
+                    allow: ["private-constructors", "protected-constructors", "decoratedFunctions", "overrideMethods"],
+                }],
             "@typescript-eslint/no-empty-interface": "off",
             "@typescript-eslint/no-explicit-any": "off",
             "@typescript-eslint/no-import-type-side-effects": "error",
@@ -86,8 +78,7 @@ export default function ts() {
             "@typescript-eslint/switch-exhaustiveness-check": "error",
             "@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
         },
-    },
-
+    }, 
     // fixes for module definition files
     {
         files: ["**/*.d.{ts,tsx,mts,cts}"],

package/dist/eslint/config/yaml.d.ts

@@ -0,0 +1,15 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { StylisticOptions } from "../shared/env-utils.js";
+/**
+ * Defines standard linting rules for YAML files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-yml`
+ *
+ * @param options
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function yaml(options: Required<StylisticOptions>): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/config/yaml.js

@@ -1,27 +1,21 @@
-
 import yamlPlugin from "eslint-plugin-yml";
-
 // functions ==================================================================
-
 /**
  * Defines standard linting rules for YAML files.
  *
  * Wraps the following packages:
  * - `eslint-plugin-yml`
  *
- * @param {Required<import("../shared/types").StylisticOptions>} options
+ * @param options
  *  Resolved configuration options.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function yaml(options) {
-
     return [
-
         // register rule implementations and recommended rules
         ...yamlPlugin.configs["flat/recommended"],
-
         // reconfigure plugin rules
         {
             rules: {

package/dist/eslint/env/browser.d.ts

@@ -0,0 +1,27 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions, EnvRestrictedOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.browser".
+ */
+export interface EnvBrowserOptions extends EnvBaseOptions {
+    /**
+     * All globals, imports, properties, and syntax constructs to be banned for
+     * the files included by the environment.
+     */
+    restricted?: EnvRestrictedOptions;
+}
+/**
+ * Creates configuration objects with global symbols and linter rules for for
+ * browser modules.
+ *
+ * Wraps the following packages:
+ * - `globals`
+ * - `confusing-browser-globals`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function browser(options: EnvBrowserOptions): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/env/browser.js

@@ -1,11 +1,7 @@
-
 import JAVASCRIPT_GLOBALS from "globals";
 import CONFUSING_BROWSER_GLOBALS from "confusing-browser-globals";
-
 import { generateRestrictedRules } from "../shared/env-utils.js";
-
 // constants ==================================================================
-
 /**
  * Global builtin symbols that are confusing or deprecated.
  */
@@ -21,7 +17,6 @@ const CONFUSING_BUILTIN_GLOBALS = [
     "unescape",
     "valueOf",
 ];
-
 /**
  * Global browser classes that may conflict with custom application classes.
  * For disambiguation, custom classes must be imported, and global browser
@@ -35,14 +30,12 @@ const AMBIGUOUS_BROWSER_TYPES = [
     "Storage",
     "Transformer",
 ];
-
 /**
  * Properties of global objects to be banned in all browser modules.
  */
 const RESTRICTED_PROPERTIES = [
     { object: "Object", property: "hasOwn", message: "Missing browser support." },
 ];
-
 /**
  * Syntax constructs to be banned in all browser modules.
  */
@@ -50,9 +43,7 @@ const RESTRICTED_SYNTAX = [
     { selector: "ClassBody > StaticBlock", message: "Static blocks not supported yet." },
     { selector: "ExportNamedDeclaration > TSEnumDeclaration[const=true]", message: "Do not export const enums." },
 ];
-
 // initialization =============================================================
-
 /**
  * All supported global browser symbols intended to be used without fully
  * qualified name (e.g. `HTMLElement` instead of `window.HTMLElement`).
@@ -61,35 +52,30 @@ const RESTRICTED_SYNTAX = [
  * misspelled variables or parameter names.
  */
 const BROWSER_GLOBALS = {};
-
 // Add all builtin ES globals.
 for (const name of Object.keys(JAVASCRIPT_GLOBALS.builtin)) {
     BROWSER_GLOBALS[name] = "readonly";
 }
-
 // Add browser globals (skip writable properties, e.g. window event handlers).
 for (const [name, writable] of Object.entries(JAVASCRIPT_GLOBALS.browser)) {
-    if (!writable) { BROWSER_GLOBALS[name] = "readonly"; }
+    if (!writable) {
+        BROWSER_GLOBALS[name] = "readonly";
+    }
 }
-
 // Remove commonly known confusing or deprecated builtin globals.
 for (const name of CONFUSING_BUILTIN_GLOBALS) {
     delete BROWSER_GLOBALS[name];
 }
-
 // Remove commonly known confusing browser globals (e.g. `name`, `event`).
 for (const name of CONFUSING_BROWSER_GLOBALS) {
     delete BROWSER_GLOBALS[name];
 }
-
 // Create the configuration list for rule "no-restricted-globals".
 const RESTRICTED_GLOBALS = AMBIGUOUS_BROWSER_TYPES.map(name => {
     const message = `Import custom type '${name}', or use 'window.${name}' for disambiguation.`;
     return { name, message };
 });
-
 // functions ==================================================================
-
 /**
  * Creates configuration objects with global symbols and linter rules for for
  * browser modules.
@@ -98,43 +84,36 @@ const RESTRICTED_GLOBALS = AMBIGUOUS_BROWSER_TYPES.map(name => {
  * - `globals`
  * - `confusing-browser-globals`
  *
- * @param {import("./browser").EnvBrowserOptions} options
+ * @param options
  *  Configuration options for the environment.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function browser(options) {
-
     // configuration properties
     const { files, ignores = [], rules } = options;
-
     // generate the "no-restricted-?" rules according to passed configuration
     const restricted = generateRestrictedRules({
         globals: RESTRICTED_GLOBALS,
         properties: RESTRICTED_PROPERTIES,
         syntax: RESTRICTED_SYNTAX,
     }, options?.restricted);
-
     return [
-
         // base configuration for the environment
         {
             files,
             ignores,
-
             // register global symbols used in browser scripts
             languageOptions: {
                 globals: BROWSER_GLOBALS,
             },
-
             // configure rules
             rules: {
                 ...restricted.rules,
                 ...rules,
             },
         },
-
         // "no-restricted-?" rules overrides for specific files
         ...restricted.overrides,
     ];

package/dist/eslint/env/codecept.d.ts

@@ -0,0 +1,22 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.codecept".
+ */
+export interface EnvCodeceptOptions extends EnvBaseOptions {
+}
+/**
+ * Creates configuration objects with global symbols and linter rules for E2E
+ * tests using CodeceptJS.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-codeceptjs`
+ * - `eslint-plugin-chai-expect`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function codecept(options: EnvCodeceptOptions): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/env/codecept.js

@@ -4,12 +4,9 @@
 * This program is proprietary software and licensed to you under Open-Xchange
 * GmbH's Software License Agreement.
 */
-
 import codeceptPlugin from "eslint-plugin-codeceptjs";
 import chaiExpectPlugin from "eslint-plugin-chai-expect";
-
 // functions ==================================================================
-
 /**
  * Creates configuration objects with global symbols and linter rules for E2E
  * tests using CodeceptJS.
@@ -18,49 +15,43 @@ import chaiExpectPlugin from "eslint-plugin-chai-expect";
  * - `eslint-plugin-codeceptjs`
  * - `eslint-plugin-chai-expect`
  *
- * @param {import("./codecept").EnvCodeceptOptions} options
+ * @param options
  *  Configuration options for the environment.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function codecept(options) {
-
     // configuration properties
     const { files, ignores = [], rules } = options;
-
     return [
         {
             files,
             ignores,
-
             // register rule implementations of the plugins
             plugins: {
                 codeceptjs: codeceptPlugin,
             },
-
             // register global symbols of CodeceptJS
             languageOptions: {
                 globals: {
                     ...codeceptPlugin.environments.codeceptjs.globals,
                 },
             },
-
             // configure plugin rules
             rules: {
                 // recommended rules
                 ...codeceptPlugin.configs.recommended.rules,
                 // extra rules
                 "new-cap": ["error", {
-                    capIsNewExceptions: ["After", "AfterSuite", "Before", "BeforeSuite", "Feature", "Scenario"],
-                }],
+                        capIsNewExceptions: ["After", "AfterSuite", "Before", "BeforeSuite", "Feature", "Scenario"],
+                    }],
                 "no-restricted-properties": ["warn", { object: "Scenario", property: "todo", message: "Unexpected unimplemented test." }],
                 "codeceptjs/no-skipped-tests": "warn",
                 // custom rules
                 ...rules,
             },
         },
-
         {
             files,
             ignores,

package/dist/eslint/env/eslint.d.ts

@@ -0,0 +1,20 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.eslint".
+ */
+export interface EnvEslintOptions extends EnvBaseOptions {
+}
+/**
+ * Adds linter rules for ESLint plugin implementations.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-eslint-plugin`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function eslint(options: EnvEslintOptions): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/env/eslint.js

@@ -1,36 +1,29 @@
-
 import eslintPlugin from "eslint-plugin-eslint-plugin";
-
 // exports ====================================================================
-
 /**
  * Adds linter rules for ESLint plugin implementations.
  *
  * Wraps the following packages:
  * - `eslint-plugin-eslint-plugin`
  *
- * @param {import("./eslint").EnvEslintOptions} options
+ * @param options
  *  Configuration options for the environment.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function eslint(options) {
-
     // configuration properties
     const { files, ignores = [], rules = {} } = options;
     // the plugin configuration
     const pluginConfig = eslintPlugin.configs["flat/rules-recommended"];
-
     return [
-
         // register rule implementations and recommended rules
         {
             files,
             ignores,
             ...pluginConfig,
         },
-
         // reconfigure plugin rules
         {
             files,

package/dist/eslint/env/jest.d.ts

@@ -0,0 +1,21 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.jest".
+ */
+export interface EnvJestOptions extends EnvBaseOptions {
+}
+/**
+ * Creates configuration objects with global symbols and linter rules for unit
+ * tests using Jest.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jest`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function jest(options: EnvJestOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/jest.js

@@ -0,0 +1,49 @@
+import jestPlugin from "eslint-plugin-jest";
+// functions ==================================================================
+/**
+ * Creates configuration objects with global symbols and linter rules for unit
+ * tests using Jest.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jest`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function jest(options) {
+    // config properties
+    const { files, ignores = [], rules } = options;
+    return [{
+            files,
+            ignores,
+            // register rule implementations, globals
+            ...jestPlugin.configs["flat/recommended"],
+            // configure plugin rules
+            rules: {
+                // recommended rules
+                ...jestPlugin.configs["flat/recommended"].rules,
+                ...jestPlugin.configs["flat/style"].rules,
+                // extra rules
+                "jest/consistent-test-it": ["error", { fn: "it" }],
+                "jest/no-commented-out-tests": "error",
+                "jest/no-conditional-expect": "off",
+                "jest/no-confusing-set-timeout": "error",
+                "jest/no-duplicate-hooks": "error",
+                "jest/no-test-return-statement": "error",
+                "jest/prefer-comparison-matcher": "error",
+                "jest/prefer-equality-matcher": "error",
+                "jest/prefer-expect-resolves": "error",
+                "jest/prefer-hooks-on-top": "error",
+                "jest/prefer-lowercase-title": "error",
+                "jest/prefer-mock-promise-shorthand": "error",
+                "jest/prefer-spy-on": "error",
+                "jest/prefer-todo": "error",
+                "jest/require-top-level-describe": "error",
+                // custom rules
+                ...rules,
+            },
+        }];
+}

package/dist/eslint/env/node.d.ts

@@ -0,0 +1,30 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { LanguageOptions, EnvBaseOptions, EnvRestrictedOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.node".
+ */
+export interface EnvNodeOptions extends EnvBaseOptions {
+    /**
+     * The module mode used by the linted files. Default value is "module".
+     */
+    sourceType?: LanguageOptions["sourceType"];
+    /**
+     * All globals, imports, properties, and syntax constructs to be banned for
+     * the files included by the environment.
+     */
+    restricted?: EnvRestrictedOptions;
+}
+/**
+ * Creates configuration objects with global symbols and linter rules for
+ * NodeJS modules.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-n`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function node(options: EnvNodeOptions): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/env/node.js

@@ -1,12 +1,6 @@
-
-// replacement for abandoned "eslint-plugin-node"
-// - https://github.com/mysticatea/eslint-plugin-node/issues/341
 import nodePlugin from "eslint-plugin-n";
-
 import { generateRestrictedRules } from "../shared/env-utils.js";
-
 // functions ==================================================================
-
 /**
  * Creates configuration objects with global symbols and linter rules for
  * NodeJS modules.
@@ -14,25 +8,21 @@ import { generateRestrictedRules } from "../shared/env-utils.js";
  * Wraps the following packages:
  * - `eslint-plugin-n`
  *
- * @param {import("./node").EnvNodeOptions} options
+ * @param options
  *  Configuration options for the environment.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function node(options) {
-
     // configuration properties
     const { files, ignores = [], sourceType = "module", rules } = options;
     // the plugin configuration
     const configKey = (sourceType === "commonjs") ? "flat/recommended-script" : "flat/recommended-module";
     const nodeConfig = nodePlugin.configs[configKey];
-
     // generate the "no-restricted-?" rules according to passed configuration
     const restricted = generateRestrictedRules({}, options?.restricted);
-
     return [
-
         // register rule implementations
         {
             files,
@@ -44,7 +34,6 @@ export default function node(options) {
                 },
             },
         },
-
         // reconfigure plugin rules
         {
             files,
@@ -56,7 +45,6 @@ export default function node(options) {
                 ...rules,
             },
         },
-
         // "no-restricted-?" rules overrides for specific files
         ...restricted.overrides,
     ];

package/dist/eslint/env/project.d.ts

@@ -0,0 +1,18 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
+import { type RuleNoInvalidModulesOptions } from "../rules/no-invalid-modules.js";
+/**
+ * Configuration options for the environment preset "env.project".
+ */
+export interface EnvProjectOptions extends EnvBaseOptions, RuleNoInvalidModulesOptions {
+}
+/**
+ * Adds custom linter rules for checking project setup and module hierarchy.
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function project(options: EnvProjectOptions): TSESLint.FlatConfig.ConfigArray;

package/{lib → dist}/eslint/env/project.js

@@ -18,45 +18,38 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  *
  */
-
 import noAmdModuleDirective from "../rules/no-amd-module-directive.js";
 import noInvalidModules from "../rules/no-invalid-modules.js";
-
 // exports ====================================================================
-
 /**
  * Adds custom linter rules for checking project setup and module hierarchy.
  *
- * @param {import("./project").EnvProjectOptions} options
+ * @param options
  *  Configuration options for the environment.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function project(options) {
-
     // configuration properties
     const { files, ignores = [], rules, ...rest } = options;
-
     return [{
-        files,
-        ignores,
-
-        // register rule implementations
-        plugins: {
-            "env-project": {
-                rules: {
-                    "no-amd-module-directive": noAmdModuleDirective,
-                    "no-invalid-modules": noInvalidModules,
+            files,
+            ignores,
+            // register rule implementations
+            plugins: {
+                "env-project": {
+                    rules: {
+                        "no-amd-module-directive": noAmdModuleDirective,
+                        "no-invalid-modules": noInvalidModules,
+                    },
                 },
             },
-        },
-
-        // configure rules
-        rules: {
-            "env-project/no-amd-module-directive": "error",
-            "env-project/no-invalid-modules": ["error", rest],
-            ...rules,
-        },
-    }];
+            // configure rules
+            rules: {
+                "env-project/no-amd-module-directive": "error",
+                "env-project/no-invalid-modules": ["error", rest],
+                ...rules,
+            },
+        }];
 }