@abinnovision/eslint-config-typescript 1.2.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [2.0.0](https://github.com/abinnovision/js-commons/compare/eslint-config-typescript-v1.2.0...eslint-config-typescript-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-typescript-v1.1.0...eslint-config-typescript-v1.2.0) (2023-10-28)
 
 

package/README.md

@@ -10,17 +10,5 @@ with some additional goodies on top.
 ## Installation
 
 ```shell
-yarn add --dev \
-	# This config itself.
-	@abinnovision/eslint-config-typescript \
-	# Required configs/plugins by this config.
-	eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser
+yarn add --dev @abinnovision/eslint-config-typescript
 ```
-
-## Dependencies
-
-This config requires the following dependencies (defined as peer dependencies):
-
-- [eslint](https://www.npmjs.com/package/eslint)
-- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
-- [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser)

package/dist/index.d.mts

@@ -0,0 +1,32 @@
+import * as _typescript_eslint_eslint_plugin_rules from '@typescript-eslint/eslint-plugin/rules';
+
+declare const config: {
+    files: string[];
+    plugins: {
+        "@typescript-eslint": {
+            configs: Record<string, TSESLint.Linter.Config>;
+            rules: _typescript_eslint_eslint_plugin_rules.TypeScriptESLintRules;
+        };
+    };
+    languageOptions: {
+        parser: any;
+        parserOptions: {
+            project: string;
+        };
+    };
+    rules: {
+        /**
+         * Enforce to use `return await` for async functions.
+         * This rule is set to "always" because it's a good practice to use
+         * `return await` for async functions.
+         *
+         * NOTE: This is overridden from the base config.
+         *
+         * @see https://typescript-eslint.io/rules/return-await/
+         * @see https://stackoverflow.com/questions/43353087/are-there-performance-concerns-with-return-await/70979225#70979225
+         */
+        "@typescript-eslint/return-await": ["warn", string];
+    };
+}[];
+
+export { config as default };

package/dist/index.d.ts

@@ -1,4 +1,32 @@
-import type { Linter } from "eslint";
-import type { ESLintRules } from "eslint/rules";
-declare const config: Linter.BaseConfig<ESLintRules>;
-export = config;
+import * as _typescript_eslint_eslint_plugin_rules from '@typescript-eslint/eslint-plugin/rules';
+
+declare const config: {
+    files: string[];
+    plugins: {
+        "@typescript-eslint": {
+            configs: Record<string, TSESLint.Linter.Config>;
+            rules: _typescript_eslint_eslint_plugin_rules.TypeScriptESLintRules;
+        };
+    };
+    languageOptions: {
+        parser: any;
+        parserOptions: {
+            project: string;
+        };
+    };
+    rules: {
+        /**
+         * Enforce to use `return await` for async functions.
+         * This rule is set to "always" because it's a good practice to use
+         * `return await` for async functions.
+         *
+         * NOTE: This is overridden from the base config.
+         *
+         * @see https://typescript-eslint.io/rules/return-await/
+         * @see https://stackoverflow.com/questions/43353087/are-there-performance-concerns-with-return-await/70979225#70979225
+         */
+        "@typescript-eslint/return-await": ["warn", string];
+    };
+}[];
+
+export { config as default };

package/dist/index.js

@@ -1,19 +1,62 @@
 "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 AlloyTypescript = require("eslint-config-alloy/typescript");
-var config = {
-    parser: "@typescript-eslint/parser",
-    plugins: ["@typescript-eslint"],
-    rules: __assign({}, AlloyTypescript.rules),
+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 __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
+));
+
+// src/index.ts
+var TypescriptEslintPlugin = __toESM(require("@typescript-eslint/eslint-plugin"));
+var TypescriptEslintParser = __toESM(require("@typescript-eslint/parser"));
+var AlloyTypescript = __toESM(require("eslint-config-alloy/typescript"));
+var config = [
+  {
+    files: ["**/*.{ts,tsx}"],
+    plugins: {
+      "@typescript-eslint": TypescriptEslintPlugin
+    },
+    languageOptions: {
+      parser: TypescriptEslintParser,
+      parserOptions: {
+        project: "./tsconfig.json"
+      }
+    },
+    rules: {
+      /**
+       * Use the rules from the base config as defaults.
+       *
+       * @see https://alloyteam.github.io/eslint-config-alloy/?hideOff=1&rule=typescript
+       */
+      ...AlloyTypescript.rules ?? {},
+      /**
+       * Enforce to use `return await` for async functions.
+       * This rule is set to "always" because it's a good practice to use
+       * `return await` for async functions.
+       *
+       * NOTE: This is overridden from the base config.
+       *
+       * @see https://typescript-eslint.io/rules/return-await/
+       * @see https://stackoverflow.com/questions/43353087/are-there-performance-concerns-with-return-await/70979225#70979225
+       */
+      "@typescript-eslint/return-await": ["warn", "always"]
+    }
+  }
+];
 module.exports = config;

package/dist/index.mjs

@@ -0,0 +1,48 @@
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+
+// src/index.ts
+import * as TypescriptEslintPlugin from "@typescript-eslint/eslint-plugin";
+import * as TypescriptEslintParser from "@typescript-eslint/parser";
+import * as AlloyTypescript from "eslint-config-alloy/typescript";
+var require_src = __commonJS({
+  "src/index.ts"(exports, module) {
+    var config = [
+      {
+        files: ["**/*.{ts,tsx}"],
+        plugins: {
+          "@typescript-eslint": TypescriptEslintPlugin
+        },
+        languageOptions: {
+          parser: TypescriptEslintParser,
+          parserOptions: {
+            project: "./tsconfig.json"
+          }
+        },
+        rules: {
+          /**
+           * Use the rules from the base config as defaults.
+           *
+           * @see https://alloyteam.github.io/eslint-config-alloy/?hideOff=1&rule=typescript
+           */
+          ...AlloyTypescript.rules ?? {},
+          /**
+           * Enforce to use `return await` for async functions.
+           * This rule is set to "always" because it's a good practice to use
+           * `return await` for async functions.
+           *
+           * NOTE: This is overridden from the base config.
+           *
+           * @see https://typescript-eslint.io/rules/return-await/
+           * @see https://stackoverflow.com/questions/43353087/are-there-performance-concerns-with-return-await/70979225#70979225
+           */
+          "@typescript-eslint/return-await": ["warn", "always"]
+        }
+      }
+    ];
+    module.exports = config;
+  }
+});
+export default require_src();

package/package.json

@@ -1,62 +1,61 @@
 {
   "name": "@abinnovision/eslint-config-typescript",
-  "packageManager": "yarn@3.4.1",
-  "version": "1.2.0",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "2.0.0",
+  "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.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "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}'"
+    "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}'"
+  },
+  "lint-staged": {
+    "src/**/*.{ts,js}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "{**/*,*}.{md,json,json5,yaml,yml}": [
+      "prettier --write"
+    ]
   },
+  "prettier": "@abinnovision/prettier-config",
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.9.0",
+    "@typescript-eslint/parser": "^6.9.0",
     "eslint-config-alloy": "^5.1.2"
   },
   "devDependencies": {
-    "@abinnovision/prettier-config": "^1.1.0",
-    "@types/eslint": "^8.21.1",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
+    "@abinnovision/prettier-config": "^2.0.0",
+    "@types/eslint": "^8.44.6",
     "eslint": "^8.52.0",
+    "globals": "^13.23.0",
     "prettier": "^3.0.3",
+    "tsup": "^7.2.0",
     "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
     "eslint": "^8.24.0"
   },
-  "eslintConfig": {
-    "extends": [
-      "@abinnovision/eslint-config-base",
-      "./dist/index.js"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    }
-  },
-  "prettier": "@abinnovision/prettier-config",
-  "lint-staged": {
-    "src/**/*.{ts,js}": [
-      "prettier --write",
-      "eslint --fix"
-    ],
-    "**/*.{md,json,json5,yaml,yml}": [
-      "prettier --write"
-    ]
-  }
+  "packageManager": "yarn@3.4.1"
 }