@open-xchange/linter-presets 0.0.6 → 0.1.0

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

@@ -0,0 +1,29 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
+/**
+ * Configuration options for the environment preset "env.react".
+ */
+export interface EnvReactOptions extends EnvBaseOptions {
+    /**
+     * Configuration for the rule "react-hooks-static-deps/exhaustive-deps".
+     */
+    staticHooks?: Record<string, boolean | boolean[] | Record<string, boolean>>;
+}
+/**
+ * Creates configuration objects with linter rules for ReactJS.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-react`
+ * - `eslint-plugin-react-hooks`
+ * - `eslint-plugin-react-hooks-static-deps`
+ * - `eslint-plugin-react-refresh`
+ * - `eslint-plugin-jsx-expressions`
+ * - `eslint-plugin-jsx-a11y`
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function react(options: EnvReactOptions): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,14 +1,11 @@
-
-import { fixupPluginRules } from "@eslint/compat";
 import reactPlugin from "eslint-plugin-react";
 import reactHooksPlugin from "eslint-plugin-react-hooks";
 import reactHooksStaticDepsPlugin from "eslint-plugin-react-hooks-static-deps";
 import reactRefreshPlugin from "eslint-plugin-react-refresh";
 import jsxExpressionsPlugin from "eslint-plugin-jsx-expressions";
 import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
-
+import { fixupPluginRules } from "@eslint/compat";
 // functions ==================================================================
-
 /**
  * Creates configuration objects with linter rules for ReactJS.
  *
@@ -20,24 +17,20 @@ import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
  * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
- * @param {import("./react").EnvReactOptions} 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 react(options) {
-
     // configuration properties
     const { files, ignores = [], rules, staticHooks = {} } = options;
-
     return [
-
         // configure plugins and rules for all source files (JSX and TSX)
         {
             files,
             ignores,
-
             // register rule implementations of the plugins
             plugins: {
                 react: fixupPluginRules(reactPlugin), // https://github.com/jsx-eslint/eslint-plugin-react/issues/3699
@@ -47,18 +40,15 @@ export default function react(options) {
                 "jsx-expressions": fixupPluginRules(jsxExpressionsPlugin), // https://github.com/hluisson/eslint-plugin-jsx-expressions/issues/18
                 "jsx-a11y": jsxA11yPlugin,
             },
-
             settings: {
                 react: {
                     version: "detect",
                 },
             },
-
             // enable JSX support
             languageOptions: {
                 parserOptions: reactPlugin.configs.recommended.parserOptions,
             },
-
             // configure plugin rules
             rules: {
                 // recommended rules
@@ -87,12 +77,10 @@ export default function react(options) {
                 ...rules,
             },
         },
-
         // additional rules for TSX only
         {
             files,
             ignores: [...ignores, "**/*.{js,jsx}"],
