@abinnovision/eslint-config-base 1.2.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.1.0](https://github.com/abinnovision/js-commons/compare/eslint-config-base-v2.0.0...eslint-config-base-v2.1.0) (2024-08-05)
+
+
+### Features
+
+* migrate to esm ([#278](https://github.com/abinnovision/js-commons/issues/278)) ([fed850d](https://github.com/abinnovision/js-commons/commit/fed850d979f7ba83fae75adadcfd0024f2acd242))
+
+
+### Bug Fixes
+
+* wrap eslint-plugin-import with compat package ([#280](https://github.com/abinnovision/js-commons/issues/280)) ([2f61aca](https://github.com/abinnovision/js-commons/commit/2f61aca45ccfb248868815906d87d4be6656dcf5))
+
+## [2.0.0](https://github.com/abinnovision/js-commons/compare/eslint-config-base-v1.2.0...eslint-config-base-v2.0.0) (2023-11-03)
+
+
+### ⚠ BREAKING CHANGES
+
+* will drop support for legacy eslint configs
+
+### Features
+
+* enable new ESLint rules ([#104](https://github.com/abinnovision/js-commons/issues/104)) ([ffac1dc](https://github.com/abinnovision/js-commons/commit/ffac1dc4bc2c6794c2f7d1bd1ec72542e20cd06d))
+* migrate to eslint flat config ([#93](https://github.com/abinnovision/js-commons/issues/93)) ([7568ba1](https://github.com/abinnovision/js-commons/commit/7568ba1782f912357e18619ab3e4e56a0c738a1c))
+
 ## [1.2.0](https://github.com/abinnovision/js-commons/compare/eslint-config-base-v1.1.0...eslint-config-base-v1.2.0) (2023-10-28)
 
 

package/README.md

@@ -1,23 +1,13 @@
 # @abinnovision/eslint-config-base
 
 Base ESLint config, which can be used with Javascript only if applied
-standalone. This config is based on
+standalone.
+This config is based on
 the [AlloyTeam ESLint Config](https://github.com/AlloyTeam/eslint-config-alloy)
 with some additional goodies on top.
 
 ## Installation
 
 ```shell
-yarn add --dev \
-	# This config itself.
-	@abinnovision/eslint-config-base \
-	# Required configs/plugins by this config.
-	eslint eslint-plugin-import
+yarn add --dev @abinnovision/eslint-config-base
 ```
-
-## Dependencies
-
-This config requires the following dependencies (defined as peer dependencies):
-
-- [eslint](https://www.npmjs.com/package/eslint)
-- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)

package/dist/index.cjs

@@ -0,0 +1,111 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_compat = require("@eslint/compat");
+var import_base = __toESM(require("eslint-config-alloy/base.js"), 1);
+var import_eslint_plugin_import = __toESM(require("eslint-plugin-import"), 1);
+var config = [
+  {
+    files: ["**/*.{ts,tsx,js,jsx}"],
+    languageOptions: {
+      ecmaVersion: "latest"
+    },
+    plugins: {
+      /**
+       * eslint-plugin-import is not yet compatible with ESLint v9.
+       * This is a temporary fix to make it compatible in the meantime.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/issues/2948
+       */
+      import: (0, import_compat.fixupPluginRules)(import_eslint_plugin_import.default)
+    },
+    rules: {
+      /**
+       * Use the rules from the base config as defaults.
+       *
+       * @see https://alloyteam.github.io/eslint-config-alloy/?hideOff=1
+       */
+      ...import_base.default.rules ?? {},
+      /**
+       * Enforce a consistent order and grouping of import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+       */
+      "import/order": [
+        "error",
+        {
+          groups: [
+            // Externals
+            ["builtin", "external"],
+            // Internals
+            ["internal", "unknown", "parent", "sibling", "index"],
+            // Types
+            ["object", "type"]
+          ],
+          "newlines-between": "always",
+          alphabetize: { order: "asc", caseInsensitive: true },
+          warnOnUnassignedImports: true
+        }
+      ],
+      /**
+       * Enforce the "export" statement is placed at the end of the file.
+       * This avoids sprinkling export statements throughout the file.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
+       */
+      "import/exports-last": "warn",
+      /**
+       * Import statements should always be the first statements in a file.
+       * This makes it easier to identify the dependencies of a file.
+       *
+       * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+       */
+      "import/first": "error",
+      /**
+       * Enforce a newline after the import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+       */
+      "import/newline-after-import": "error",
+      /**
+       * Disable the "no-return-await" rule.
+       */
+      "no-return-await": "off"
+    }
+  }
+];
+var src_default = config;

package/dist/index.d.cts

@@ -0,0 +1,61 @@
+import * as eslint from 'eslint';
+
+declare const config: {
+    files: string[];
+    languageOptions: {
+        ecmaVersion: "latest";
+    };
+    plugins: {
+        /**
+         * eslint-plugin-import is not yet compatible with ESLint v9.
+         * This is a temporary fix to make it compatible in the meantime.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/issues/2948
+         */
+        import: eslint.ESLint.Plugin;
+    };
+    rules: {
+        /**
+         * Enforce a consistent order and grouping of import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+         */
+        "import/order": ["error", {
+            groups: string[][];
+            "newlines-between": string;
+            alphabetize: {
+                order: string;
+                caseInsensitive: boolean;
+            };
+            warnOnUnassignedImports: boolean;
+        }];
+        /**
+         * Enforce the "export" statement is placed at the end of the file.
+         * This avoids sprinkling export statements throughout the file.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
+         */
+        "import/exports-last": "warn";
+        /**
+         * Import statements should always be the first statements in a file.
+         * This makes it easier to identify the dependencies of a file.
+         *
+         * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+         */
+        "import/first": "error";
+        /**
+         * Enforce a newline after the import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+         */
+        "import/newline-after-import": "error";
+        /**
+         * Disable the "no-return-await" rule.
+         */
+        "no-return-await": "off";
+    };
+}[];
+
+export { config as default };

package/dist/index.d.ts

@@ -1,4 +1,61 @@
-import type { Linter } from "eslint";
-import type { ESLintRules } from "eslint/rules";
-declare const config: Linter.BaseConfig<ESLintRules>;
-export = config;
+import * as eslint from 'eslint';
+
+declare const config: {
+    files: string[];
+    languageOptions: {
+        ecmaVersion: "latest";
+    };
+    plugins: {
+        /**
+         * eslint-plugin-import is not yet compatible with ESLint v9.
+         * This is a temporary fix to make it compatible in the meantime.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/issues/2948
+         */
+        import: eslint.ESLint.Plugin;
+    };
+    rules: {
+        /**
+         * Enforce a consistent order and grouping of import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+         */
+        "import/order": ["error", {
+            groups: string[][];
+            "newlines-between": string;
+            alphabetize: {
+                order: string;
+                caseInsensitive: boolean;
+            };
+            warnOnUnassignedImports: boolean;
+        }];
+        /**
+         * Enforce the "export" statement is placed at the end of the file.
+         * This avoids sprinkling export statements throughout the file.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
+         */
+        "import/exports-last": "warn";
+        /**
+         * Import statements should always be the first statements in a file.
+         * This makes it easier to identify the dependencies of a file.
+         *
+         * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+         */
+        "import/first": "error";
+        /**
+         * Enforce a newline after the import statements.
+         *
+         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+         */
+        "import/newline-after-import": "error";
+        /**
+         * Disable the "no-return-await" rule.
+         */
+        "no-return-await": "off";
+    };
+}[];
+
+export { config as default };

package/dist/index.js

@@ -1,40 +1,80 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var _a;
-var AlloyBase = require("eslint-config-alloy/base");
-var config = {
-    parserOptions: {
-        ecmaVersion: "latest",
+// src/index.ts
+import { fixupPluginRules } from "@eslint/compat";
+import AlloyBase from "eslint-config-alloy/base.js";
+import eslintPluginImport from "eslint-plugin-import";
+var config = [
+  {
+    files: ["**/*.{ts,tsx,js,jsx}"],
+    languageOptions: {
+      ecmaVersion: "latest"
     },
-    env: {
-        browser: true,
-        node: true,
-        commonjs: true,
-        es6: true,
+    plugins: {
+      /**
+       * eslint-plugin-import is not yet compatible with ESLint v9.
+       * This is a temporary fix to make it compatible in the meantime.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/issues/2948
+       */
+      import: fixupPluginRules(eslintPluginImport)
     },
-    plugins: ["import"],
-    rules: __assign(__assign({}, ((_a = AlloyBase.rules) !== null && _a !== void 0 ? _a : {})), { "import/order": [
-            "error",
-            {
-                groups: [
-                    ["builtin", "external"],
-                    ["internal", "unknown", "parent", "sibling", "index"],
-                    ["object", "type"],
-                ],
-                "newlines-between": "always",
-                alphabetize: { order: "asc", caseInsensitive: true },
-                warnOnUnassignedImports: true,
-            },
-        ] }),
+    rules: {
+      /**
+       * Use the rules from the base config as defaults.
+       *
+       * @see https://alloyteam.github.io/eslint-config-alloy/?hideOff=1
+       */
+      ...AlloyBase.rules ?? {},
+      /**
+       * Enforce a consistent order and grouping of import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+       */
+      "import/order": [
+        "error",
+        {
+          groups: [
+            // Externals
+            ["builtin", "external"],
+            // Internals
+            ["internal", "unknown", "parent", "sibling", "index"],
+            // Types
+            ["object", "type"]
+          ],
+          "newlines-between": "always",
+          alphabetize: { order: "asc", caseInsensitive: true },
+          warnOnUnassignedImports: true
+        }
+      ],
+      /**
+       * Enforce the "export" statement is placed at the end of the file.
+       * This avoids sprinkling export statements throughout the file.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
+       */
+      "import/exports-last": "warn",
+      /**
+       * Import statements should always be the first statements in a file.
+       * This makes it easier to identify the dependencies of a file.
+       *
+       * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+       */
+      "import/first": "error",
+      /**
+       * Enforce a newline after the import statements.
+       *
+       * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+       */
+      "import/newline-after-import": "error",
+      /**
+       * Disable the "no-return-await" rule.
+       */
+      "no-return-await": "off"
+    }
+  }
+];
+var src_default = config;
+export {
+  src_default as default
 };
-module.exports = config;

package/package.json

@@ -1,63 +1,61 @@
 {
   "name": "@abinnovision/eslint-config-base",
-  "packageManager": "yarn@3.4.1",
-  "version": "1.2.0",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "2.1.0",
+  "type": "module",
+  "repository": {
+    "url": "https://github.com/abinnovision/js-commons"
+  },
   "license": "Apache-2.0",
   "author": {
-    "name": "AB INNOVISION UG (limited liability)",
+    "name": "AB INNOVISION GmbH",
     "email": "info@abinnovision.com",
     "url": "https://abinnovision.com/"
   },
-  "repository": {
-    "url": "https://github.com/abinnovision/js-commons"
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
   },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist/"
   ],
   "scripts": {
-    "build": "tsc",
-    "lint:check": "eslint 'src/**/*.{ts,js}'",
-    "lint:fix": "eslint --fix 'src/**/*.{ts,js}'",
+    "build": "tsup src/index.ts --dts --format esm,cjs --clean",
     "format:check": "prettier --check 'src/**/*.{ts,js}' '**/*.{md,json,json5,yaml,yml}'",
-    "format:fix": "prettier --write 'src/**/*.{ts,js}' '**/*.{md,json,json5,yaml,yml}'"
-  },
-  "dependencies": {
-    "eslint-config-alloy": "^5.1.2"
-  },
-  "devDependencies": {
-    "@abinnovision/eslint-config-typescript": "^1.2.0",
-    "@abinnovision/prettier-config": "^1.1.0",
-    "@types/eslint": "^8.21.1",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
-    "eslint": "^8.52.0",
-    "eslint-plugin-import": "^2.29.0",
-    "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
-  },
-  "eslintConfig": {
-    "extends": [
-      "./dist/index.js",
-      "@abinnovision/eslint-config-typescript"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    }
-  },
-  "peerDependencies": {
-    "eslint": "^8.24.0",
-    "eslint-plugin-import": "^2.0.0"
+    "format:fix": "prettier --write 'src/**/*.{ts,js}' '**/*.{md,json,json5,yaml,yml}'",
+    "lint:check": "eslint 'src/**/*.{ts,js}'",
+    "lint:fix": "eslint --fix 'src/**/*.{ts,js}'"
   },
-  "prettier": "@abinnovision/prettier-config",
   "lint-staged": {
     "src/**/*.{ts,js}": [
       "prettier --write",
       "eslint --fix"
     ],
-    "**/*.{md,json,json5,yaml,yml}": [
+    "{**/*,*}.{md,json,json5,yaml,yml}": [
       "prettier --write"
     ]
-  }
+  },
+  "prettier": "@abinnovision/prettier-config",
+  "dependencies": {
+    "@eslint/compat": "^1.1.1",
+    "eslint-config-alloy": "^5.1.2",
+    "eslint-plugin-import": "^2.29.1"
+  },
+  "devDependencies": {
+    "@abinnovision/prettier-config": "^2.1.0",
+    "@types/eslint": "^9.6.0",
+    "eslint": "^9.8.0",
+    "globals": "^15.9.0",
+    "prettier": "^3.3.3",
+    "tsup": "^8.2.4"
+  },
+  "peerDependencies": {
+    "eslint": "^8.24.0 || ^9.0.0"
+  },
+  "packageManager": "yarn@3.4.1"
 }