@open-xchange/linter-presets 0.1.5 → 0.1.6

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.1.6] - 2024-07-23
+
+- changed: [ESLint] moved rule options for `env.project` into own `modules` option
+- chore: [ESLint] unit test for `env.project`
+
 ## [0.1.5] - 2024-07-23
 
 - chore: bump dependencies

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

@@ -13,10 +13,10 @@ export interface EnvBrowserOptions extends EnvRestrictedOptions {
  * - `globals`
  * - `confusing-browser-globals`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function browser(envOptions: EnvBrowserOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/browser.js

@@ -84,26 +84,26 @@ const RESTRICTED_GLOBALS = AMBIGUOUS_BROWSER_TYPES.map(name => {
  * - `globals`
  * - `confusing-browser-globals`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function browser(options) {
+export default function browser(envOptions) {
     return concatConfigs(
     // register global symbols used in browser scripts
-    createConfig(options, {
+    createConfig(envOptions, {
         languageOptions: {
             globals: BROWSER_GLOBALS,
         },
     }), 
     // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRules(options, {
+    restrictedRules(envOptions, {
         globals: RESTRICTED_GLOBALS,
         properties: RESTRICTED_PROPERTIES,
         syntax: RESTRICTED_SYNTAX,
     }), 
     // custom rules
-    customRules(options));
+    customRules(envOptions));
 }

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

@@ -13,10 +13,10 @@ export interface EnvCodeceptOptions extends EnvBaseOptions {
  * - `eslint-plugin-codeceptjs`
  * - `eslint-plugin-chai-expect`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function codecept(envOptions: EnvCodeceptOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/codecept.js

@@ -16,16 +16,16 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  * - `eslint-plugin-codeceptjs`
  * - `eslint-plugin-chai-expect`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function codecept(options) {
+export default function codecept(envOptions) {
     return concatConfigs(
     // "codecept" plugin
-    createConfig(options, {
+    createConfig(envOptions, {
         // register rule implementations of the plugins
         plugins: {
             codeceptjs: codeceptPlugin,
@@ -38,9 +38,9 @@ export default function codecept(options) {
         rules: codeceptPlugin.configs.recommended.rules,
     }), 
     // "chai-expect" plugin
-    createConfig(options, chaiExpectPlugin.configs["recommended-flat"]), 
+    createConfig(envOptions, chaiExpectPlugin.configs["recommended-flat"]), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         "new-cap": ["error", {
                 capIsNewExceptions: ["After", "AfterSuite", "Before", "BeforeSuite", "Feature", "Scenario"],
             }],

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

@@ -11,10 +11,10 @@ export interface EnvEslintOptions extends EnvBaseOptions {
  * Wraps the following packages:
  * - `eslint-plugin-eslint-plugin`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function eslint(envOptions: EnvEslintOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/eslint.js

@@ -7,16 +7,16 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  * Wraps the following packages:
  * - `eslint-plugin-eslint-plugin`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function eslint(options) {
+export default function eslint(envOptions) {
     return concatConfigs(
     // register rule implementations and recommended rules
-    createConfig(options, eslintPlugin.configs["flat/rules-recommended"]), 
+    createConfig(envOptions, eslintPlugin.configs["flat/rules-recommended"]), 
     // custom rules
-    customRules(options));
+    customRules(envOptions));
 }

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

@@ -12,10 +12,10 @@ export interface EnvJestOptions extends EnvBaseOptions {
  * Wraps the following packages:
  * - `eslint-plugin-jest`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function jest(envOptions: EnvJestOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/jest.js

@@ -8,22 +8,22 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  * Wraps the following packages:
  * - `eslint-plugin-jest`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function jest(options) {
+export default function jest(envOptions) {
     return concatConfigs(
     // register rule implementations, globals, and recommended rules
-    createConfig(options, jestPlugin.configs["flat/recommended"]), 
+    createConfig(envOptions, jestPlugin.configs["flat/recommended"]), 
     // add recommended stylistic rules
-    createConfig(options, {
+    createConfig(envOptions, {
         rules: jestPlugin.configs["flat/style"].rules,
     }), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         "jest/consistent-test-it": ["error", { fn: "it" }],
         "jest/no-commented-out-tests": "error",
         "jest/no-conditional-expect": "off",

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

@@ -16,10 +16,10 @@ export interface EnvNodeOptions extends EnvRestrictedOptions {
  * Wraps the following packages:
  * - `eslint-plugin-n`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function node(envOptions: EnvNodeOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/node.js

@@ -8,18 +8,18 @@ import { concatConfigs, createConfig, restrictedRules, customRules } from "../sh
  * Wraps the following packages:
  * - `eslint-plugin-n`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function node(options) {
+export default function node(envOptions) {
     // the plugin configuration key, according to source module type
-    const configKey = (options.sourceType === "commonjs") ? "flat/recommended-script" : "flat/recommended-module";
+    const configKey = (envOptions.sourceType === "commonjs") ? "flat/recommended-script" : "flat/recommended-module";
     return concatConfigs(
     // register rule implementations
-    createConfig(options, {
+    createConfig(envOptions, {
         ...nodePlugin.configs[configKey],
         settings: {
             node: {
@@ -28,9 +28,9 @@ export default function node(options) {
         },
     }), 
     // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRules(options), 
+    restrictedRules(envOptions), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
         "n/prefer-node-protocol": "error",
     }));

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

@@ -4,15 +4,19 @@ import { type RuleNoInvalidModulesOptions } from "../rules/no-invalid-modules.js
 /**
  * Configuration options for the environment preset "env.project".
  */
-export interface EnvProjectOptions extends EnvBaseOptions, RuleNoInvalidModulesOptions {
+export interface EnvProjectOptions extends EnvBaseOptions {
+    /**
+     * Options to be passed to the rule "env-project/no-invalid-modules".
+     */
+    modules?: RuleNoInvalidModulesOptions;
 }
 /**
  * Adds custom linter rules for checking project setup and module hierarchy.
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function project(envOptions: EnvProjectOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/project.js

@@ -5,16 +5,16 @@ import noInvalidModules from "../rules/no-invalid-modules.js";
 /**
  * Adds custom linter rules for checking project setup and module hierarchy.
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function project(options) {
+export default function project(envOptions) {
     return concatConfigs(
     // register rule implementations
-    createConfig(options, {
+    createConfig(envOptions, {
         plugins: {
             "env-project": {
                 rules: {
@@ -25,8 +25,8 @@ export default function project(options) {
         },
     }), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         "env-project/no-amd-module-directive": "error",
-        "env-project/no-invalid-modules": ["error", options],
+        "env-project/no-invalid-modules": ["error", envOptions.modules ?? {}],
     }));
 }

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

@@ -20,10 +20,10 @@ export interface EnvReactOptions extends EnvBaseOptions {
  * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function react(envOptions: EnvReactOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/react.js

@@ -18,16 +18,16 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function react(options) {
+export default function react(envOptions) {
     return concatConfigs(
     // configure "react" plugin for all source files (JSX and TSX)
-    createConfig(options, {
+    createConfig(envOptions, {
         // auto-detect installed React version
         settings: {
             react: {
@@ -43,7 +43,7 @@ export default function react(options) {
         },
     }), 
     // configure other plugins and rules for all source files (JSX and TSX)
-    createConfig(options, {
+    createConfig(envOptions, {
         // register rule implementations of the plugins
         plugins: {
             "react-hooks": reactHooksPlugin,
@@ -58,17 +58,17 @@ export default function react(options) {
         },
     }), 
     // "react-hooks-static-deps" plugin
-    options.staticHooks && createConfig(options, {
+    envOptions.staticHooks && createConfig(envOptions, {
         plugins: {
             "react-hooks-static-deps": fixupPluginRules(reactHooksStaticDepsPlugin), // https://github.com/stoikio/eslint-plugin-react-hooks-static-deps/issues/1
         },
         rules: {
             "react-hooks/exhaustive-deps": "off",
-            "react-hooks-static-deps/exhaustive-deps": ["error", { staticHooks: options.staticHooks }],
+            "react-hooks-static-deps/exhaustive-deps": ["error", { staticHooks: envOptions.staticHooks }],
         },
     }), 
     // additional rules for TSX only
-    createConfig(options, {
+    createConfig(envOptions, {
         ignores: ["**/*.{js,jsx}"],
         rules: {
             // replace "react/jsx-no-leaked-render" rule with advanced alternative
@@ -76,7 +76,7 @@ export default function react(options) {
         },
     }), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         // "react" plugin
         "react/hook-use-state": "error",
         "react/iframe-missing-sandbox": "error",

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

@@ -12,10 +12,10 @@ export interface EnvTSConfigOptions extends EnvBaseOptions {
 /**
  * Creates configuration objects for TypeScript projects.
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function tsconfig(envOptions: EnvTSConfigOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/tsconfig.js

@@ -3,22 +3,22 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
 /**
  * Creates configuration objects for TypeScript projects.
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function tsconfig(options) {
+export default function tsconfig(envOptions) {
     return concatConfigs(
     // path to project configuration file
-    createConfig(options, {
+    createConfig(envOptions, {
         languageOptions: {
             parserOptions: {
-                project: options.project,
+                project: envOptions.project,
             },
         },
     }), 
     // custom rules
-    customRules(options));
+    customRules(envOptions));
 }

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

@@ -14,10 +14,10 @@ export interface EnvVitestOptions extends EnvBaseOptions {
  * - `eslint-plugin-jest-dom`
  * - `eslint-plugin-testing-library`
  *
- * @param options
+ * @param envOptions
  *  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;
+export default function vitest(envOptions: EnvVitestOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/vitest.js

@@ -13,16 +13,16 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  * - `eslint-plugin-jest-dom`
  * - `eslint-plugin-testing-library`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function vitest(options) {
+export default function vitest(envOptions) {
     return concatConfigs(
     // "vitest" plugin
-    createConfig(options, {
+    createConfig(envOptions, {
         // register rule implementations of the plugins
         plugins: {
             vitest: vitestPlugin,
@@ -35,9 +35,9 @@ export default function vitest(options) {
         rules: vitestPlugin.configs.recommended.rules,
     }), 
     // "jest-dom" plugin
-    createConfig(options, jestDomPlugin.configs["flat/recommended"]), 
+    createConfig(envOptions, jestDomPlugin.configs["flat/recommended"]), 
     // "testing-library" plugin
-    createConfig(options, {
+    createConfig(envOptions, {
         // register rule implementations of the plugins
         plugins: {
             "testing-library": fixupPluginRules(testingLibraryPlugin), // https://github.com/testing-library/eslint-plugin-testing-library/issues/899
@@ -46,7 +46,7 @@ export default function vitest(options) {
         rules: testingLibraryPlugin.configs.react.rules,
     }), 
     // custom rules
-    customRules(options, {
+    customRules(envOptions, {
         // "vitest" plugin
         "vitest/consistent-test-it": "error",
         "vitest/no-alias-methods": "error",

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

@@ -1,6 +1,6 @@
 import { createRequire } from "node:module";
 import { posix, dirname, extname } from "node:path";
-import { packageUpSync } from "package-up";
+import { findUpSync } from "find-up";
 import { AST_NODE_TYPES as NodeType, ESLintUtils } from "@typescript-eslint/utils";
 import { Schema, makeArray, toPosixPath, isFile, matchModuleName, getModuleName } from "../shared/rule-utils.js";
 // constants ==================================================================
@@ -47,8 +47,8 @@ export default ESLintUtils.RuleCreator.withoutDocs({
         // collect all globs for package members
         const packagesGlobs = Array.from(packagesMap.values(), settings => settings.src).flat();
         // resolve file name
-        const packagePath = packageUpSync();
-        const rootDir = packagePath && toPosixPath(dirname(packagePath));
+        const configPath = findUpSync("eslint.config.js");
+        const rootDir = configPath && toPosixPath(dirname(configPath));
         const fileName = toPosixPath(context.filename);
         if (!rootDir || !fileName.startsWith(rootDir + "/")) {
             throw new Error("invalid root directory");
@@ -86,7 +86,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
             return FILE_EXTENSIONS.some(ext => isFile(resolvedPath + "." + ext));
         };
         // returns whether the passed module name is an installed NPM package
-        const requireModule = createRequire(packagePath);
+        const requireModule = createRequire(configPath);
         const packageExists = (moduleName) => {
             try {
                 requireModule.resolve(moduleName);
@@ -110,7 +110,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
                 // extract alias key, replace with alias path
                 const [aliasKey, modulePath] = resolveAlias(moduleName);
                 // whether the import is a known external module
-                const isExternal = !aliasKey && matchModuleName(moduleName, options.external);
+                const isExternal = matchModuleName(moduleName, options.external);
                 // whether the import is an installed NPM package
                 const isPackage = !isExternal && !aliasKey && packageExists(moduleName);
                 // check existence of source file

package/dist/eslint/shared/env-utils.d.ts

@@ -181,24 +181,23 @@ export declare const NO_UNUSED_VARS_OPTIONS: {
 export declare const concatConfigs: (...entries: (TSESLint.FlatConfig.Config | TSESLint.FlatConfig.Config[] | undefined)[]) => TSESLint.FlatConfig.Config[];
 /**
  * Creates a flat configuration object with "files" and "ignores" settings from
- * an environment's "options" object.
+ * an environment's "envOptions" object.
  *
- * @param options
+ * @param envOptions
  *  The environment options containing "files" and "ignores" settings.
  *
- * @param config
- *  The remaining properties of the flat configuration to be built. Additional
- *  "files" and "ignores" properties will be merged with the settings from
- *  "options".
+ * @param flatConfig
+ *  Properties for the flat configuration to be built. Additional "files" and
+ *  "ignores" properties will be merged with the settings from "envOptions".
  *
  * @returns
  *  The resulting flat configuration object.
  */
-export declare function createConfig(options: EnvFilesOptions, config: TSESLint.FlatConfig.Config): TSESLint.FlatConfig.Config;
+export declare function createConfig(envOptions: EnvFilesOptions, flatConfig: TSESLint.FlatConfig.Config): TSESLint.FlatConfig.Config;
 /**
  * Generates various "no-restricted-?" rules from the passed configuration.
  *
- * @param options
+ * @param envOptions
  *  The environment options containing "files", "ignores", and "restricted"
  *  settings.
  *
@@ -208,21 +207,22 @@ export declare function createConfig(options: EnvFilesOptions, config: TSESLint.
  * @returns
  *  The flat configuration objects needed to forbid the restricted items.
  */
-export declare function restrictedRules(options: EnvRestrictedOptions, fixed?: EnvRestrictedItems): TSESLint.FlatConfig.ConfigArray;
+export declare function restrictedRules(envOptions: EnvRestrictedOptions, fixed?: EnvRestrictedItems): TSESLint.FlatConfig.ConfigArray;
 /**
- * Creates a flat configuration object with `files`, `ignores`, and `rules`
- * settings from an environment's `options` object.
+ * Creates a flat configuration object with "files", "ignores", and "rules"
+ * settings from an environment's "envOptions" object.
  *
- * @param options
- *  The environment options containing `files`,`ignores`, and `rules` settings.
+ * @param envOptions
+ *  The environment options containing "files", "ignores", and "rules"
+ *  settings.
  *
  * @param rules
  *  Hard-coded rule settings to be configured by the environment itself. These
- *  rule settings will precede the rules contained in "options", in order to
+ *  rule settings will precede the rules contained in "envOptions", in order to
  *  allow to override them.
  *
  * @returns
  *  The resulting flat configuration object, if the environment options contain
  *  custom rule settings, otherwise `undefined`.
  */
-export declare function customRules(options: EnvBaseOptions, rules?: TSESLint.FlatConfig.Rules): TSESLint.FlatConfig.Config | undefined;
+export declare function customRules(envOptions: EnvBaseOptions, rules?: TSESLint.FlatConfig.Rules): TSESLint.FlatConfig.Config | undefined;

package/dist/eslint/shared/env-utils.js

@@ -62,30 +62,29 @@ function createRulesRecord(generator) {
 export const concatConfigs = (flatten);
 /**
  * Creates a flat configuration object with "files" and "ignores" settings from
- * an environment's "options" object.
+ * an environment's "envOptions" object.
  *
- * @param options
+ * @param envOptions
  *  The environment options containing "files" and "ignores" settings.
  *
- * @param config
- *  The remaining properties of the flat configuration to be built. Additional
- *  "files" and "ignores" properties will be merged with the settings from
- *  "options".
+ * @param flatConfig
+ *  Properties for the flat configuration to be built. Additional "files" and
+ *  "ignores" properties will be merged with the settings from "envOptions".
  *
  * @returns
  *  The resulting flat configuration object.
  */
-export function createConfig(options, config) {
+export function createConfig(envOptions, flatConfig) {
     return {
-        ...config,
-        files: flatten(options.files, config.files),
-        ignores: flatten(options.ignores, config.ignores),
+        ...flatConfig,
+        files: flatten(envOptions.files, flatConfig.files),
+        ignores: flatten(envOptions.ignores, flatConfig.ignores),
     };
 }
 /**
  * Generates various "no-restricted-?" rules from the passed configuration.
  *
- * @param options
+ * @param envOptions
  *  The environment options containing "files", "ignores", and "restricted"
  *  settings.
  *
@@ -95,8 +94,8 @@ export function createConfig(options, config) {
  * @returns
  *  The flat configuration objects needed to forbid the restricted items.
  */
-export function restrictedRules(options, fixed) {
-    const { restricted = {} } = options;
+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." },
@@ -116,7 +115,7 @@ export function restrictedRules(options, fixed) {
     // generate the configuration objects
     return concatConfigs(
     // base rules for all files in the environment
-    createConfig(options, {
+    createConfig(envOptions, {
         rules: createRulesRecord(key => items[key]),
     }), 
     // generate the override entries (join with base items)
@@ -125,23 +124,24 @@ export function restrictedRules(options, fixed) {
     })));
 }
 /**
- * Creates a flat configuration object with `files`, `ignores`, and `rules`
- * settings from an environment's `options` object.
+ * Creates a flat configuration object with "files", "ignores", and "rules"
+ * settings from an environment's "envOptions" object.
  *
- * @param options
- *  The environment options containing `files`,`ignores`, and `rules` settings.
+ * @param envOptions
+ *  The environment options containing "files", "ignores", and "rules"
+ *  settings.
  *
  * @param rules
  *  Hard-coded rule settings to be configured by the environment itself. These
- *  rule settings will precede the rules contained in "options", in order to
+ *  rule settings will precede the rules contained in "envOptions", in order to
  *  allow to override them.
  *
  * @returns
  *  The resulting flat configuration object, if the environment options contain
  *  custom rule settings, otherwise `undefined`.
  */
-export function customRules(options, rules) {
-    return (rules || options.rules) && createConfig(options, {
-        rules: { ...rules, ...options.rules },
+export function customRules(envOptions, rules) {
+    return (rules || envOptions.rules) && createConfig(envOptions, {
+        rules: { ...rules, ...envOptions.rules },
     });
 }

package/doc/eslint/env/project.md

@@ -20,9 +20,10 @@ function project(options: EnvProjectOptions): Linter.FlatConfig[]
 | - | - | - | - |
 | `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
 | `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
-| `alias` | `Record<string, string>` | `{}` | Maps all alias prefixes to actual paths in the project (see below). |
-| `external` | `string \| string[]` | `[]` | Specifies glob patterns for external modules (see below). |
-| `packages` | `Record<string, EnvProjectPackage>` | `{}` | Allows to separate the source files into virtual packages (see below). |
+| `modules` | `RuleNoInvalidModulesOptions` | `{}` | Configuration for the rule "env-project/no-invalid-modules": |
+| `modules.alias` | `Record<string, string>` | `{}` | Maps all alias prefixes to actual paths in the project (see below). |
+| `modules.external` | `string \| string[]` | `[]` | Specifies glob patterns for external modules (see below). |
+| `modules.packages` | `Record<string, EnvProjectPackage>` | `{}` | Allows to separate the source files into virtual packages (see below). |
 | `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
 
 ### Option `alias`
@@ -42,8 +43,10 @@ export default [
   ...eslint.configure({ /* ... */ }),
   ...eslint.env.project({
     files: ["src/**/*.{js,ts}"],
-    alias: {
+    modules: {
+      alias: {
         "@": "src",
+      },
     },
   }),
 ]
@@ -69,8 +72,10 @@ export default [
   ...eslint.configure({ /* ... */ }),
   ...eslint.env.project({
     files: ["src/**/*.{js,ts}"],
-    alias: { "@": "src" },
-    external: ["virtual:*", "@/special/lib/**/*.js"],
+    modules: {
+      alias: { "@": "src" },
+      external: ["virtual:*", "@/special/lib/**/*.js"],
+    },
   }),
 ]
 ```
@@ -105,19 +110,21 @@ export default [
   ...eslint.configure({ /* ... */ }),
   ...eslint.env.project({
     files: ["src/**/*.{js,ts}"],
-    alias: { "@": "src" },
-    packages: {
-      base: {
-        src: ["@/base/**/*", "@/tools/**/*"],
-      },
-      debug: {
-        src: "@/debug/**/*",
-        extends: "base",
-        optional: true,
-      },
-      special: {
-        src: "@/my/special/**/*",
-        extends: ["base", "debug"],
+    modules: {
+      alias: { "@": "src" },
+      packages: {
+        base: {
+          src: ["@/base/**/*", "@/tools/**/*"],
+        },
+        debug: {
+          src: "@/debug/**/*",
+          extends: "base",
+          optional: true,
+        },
+        special: {
+          src: "@/my/special/**/*",
+          extends: ["base", "debug"],
+        },
       },
     },
   }),

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://json.schemastore.org/package",
     "name": "@open-xchange/linter-presets",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -15,9 +15,10 @@
     "exports": "./dist/index.js",
     "scripts": {
         "prepare": "husky",
-        "prepack": "yarn lint && yarn build",
+        "prepack": "yarn build && yarn lint && yarn test",
         "build": "npx --yes rimraf dist && tsc",
-        "lint": "eslint ."
+        "lint": "eslint .",
+        "test": "cd test && eslint ."
     },
     "lint-staged": {
         "*.{js,ts,json}": "yarn lint"
@@ -54,8 +55,8 @@
         "eslint-plugin-testing-library": "6.2.2",
         "eslint-plugin-vitest": "0.5.4",
         "eslint-plugin-yml": "1.14.0",
+        "find-up": "7.0.0",
         "globals": "15.8.0",
-        "package-up": "5.0.0",
         "picomatch": "4.0.2",
         "stylelint-config-standard": "36.0.1",
         "stylelint-config-standard-less": "3.0.1",

package/test/src/project1/file1.js

@@ -0,0 +1,26 @@
+
+// eslint-disable-next-line env-project/no-amd-module-directive
+/// <amd-module name="file1"/>
+
+// valid imports
+import "find-up";
+import "$/external/module";
+import "@/project1/generated";
+
+// eslint-disable-next-line env-project/no-invalid-modules
+import "invalid-package";
+// eslint-disable-next-line env-project/no-invalid-modules
+import "@/project1/invalid";
+// eslint-disable-next-line env-project/no-invalid-modules
+import "@/project2/file2";
+// eslint-disable-next-line env-project/no-invalid-modules
+import "@/project3/file3";
+
+await import("find-up");
+await import("@/project1/generated");
+await import("@/project3/file3");
+
+// eslint-disable-next-line env-project/no-invalid-modules
+await import("invalid-package");
+// eslint-disable-next-line env-project/no-invalid-modules
+await import("@/project2/file2");

package/test/src/project2/file2.js

@@ -0,0 +1,2 @@
+
+import "@/project1/file1";

package/test/src/project3/file3.js

@@ -0,0 +1,3 @@
+
+import "@/project1/file1";
+import "@/project2/file2";