@open-xchange/linter-presets 0.0.5 → 0.1.0

package/CHANGELOG.md

@@ -1,13 +1,22 @@
 # Changelog
 
-## [0.0.1] - 2024-07-05
+## [0.1.0] - 2024-07-10
 
-- added: [ESLint] project configuration (core, js, ts, json, yaml, license, directives, promises, jsdoc, stylistic)
-- added: [ESLint] environment presets (tsconfig, node, browser, jest, vitest, codecept, react, plugin)
+- chore: converted source code to TypeScript
 
-## [0.0.2] - 2024-07-08
+## [0.0.6] - 2024-07-10
 
-- added: [StyleLint] project configuration (core, less, sass, license, stylistic)
+- fixed: [ESLint] type error in `env-project/no-invalid-modules`
+
+## [0.0.5] - 2024-07-10
+
+- changed: [ESLint] `env-project/no-invalid-modules`: renamed option `packages.dependsOn` to `packages.extends`
+- chore: [ESLint] documentation for option `restricted`
+- chore: bump dependencies
+
+## [0.0.4] - 2024-07-10
+
+- fixed: [ESLint] file exists detection in rule `env-project/no-invalid-modules`
 
 ## [0.0.3] - 2024-07-09
 
@@ -20,11 +29,11 @@
 - fixed: [StyleLint] support for LESS files
 - chore: bump dependencies
 
-## [0.0.4] - 2024-07-10
+## [0.0.2] - 2024-07-08
 
-- fixed: [ESLint] file exists detection in rule `env-project/no-invalid-modules`
+- added: [StyleLint] project configuration (core, less, sass, license, stylistic)
 
-## [0.0.5] - 2024-07-10
+## [0.0.1] - 2024-07-05
 
-- chore: [ESLint] documentation for option `restricted`
-- chore: bump dependencies
+- added: [ESLint] project configuration (core, js, ts, json, yaml, license, directives, promises, jsdoc, stylistic)
+- added: [ESLint] environment presets (tsconfig, node, browser, jest, vitest, codecept, react, plugin)

package/README.md

@@ -26,7 +26,7 @@ export default [
 ]
 ```
 
-See the [`eslint` module documentation](./lib/eslint/README.md) for more details.
+See the [`eslint` module documentation](./doc/eslint/README.md) for more details.
 
 ## StyleLint
 
@@ -43,10 +43,10 @@ export default eslint.configure({
 })
 ```
 
-See the [`stylelint` module documentation](./lib/stylelint/README.md) for more details.
+See the [`stylelint` module documentation](./doc/stylelint/README.md) for more details.
 
 ## Utils
 
 The module `utils` exports utility functions to be used in ESLint and StyleLint configuration files.
 
-See the [`utils` module documentation](./lib/utils/README.md) for more details.
+See the [`utils` module documentation](./doc/utils/README.md) for more details.

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

