@open-xchange/linter-presets 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## `1.1.0` – 2025-Jan-08
+
+- add: (ESLint) plugin `eslint-plugin-depend`
+- add: (ESLint) config option "packages"
+- remove: (ESLint) plugin `eslint-plugin-import`
+
 ## `1.0.0` – 2025-Jan-03
 
 - chore: bump dependencies

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

@@ -0,0 +1,15 @@
+import type { Linter } from "eslint";
+import type { PackagesConfig } from "../shared/env-utils.js";
+/**
+ * Defines linting rules for outdated or unneeded external dependencies.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-depend`
+ *
+ * @param packagesConfig
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function packages(packagesConfig: PackagesConfig): Linter.Config[];

package/dist/eslint/config/packages.js

@@ -0,0 +1,28 @@
+import dependPlugin from "eslint-plugin-depend";
+// functions ==================================================================
+/**
+ * Defines linting rules for outdated or unneeded external dependencies.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-depend`
+ *
+ * @param packagesConfig
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function packages(packagesConfig) {
+    return [
+        // register rule implementations and recommended rules
+        dependPlugin.configs["flat/recommended"],
+        {
+            rules: {
+                "depend/ban-dependencies": ["error", {
+                        modules: packagesConfig.banned,
+                        allowed: packagesConfig.allowed,
+                    }],
+            },
+        },
+    ];
+}

package/dist/eslint/index.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import type { LanguageOptions, StylisticOptions } from "./shared/env-utils.js";
+import type { LanguageOptions, PackagesOptions, StylisticOptions } from "./shared/env-utils.js";
 import node from "./env/node.js";
 import browser from "./env/browser.js";
 import jest from "./env/jest.js";
@@ -27,6 +27,10 @@ export interface ConfigureOptions {
      * Configuration options for language and project setup.
      */
     language?: LanguageOptions;
+    /**
+     * Configuration options for external package dependencies.
+     */
+    packages?: PackagesOptions;
     /**
      * Configuration options for code style.
      */

package/dist/eslint/index.js

@@ -7,7 +7,7 @@ import yaml from "./config/yaml.js";
 import markdown from "./config/markdown.js";
 import license from "./config/license.js";
 import directives from "./config/directives.js";
-import imports from "./config/imports.js";
+import packages from "./config/packages.js";
 import promises from "./config/promises.js";
 import jsdoc from "./config/jsdoc.js";
 import stylistic from "./config/stylistic.js";
@@ -62,6 +62,12 @@ export function configure(options) {
         nativeDecorators: false,
         ...options?.language,
     };