-
             // configure plugin rules
             rules: {
                 // replace "react/jsx-no-leaked-render" rule with advanced alternative

package/dist/eslint/env/tsconfig.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.tsconfig".
+ */
+export interface EnvTSConfigOptions extends EnvBaseOptions {
+    /**
+     * The path to the TypeScript project configuration file (`tsconfig.json`).
+     */
+    project: string;
+}
+/**
+ * Creates configuration objects for TypeScript projects.
+ *
+ * @param options
+ *  Configuration options for the environment.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function tsconfig(options: EnvTSConfigOptions): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,35 +1,29 @@
-
 // functions ==================================================================
-
 /**
  * Creates configuration objects for TypeScript projects.
  *
- * @param {import("./tsconfig").EnvTSConfigOptions} 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 tsconfig(options) {
-
     // configuration properties
     const { files, ignores = [], rules } = options;
-
     return [{
-        files,
-        ignores,
-
-        // path to project configuration file
-        languageOptions: {
-            parserOptions: {
-                project: options.project,
+            files,
+            ignores,
+            // path to project configuration file
+            languageOptions: {
+                parserOptions: {
+                    project: options.project,
+                },
             },
-        },
-
-        // configure plugin rules
-        rules: {
-            // custom rules
-            ...rules,
-        },
-    }];
+            // configure plugin rules
+            rules: {
+                // custom rules
+                ...rules,
+            },
+        }];
 }

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

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

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

@@ -1,11 +1,8 @@
-
-import { fixupPluginRules } from "@eslint/compat";
 import vitestPlugin from "eslint-plugin-vitest";
 import jestDomPlugin from "eslint-plugin-jest-dom";
 import testingLibraryPlugin from "eslint-plugin-testing-library";
-
+import { fixupPluginRules } from "@eslint/compat";
 // functions ==================================================================
-
 /**
  * Creates configuration objects with global symbols and linter rules for unit
  * tests using Vitest.
@@ -15,34 +12,28 @@ import testingLibraryPlugin from "eslint-plugin-testing-library";
  * - `eslint-plugin-jest-dom`
  * - `eslint-plugin-testing-library`
  *
- * @param {import("./vitest").EnvVitestOptions} 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 vitest(options) {
-
     // configuration properties
     const { files, ignores = [], rules } = options;
-
     return [
-
         // "vitest" plugin
         {
             files,
             ignores,
-
             // register rule implementations of the plugins
             plugins: {
                 vitest: vitestPlugin,
             },
-
             // register global symbols of Vitest
             languageOptions: {
                 globals: vitestPlugin.environments.env.globals,
             },
-
             // configure plugin rules
             rules: {
                 // recommended rules
@@ -73,24 +64,20 @@ export default function vitest(options) {
                 ...rules,
             },
         },
-
         // "jest-dom" plugin
         {
             files,
             ignores,
             ...jestDomPlugin.configs["flat/recommended"],
         },
-
         // "testing-library" plugin
         {
             files,
             ignores,
-
             // register rule implementations of the plugins
             plugins: {
                 "testing-library": fixupPluginRules(testingLibraryPlugin), // https://github.com/testing-library/eslint-plugin-testing-library/issues/899
             },
-
             // configure plugin rules
             rules: {
                 // recommended rules

package/dist/eslint/index.d.ts

@@ -0,0 +1,63 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { LanguageOptions, StylisticOptions } from "./shared/env-utils.js";
+import tsconfig from "./env/tsconfig.js";
+import node from "./env/node.js";
+import browser from "./env/browser.js";
+import jest from "./env/jest.js";
+import vitest from "./env/vitest.js";
+import codecept from "./env/codecept.js";
+import react from "./env/react.js";
+import project from "./env/project.js";
+import eslint from "./env/eslint.js";
+/**
+ * Configuration options for linting the entire project with ESLint.
+ */
+export interface ConfigureOptions {
+    /**
+     * Glob patterns with all files and folders to be ignored by ESLint.
+     */
+    ignores?: string[];
+    /**
+     * Full path to the template file containing the license header to be used
+     * in all source files. The function `resolver` helps to to convert a local
+     * path to an absolute path.
+     */
+    license?: string;
+    /**
+     * Configuration options for language and project setup.
+     */
+    language?: LanguageOptions;
+    /**
+     * Configuration options for code style.
+     */
+    stylistic?: StylisticOptions;
+    /**
+     * Additional linter rules to be added to the global configuration.
+     */
+    rules?: TSESLint.FlatConfig.Rules;
+}
+/**
+ * A collection with all available environment presets.
+ */
+export declare const env: {
+    tsconfig: typeof tsconfig;
+    node: typeof node;
+    browser: typeof browser;
+    jest: typeof jest;
+    vitest: typeof vitest;
+    codecept: typeof codecept;
+    react: typeof react;
+    project: typeof project;
+    eslint: typeof eslint;
+};
+/**
+ * Generates ESLint configuration objects targeting the source files in the
+ * entire project.
+ *
+ * @param options
+ *  Plugin configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export declare function configure(options?: ConfigureOptions): TSESLint.FlatConfig.ConfigArray;

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

@@ -1,4 +1,3 @@
-
 import base from "./config/base.js";
 import js from "./config/js.js";
 import ts from "./config/ts.js";
@@ -10,7 +9,6 @@ import imports from "./config/imports.js";
 import promises from "./config/promises.js";
 import jsdoc from "./config/jsdoc.js";
 import stylistic from "./config/stylistic.js";
-
 import tsconfig from "./env/tsconfig.js";
 import node from "./env/node.js";
 import browser from "./env/browser.js";
@@ -20,9 +18,7 @@ import codecept from "./env/codecept.js";
 import react from "./env/react.js";
 import project from "./env/project.js";
 import eslint from "./env/eslint.js";
-
 // environment presets ========================================================
-
 /**
  * A collection with all available environment presets.
  */
@@ -37,28 +33,24 @@ export const env = {
     project,
     eslint,
 };
-
 // functions ==================================================================
-
 /**
- * Generates standard configuration objects targeting the source files in the
+ * Generates ESLint configuration objects targeting the source files in the
  * entire project.
  *
- * @param {import("./shared/types").ConfigureOptions} [options]
+ * @param options
  *  Plugin configuration options.
  *
- * @returns {import("./shared/types").FlatConfigArray}
+ * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
 export function configure(options) {
-
     // resolve language configuration options
     const languageOptions = {
         ecmaVersion: 2022,
         sourceType: "module",
         ...options?.language,
     };
-
     // resolve stylistic configuration options
     const stylisticOptions = {
         indent: 2,
@@ -67,45 +59,31 @@ export function configure(options) {
         dangle: "always",
         ...options?.stylistic,
     };
-
     return [
-
         // ignore certain files and folders
         ...(options?.ignores?.length ? [{ ignores: options.ignores }] : []),
-
         // module types and standard rules for all JS/TS source files
         ...base(languageOptions),
-
         // default configuration for JavaScript files
         ...js(),
-
         // default configuration for TypeScript files
         ...ts(),
-
         // default configuration for JSON files
         ...json(stylisticOptions),
-
         // default configuration for YAML files
         ...yaml(stylisticOptions),
-
         // check for correct license headers
         ...(options?.license ? license(options.license) : []),
-
         // default configuration for ESLint inline directives
         ...directives(),
-
         // default configuration for imports/exports
         ...imports(languageOptions),
-
         // default configuration for native promises
         ...promises(),
-
         // default configuration for JSDoc
         ...jsdoc(),
-
         // default configuration for code style checks
         ...stylistic(stylisticOptions),
-
         // custom rules
         ...(options?.rules ? [{ rules: options.rules }] : []),
     ];

package/dist/eslint/rules/no-amd-module-directive.d.ts

@@ -0,0 +1,3 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+declare const _default: TSESLint.RuleModule<"UNEXPECTED_DIRECTIVE" | "UNEXPECTED_DIRECTIVE_FIX", [], TSESLint.RuleListener>;
+export default _default;

package/{lib → dist}/eslint/rules/no-amd-module-directive.js

@@ -18,12 +18,9 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  *
  */
-
+import { ESLintUtils } from "@typescript-eslint/utils";
 // exports ====================================================================
-
-/** @type {import("eslint").Rule.RuleModule} */
-export default {
-
+export default ESLintUtils.RuleCreator.withoutDocs({
     meta: {
         type: "problem",
         schema: [],
@@ -34,24 +31,23 @@ export default {
         hasSuggestions: true,
         fixable: "code",
     },
-
-    create(context) {
-
-        return {
-
-            // fail if module contains triple-slash directive "<amd-module>"
-            Program(node) {
-                const amdComment = node.comments.find(comment => /^\/\s*<amd-module/.test(comment.value));
-                if (amdComment) {
-                    const deleteDirective = fixer => fixer.remove(amdComment);
-                    context.report({
-                        messageId: "UNEXPECTED_DIRECTIVE",
-                        node: amdComment,
-                        fix: deleteDirective,
-                        suggest: [{ messageId: "UNEXPECTED_DIRECTIVE_FIX", fix: deleteDirective }],
-                    });
-                }
-            },
-        };
-    },
-};
+    defaultOptions: [],
+    create: context => ({
+        // fail if module contains triple-slash directive "<amd-module>"
+        Program(node) {
+            const amdComment = node.comments?.find(comment => /^\/\s*<amd-module/.test(comment.value));
+            if (amdComment) {
+                const deleteDirective = fixer => fixer.removeRange(amdComment.range);
+                context.report({
+                    messageId: "UNEXPECTED_DIRECTIVE",
+                    loc: amdComment.loc,
+                    fix: deleteDirective,
+                    suggest: [{
+                            messageId: "UNEXPECTED_DIRECTIVE_FIX",
+                            fix: deleteDirective,
+                        }],
+                });
+            }
+        },
+    }),
+});

package/dist/eslint/rules/no-invalid-modules.d.ts

@@ -0,0 +1,38 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export interface RuleNoInvalidModulesPackage {
+    /**
+     * Glob patterns selecting all source files that are part of the package.
+     */
+    src: string | string[];
+    /**
+     * Specifies the names of all packages (keys of the `packages` dictionary)
+     * this package depends on.
+     */
+    extends?: string | string[];
+    /**
+     * Set to `true` to mark an optional package that may be missing in an
+     * installation. Such a package cannot be imported statically (with
+     * `import` statement) from a non-optional package, but can only be loaded
+     * dynamically at runtime (by calling `import()`). The rule will mark all
+     * static imports of optional code as an error. Default value is `false`.
+     */
+    optional?: boolean;
+}
+export interface RuleNoInvalidModulesOptions {
+    /**
+     * Maps all alias prefixes to actual paths in the project.
+     */
+    alias?: Record<string, string>;
+    /**
+     * Specifies glob patterns for external modules.
+     */
+    external?: string | string[];
+    /**
+     * Allows to separate the source files into virtual packages.
+     */
+    packages?: Record<string, RuleNoInvalidModulesPackage>;
+}
+type RuleOptions = [Required<RuleNoInvalidModulesOptions>];
+type RuleMessageIds = "SOURCE_FILE_NOT_FOUND" | "UNEXPECTED_OPTIONAL_STATIC" | "INVALID_PACKAGE_HIERARCHY";
+declare const _default: ESLintUtils.RuleModule<RuleMessageIds, RuleOptions, ESLintUtils.RuleListener>;
+export default _default;