@@ -0,0 +1,16 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { LanguageOptions } from "../shared/env-utils.js";
+/**
+ * Defines standard module settings and additional rules targeting JavaScript
+ * _and_ TypeScript source files.
+ *
+ * Wraps the following packages:
+ * - `@eslint/js`
+ *
+ * @param options
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function base(options: Required<LanguageOptions>): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,8 +1,5 @@
-
 import eslintJs from "@eslint/js";
-
 // functions ==================================================================
-
 /**
  * Defines standard module settings and additional rules targeting JavaScript
  * _and_ TypeScript source files.
@@ -10,36 +7,22 @@ import eslintJs from "@eslint/js";
  * Wraps the following packages:
  * - `@eslint/js`
  *
- * @param {Required<import("../shared/types").LanguageOptions>} 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 base(options) {
-
-    /**
-     * Returns language options for specific file extensions.
-     *
-     * @param {"module"|"commonjs"} sourceType
-     *  Module type specifier.
-     *
-     * @param {string[]} extensions
-     *  List of file extensions.
-     *
-     * @returns {import("eslint").Linter.FlatConfig}
-     *  The configuration entry.
-     */
-    function languageOptions(sourceType, ...extensions) {
+    // returns language options for specific file extensions
+    const languageOptions = (sourceType, ...extensions) => {
         const { ecmaVersion } = options;
         return {
             files: extensions.map(ext => "*/**." + ext),
             languageOptions: { ecmaVersion, sourceType },
         };
-    }
-
+    };
     return [
-
         // global linter configuration
         {
             linterOptions: {
@@ -47,16 +30,12 @@ export default function base(options) {
                 reportUnusedDisableDirectives: "error",
             },
         },
-
         // ECMA version and module type for ES modules
         languageOptions("module", "mjs", "mts"),
-
         // ECMA version and module type for CommonJS modules
         languageOptions("commonjs", "cjs", "cts"),
-
         // ECMA version and module type for *.js and *.ts files
         languageOptions(options.sourceType, "js", "jsx", "ts", "tsx"),
-
         // configure linter rules
         {
             files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],

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

@@ -0,0 +1,11 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Checks inline linter directives.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-eslint-comments`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function directives(): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,19 +1,15 @@
-
 import commentsPluginConfigs from "@eslint-community/eslint-plugin-eslint-comments/configs";
-
 // functions ==================================================================
-
 /**
  * Checks inline linter directives.
  *
  * Wraps the following packages:
  * - `eslint-plugin-eslint-comments`
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function directives() {
-
     return [
         // register rule implementations and recommended rules
         commentsPluginConfigs.recommended,

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

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

package/dist/eslint/config/imports.js

@@ -0,0 +1,58 @@
+import importPlugin from "eslint-plugin-import";
+import { fixupPluginRules } from "@eslint/compat";
+// exports ====================================================================
+/**
+ * Adds linter rules for `import` and `export` statements.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-import`
+ *
+ * @param options
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function importConfig(options) {
+    // configuration properties
+    const { ecmaVersion, sourceType } = options;
+    // extensions of ES module files
+    const jsExtensions = (sourceType === "module") ? [".js", ".mjs"] : [".mjs"];
+    const tsExtensions = (sourceType === "module") ? [".ts", ".mts"] : [".mts"];
+    return [{
+            files: [
+                ...jsExtensions.map(ext => "**/*" + ext),
+                ...tsExtensions.map(ext => "**/*" + ext),
+            ],
+            // register rule implementations of the plugin
+            plugins: {
+                import: fixupPluginRules(importPlugin), // https://github.com/import-js/eslint-plugin-import/issues/2948
+            },
+            // language options need to be repeated for this plugin
+            languageOptions: {
+                parserOptions: {
+                    ecmaVersion,
+                    sourceType: "module",
+                },
+            },
+            // parser settings need to be repeated for this plugin
+            settings: {
+                "import/parsers": {
+                    espree: jsExtensions,
+                    "@typescript-eslint/parser": tsExtensions,
+                },
+            },
+            // reconfigure plugin rules
+            rules: {
+                // recommended rules
+                ...importPlugin.configs.recommended.rules,
+                ...importPlugin.configs.typescript.rules,
+                // change or disable a few recommended rules
+                "import/default": "off",
+                "import/no-duplicates": "error",
+                "import/no-named-as-default": "off",
+                "import/no-named-as-default-member": "off",
+                "import/no-unresolved": "off",
+            },
+        }];
+}

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

@@ -0,0 +1,9 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Defines additional standard rules targeting JavaScript but _not_ TypeScript
+ * source files.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function js(): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/config/js.js

@@ -0,0 +1,32 @@
+import { NO_UNUSED_VARS_OPTIONS } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Defines additional standard rules targeting JavaScript but _not_ TypeScript
+ * source files.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function js() {
+    return [{
+            files: ["**/*.{js,jsx,cjs,mjs}"],
+            rules: {
+                // possible problems
+                "no-duplicate-imports": "error",
+                "no-loss-of-precision": "off",
+                "no-unused-vars": ["error", NO_UNUSED_VARS_OPTIONS],
+                // suggestions
+                "default-param-last": "error",
+                "dot-notation": "error",
+                "no-array-constructor": "error",
+                "no-invalid-this": "error",
+                "no-loop-func": "error",
+                "no-redeclare": "error",
+                "no-shadow": ["error", { ignoreOnInitialization: true }],
+                "no-throw-literal": "error",
+                "no-useless-constructor": "error",
+                "prefer-promise-reject-errors": "error",
+                "require-await": "error",
+            },
+        }];
+}

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

@@ -0,0 +1,11 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Checks the JSDoc comments in source files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jsdoc`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function jsdoc(): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,24 +1,18 @@
-
 import jsdocPlugin from "eslint-plugin-jsdoc";
-
 // functions ==================================================================
-
 /**
  * Checks the JSDoc comments in source files.
  *
  * Wraps the following packages:
  * - `eslint-plugin-jsdoc`
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function jsdoc() {
-
     return [
-
         // register rule implementations and recommended rules
         jsdocPlugin.configs["flat/recommended-error"],
-
         // general configuration
         {
             settings: {
@@ -35,7 +29,6 @@ export default function jsdoc() {
                 },
             },
         },
-
         // overrides for TypeScript files
         {
             files: ["**/*.{ts,tsx,cts,mts}"],
@@ -44,7 +37,6 @@ export default function jsdoc() {
                 "jsdoc/check-param-names": ["error", { allowExtraTrailingParamDocs: true }], // overload signatures
             },
         },
-
         // configure plugin rules
         {
             rules: {

package/dist/eslint/config/json.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 JSON files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jsonc`
+ *
+ * @param options
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function json(options: Required<StylisticOptions>): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,27 +1,21 @@
-
 import jsonPlugin from "eslint-plugin-jsonc";
-
 // functions ==================================================================
-
 /**
  * Defines standard linting rules for JSON files.
  *
  * Wraps the following packages:
  * - `eslint-plugin-jsonc`
  *
- * @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 json(options) {
-
     return [
-
         // register rule implementations and recommended rules
         ...jsonPlugin.configs["flat/recommended-with-json"],
-
         // reconfigure plugin rules
         {
             rules: {

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

@@ -0,0 +1,14 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Checks the existence of license headers in source files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-license-header`
+ *
+ * @param path
+ *  Path to the template file containing the license header.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function license(path: string): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,33 +1,27 @@
-
 import licensePlugin from "eslint-plugin-license-header";
-
 // functions ==================================================================
-
 /**
  * Checks the existence of license headers in source files.
  *
  * Wraps the following packages:
  * - `eslint-plugin-license-header`
  *
- * @param {string} path
+ * @param path
  *  Path to the template file containing the license header.
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function license(path) {
-
     return [{
-        files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],
-
-        // register rule implementations of the plugin
-        plugins: {
-            "license-header": licensePlugin,
-        },
-
-        // configure plugin rules
-        rules: {
-            "license-header/header": ["error", path],
-        },
-    }];
+            files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],
+            // register rule implementations of the plugin
+            plugins: {
+                "license-header": licensePlugin,
+            },
+            // configure plugin rules
+            rules: {
+                "license-header/header": ["error", path],
+            },
+        }];
 }

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

@@ -0,0 +1,11 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Checks for correct usage of native promises.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-promise`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function promises(): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,32 +1,26 @@
-
 import promisePlugin from "eslint-plugin-promise";
-
 // functions ==================================================================
-
 /**
  * Checks for correct usage of native promises.
  *
  * Wraps the following packages:
  * - `eslint-plugin-promise`
  *
- * @returns {import("../shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function promises() {
-
     return [
-
         // register rule implementations and recommended rules
         promisePlugin.configs["flat/recommended"],
-
         // reconfigure plugin rules
         {
             rules: {
                 "promise/always-return": ["error", { ignoreLastCallback: true }],
                 "promise/no-callback-in-promise": "off",
-                "promise/no-nesting": "error",      // warning => error
+                "promise/no-nesting": "error", // warning => error
                 "promise/no-return-in-finally": "error",
-                "promise/valid-params": "error",    // warning => error
+                "promise/valid-params": "error", // warning => error
             },
         },
     ];

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

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

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

@@ -1,9 +1,6 @@
-
 import stylisticPlugin from "@stylistic/eslint-plugin";
 import migratePlugin from "@stylistic/eslint-plugin-migrate";
-
 // functions ==================================================================
-
 /**
  * Defines standard (opinionated) linter rules for source code style.
  *
@@ -11,29 +8,24 @@ import migratePlugin from "@stylistic/eslint-plugin-migrate";
  * - `@stylistic/eslint-plugin`
  * - `@stylistic/eslint-plugin-migrate`
  *
- * @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 stylistic(options) {
-
     // configuration properties
     const { indent, semi, quotes, dangle } = options;
-
     return [
-
         // globally disable all deprecated stylistic core rules
         stylisticPlugin.configs["disable-legacy"],
-
         // "@stylistic" plugin
         {
             // register rule implementations of the plugins
             plugins: {
                 "@stylistic": stylisticPlugin,
             },
-
             // configure plugin rules
             rules: {
                 "@stylistic/array-bracket-spacing": "error",
@@ -68,16 +60,16 @@ export default function stylistic(options) {
                 "@stylistic/no-extra-semi": "error",
                 "@stylistic/no-floating-decimal": "error",
                 "@stylistic/no-mixed-operators": ["error", {
-                    groups: [
-                        // allow to mix arithmetic operators
-                        // ["+", "-", "*", "/", "%", "**"],
-                        ["&", "|", "^", "~", "<<", ">>", ">>>"],
-                        ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
-                        ["&&", "||"],
-                        ["in", "instanceof"],
-                    ],
-                    allowSamePrecedence: true,
-                }],
+                        groups: [
+                            // allow to mix arithmetic operators
+                            // ["+", "-", "*", "/", "%", "**"],
+                            ["&", "|", "^", "~", "<<", ">>", ">>>"],
+                            ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+                            ["&&", "||"],
+                            ["in", "instanceof"],
+                        ],
+                        allowSamePrecedence: true,
+                    }],
                 "@stylistic/no-multiple-empty-lines": ["error", { max: 2 }],
                 "@stylistic/no-tabs": "error",
                 "@stylistic/no-trailing-spaces": "error",
@@ -104,14 +96,12 @@ export default function stylistic(options) {
                 "@stylistic/yield-star-spacing": "error",
             },
         },
-
         // "@stylistic/migrate" plugin
         {
             // register rule implementations of the plugins
             plugins: {
                 "@stylistic/migrate": migratePlugin,
             },
-
             // configure plugin rules
             rules: {
                 "@stylistic/migrate/migrate-js": "error",

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

@@ -0,0 +1,11 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+/**
+ * Defines standard rules for TypeScript source files.
+ *
+ * Wraps the following packages:
+ * - `typescript-eslint`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function ts(): TSESLint.FlatConfig.ConfigArray;