+    // resolve dependency configuration options
+    const packagesConfig = {
+        allowed: [],
+        banned: [],
+        ...options?.packages,
+    };
     // resolve stylistic configuration options
     const stylisticConfig = {
         semi: "always",
@@ -97,8 +103,8 @@ export function configure(options) {
         ...(options?.license ? license(options.license) : []),
         // default configuration for ESLint inline directives
         ...directives(),
-        // default configuration for imports/exports
-        ...imports(languageConfig),
+        // default configuration for outdated dependencies
+        ...packages(packagesConfig),
         // default configuration for native promises
         ...promises(),
         // default configuration for JSDoc

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

@@ -31,6 +31,21 @@ export interface LanguageOptions {
     nativeDecorators?: boolean;
 }
 export type LanguageConfig = DeepRequired<LanguageOptions>;
+/**
+ * Configuration options for external package dependencies.
+ */
+export interface PackagesOptions {
+    /**
+     * A list of packages to be allowed in the project even if they have been
+     * banned by the plugin `eslint-plugin-depend`.
+     */
+    allowed?: string[];
+    /**
+     * A list of additional packages to be banned in the project.
+     */
+    banned?: string[];
+}
+export type PackagesConfig = DeepRequired<PackagesOptions>;
 /**
  * Configuration options for code indentation.
  */

package/doc/eslint/README.md

@@ -19,7 +19,7 @@ Generates standard configuration targeting the source files in the entire projec
 | Markdown files (`.md`) | [@eslint/markdown](https://github.com/eslint/markdown) |
 | License headers | [eslint-plugin-license-header](https://github.com/nikku/eslint-plugin-license-header) |
 | ESLint inline directives | [@eslint-community/eslint-plugin-eslint-comments](https://github.com/eslint-community/eslint-plugin-eslint-comments) |
-| Module imports | [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) |
+| Outdated dependencies | [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend) |
 | Native ES6 promises | [eslint-plugin-promise](https://github.com/eslint-community/eslint-plugin-promise) |
 | JSDoc source documentation | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) |
 | Source code formatting | [@stylistic/eslint-plugin](https://eslint.style/packages/default) |
@@ -40,6 +40,9 @@ function configure(options?: ConfigureOptions): Linter.Config[]
 | `language.ecmaVersion` | `number\|"latest"` | `latest` | The ECMAScript version to be used in the project (version or year). |
 | `language.sourceType` | `"module"\|"commonjs"` | `"module"` | Specifies how to treat `.js`, `.jsx`, `.ts`, and `.tsx` files. |
 | `language.nativeDecorators` | `boolean` | `false` | Whether to support native ES decorators in JavaScript code (via Babel plugin). Does not affect TypeScript code which uses an own parser aware of the decorator syntax. |
+| `packages` | `PackagesOptions` | | Configuration options for external package dependencies. |
+| `packages.allowed` | `string[]` | `[]` | Banned packages to be allowed in the project. |
+| `packages.banned` | `string[]` | `[]` | Additional packages to be banned in the project. |
 | `stylistic` | `StylisticOptions` | | Configuration options for code style. |
 | `stylistic.indent` | `IndentOptions` | `{}` | Indentation size (number of space characters) per file type. |
 | `stylistic.indent.js` | `number` | `4` | JavaScript and TypeScript files (including `.jsx`, `.tsx`). |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
   "scripts": {
     "prepare": "yarn build",
     "prepack": "yarn build && yarn lint && yarn test",
-    "build": "rimraf dist && tsc",
+    "build": "premove dist && tsc",
     "lint": "eslint .",
     "test": "cd test && eslint ."
   },
@@ -38,8 +38,8 @@
     "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-plugin-chai-expect": "^3.1.0",
     "eslint-plugin-codeceptjs": "^1.3.0",
+    "eslint-plugin-depend": "^0.12.0",
     "eslint-plugin-eslint-plugin": "^6.4.0",
-    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.10.0",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jsdoc": "^50.6.1",
@@ -72,7 +72,6 @@
     "@typescript-eslint/utils": "^8.19.0",
     "eslint": "^9.17.0",
     "jest": "^29.7.0",
-    "rimraf": "^6.0.1",
     "stylelint": "^16.12.0",
     "typescript": "^5.7.2"
   },

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

@@ -1,15 +0,0 @@
-import type { Linter } from "eslint";
-import type { LanguageConfig } from "../shared/env-utils.js";
-/**
- * Adds linter rules for `import` and `export` statements.
- *
- * Wraps the following packages:
- * - `eslint-plugin-import`
- *
- * @param languageConfig
- *  Resolved configuration options.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export default function importConfig(languageConfig: LanguageConfig): Linter.Config[];

package/dist/eslint/config/imports.js

@@ -1,62 +0,0 @@
-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 languageConfig
- *  Resolved configuration options.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export default function importConfig(languageConfig) {
-    // configuration properties
-    const { ecmaVersion, sourceType } = languageConfig;
-    // 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,
-                },
-                "import/resolver": {
-                    typescript: true,
-                    node: true,
-                },
-            },
-            // reconfigure plugin rules
-            rules: {
-                // recommended rules
-                ...importPlugin.flatConfigs.recommended.rules,
-                ...importPlugin.flatConfigs.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",
-            },
-        }];
-}