feat(eslint)!: level up to eslint flat config

BREAKING CHANGES:
- no eslint ^9.37 is required
- sc config is applied by using the exposed functions
- sc rules shall be used with recommended config

Author: mumenthalers

package-lock.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build:ci": "lerna run build",
-    "build:lint:ci": "lerna run build:lint:ci",
+    "build:lint:ci": "lerna run build --scope @shiftcode/eslint-plugin-rules && lerna run build --scope @shiftcode/eslint-config-recommended",
     "lint:ci": "lerna run lint:ci",
     "prepare": "husky",
     "prettier": "lerna run prettier",
@@ -27,8 +27,7 @@
     "@commitlint/prompt-cli": "^19.3.1",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.1",
-    "@typescript-eslint/eslint-plugin": "^8.13.0",
-    "eslint": "^9.3.0",
+    "eslint": "^9.36.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.7",

package.json

@@ -2,50 +2,67 @@
 
 > 🎯 Target runtime: es2023 ([Node >= 20](https://node.green/#ES2023))
 
-> ⚠️ This module exports code using CommonJS
 
 This module provides an eslint default rule-set configuration for shiftcode projects.
 
 ### remark
 
-by using this module, the [@shiftcode/eslint-plugin-rules](../eslint-plugin-rules) module will be automatically included too.
+by using this module, the [@shiftcode/eslint-plugin-rules](../eslint-plugin-rules) module will be automatically included
+too.
+and depends on additional libraries that provide rules.
 
 ## usage
+the module only exports a single function `defineScTsConfig` which can be used to create the eslint configuration.
+it is basically a wrapper around the new eslint `defineConfig` function but already includes the setup for typescript,
+some rules with default configurations and will ensure the prettier rules (disabling formatting rules) are included at last.
 
-sample .eslintrc.js file:
-
-```javascript
-module.exports = {
-  // ...
-    
-  // all child eslintrc configs from workspace packages inherit this extension
-  extends: [
-    '^shiftcode',
-  ],
-  
-  // ...
-}
-```
+sample `eslint.config.mjs`:
 
-## provided configurations
+```js
+import { defineScTsConfig } from '@shiftcode/eslint-config-recommended'
 
-the following provided configurations might be included:
+export default defineScTsConfig(
+  {
+    languageOptions: {
+      ecmaVersion: 2023,
+      sourceType: 'module',
+      parserOptions: { project: ['./tsconfig.json', './tsconfig.spec.json'] },
+    },
+  },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'error',
+    },
+  }
+)
+```
 
-- ``@shiftcode/recommended``: rule-set for common javascript and typescript files
-- ``@shiftcode/recommended/ng-config``: angular-specific rule-set for angular apps
+## Additional configurations
 
-## Optional Peer Dependencies
-All the optional peer dependencies (`@angular-eslint/*`) are only required if the [ng-config](./src/ng-config/index.ts)
-is used
+Additionally on the submodule `/angular` the `defineScAngularConfig` function is exported 
+which includes angular-specific rules and configurations.
 
-## Ideas
+```js
+import { defineScAngularConfig } from '@shiftcode/eslint-config-recommended/angular'
 
-it could be useful to create another configuration (i.e. ``shiftcode/node-config``)
-used within services/backend workspaces, because the naming conventions aren't really the same as for a client workspace.
+export default defineScAngularConfig(
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      parserOptions: {
+        project: ['./tsconfig.app.json', './tsconfig.spec.json'],
+      },
+    },
+  },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      '@angular-eslint/component-selector': ['error', { type: 'element', prefix: 'gf', style: 'kebab-case' }],
+    },
+  }
+)
+```
 
-Examples:
-- const PEdgeLabel = ...
-- export const JwtGuardConfig = ...
-- const { TextP } = process
-- export function VersionedITOf<T,K> { ... }
-- etc.
+when using the angular configuration, the peer dependency `angular-eslint` is required.

packages/eslint-config-recommended/README.md

@@ -6,19 +6,17 @@
   "license": "UNLICENSED",
   "author": "shiftcode GmbH <[email protected]>",
   "sideEffects": false,
-  "type": "commonjs",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./ng-config": {
-      "types": "./dist/ng-config/index.d.ts",
-      "default": "./dist/ng-config/index.js"
+    "./angular": {
+      "types": "./dist/angular/index.d.ts",
+      "default": "./dist/angular/index.js"
     }
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "prebuild": "rm -rf ./dist",
@@ -36,36 +34,22 @@
     "test:ci": "npm run test"
   },
   "dependencies": {
+    "@eslint/js": "^9.37.0",
     "@shiftcode/eslint-plugin-rules": "^2.0.1",
-    "@typescript-eslint/eslint-plugin": "^8.17.0",
-    "@typescript-eslint/parser": "^8.17.0",
-    "eslint": "^9.3.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.30.0",
-    "eslint-plugin-unused-imports": "^4.1.3",
-    "typescript-eslint": "8.13.0"
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-unused-imports": "^4.2.0",
+    "typescript-eslint": "8.46.0"
+  },
+  "devDependencies": {
+    "angular-eslint": "^20.3.0"
   },
   "peerDependencies": {
-    "@angular-eslint/builder": "^19.0.0",
-    "@angular-eslint/eslint-plugin": "^19.0.0",
-    "@angular-eslint/eslint-plugin-template": "^19.0.0",
-    "@angular-eslint/schematics": "^19.0.0",
-    "@angular-eslint/template-parser": "^19.0.0"
+    "angular-eslint": "^20.3.0"
   },
   "peerDependenciesMeta": {
-    "@angular-eslint/builder": {
-      "optional": true
-    },
-    "@angular-eslint/eslint-plugin": {
-      "optional": true
-    },
-    "@angular-eslint/eslint-plugin-template": {
-      "optional": true
-    },
-    "@angular-eslint/schematics": {
-      "optional": true
-    },
-    "@angular-eslint/template-parser": {
+    "angular-eslint": {
       "optional": true
     }
   },