@open-xchange/linter-presets 0.1.4 → 0.1.6

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.4",
+    "version": "0.1.6",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -15,15 +15,16 @@
     "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"
     },
     "dependencies": {
-        "@babel/core": "7.24.8",
+        "@babel/core": "7.24.9",
         "@babel/eslint-parser": "7.24.8",
         "@babel/plugin-proposal-decorators": "7.24.7",
         "@eslint-community/eslint-plugin-eslint-comments": "4.3.0",
@@ -40,39 +41,39 @@
         "eslint-plugin-import": "2.29.1",
         "eslint-plugin-jest": "28.6.0",
         "eslint-plugin-jest-dom": "5.4.0",
-        "eslint-plugin-jsdoc": "48.7.0",
+        "eslint-plugin-jsdoc": "48.8.3",
         "eslint-plugin-jsonc": "2.16.0",
         "eslint-plugin-jsx-a11y": "6.9.0",
         "eslint-plugin-jsx-expressions": "1.3.2",
         "eslint-plugin-license-header": "0.6.1",
         "eslint-plugin-n": "17.9.0",
-        "eslint-plugin-promise": "6.4.0",
-        "eslint-plugin-react": "7.34.4",
+        "eslint-plugin-promise": "6.6.0",
+        "eslint-plugin-react": "7.35.0",
         "eslint-plugin-react-hooks": "4.6.2",
         "eslint-plugin-react-hooks-static-deps": "1.0.7",
-        "eslint-plugin-react-refresh": "0.4.8",
+        "eslint-plugin-react-refresh": "0.4.9",
         "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",
         "stylelint-config-standard-scss": "13.1.0",
         "stylelint-plugin-license-header": "1.0.3",
-        "typescript-eslint": "7.16.0"
+        "typescript-eslint": "7.17.0"
     },
     "devDependencies": {
         "@types/confusing-browser-globals": "1.0.3",
         "@types/eslint__js": "8.42.3",
         "@types/picomatch": "3.0.0",
-        "@typescript-eslint/utils": "7.16.0",
+        "@typescript-eslint/utils": "7.17.0",
         "eslint": "9.7.0",
-        "husky": "9.0.11",
+        "husky": "9.1.1",
         "jest": "29.7.0",
         "stylelint": "16.7.0",
-        "typescript": "5.5.3"
+        "typescript": "5.5.4"
     },
     "peerDependencies": {
         "eslint": "^9.6",

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";