@o3r/eslint-config 14.0.0-next.0 → 14.0.0-next.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/eslint-config",
-  "version": "14.0.0-next.0",
+  "version": "14.0.0-next.10",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "build:builders": "tsc -b tsconfig.builders.json --pretty && yarn generate-cjs-manifest"
   },
   "dependencies": {
-    "@o3r/schematics": "^14.0.0-next.0"
+    "@o3r/schematics": "~14.0.0-next.10"
   },
   "peerDependencies": {
     "@angular-devkit/core": "^20.0.0",
@@ -46,10 +46,10 @@
     "@angular/compiler": "^20.0.0",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
     "@eslint/js": "^8.57.0 || ^9.22.0",
-    "@o3r/eslint-plugin": "^14.0.0-next.0",
-    "@o3r/schematics": "^14.0.0-next.0",
+    "@o3r/eslint-plugin": "~14.0.0-next.10",
+    "@o3r/schematics": "~14.0.0-next.10",
     "@schematics/angular": "^20.0.0",
-    "@stylistic/eslint-plugin": "~5.3.0",
+    "@stylistic/eslint-plugin": "~5.6.0",
     "@typescript-eslint/parser": "^8.15.0",
     "@typescript-eslint/types": "^8.15.0",
     "@typescript-eslint/utils": "^8.15.0",
@@ -60,62 +60,59 @@
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-import-newlines": "^1.4.0",
     "eslint-plugin-jest": "^29.0.0",
-    "eslint-plugin-jsdoc": "^54.0.0",
+    "eslint-plugin-jsdoc": "~61.5.0",
     "eslint-plugin-prefer-arrow": "^1.2.2",
-    "eslint-plugin-unicorn": "^60.0.0",
+    "eslint-plugin-unicorn": "~62.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "globals": "^16.0.0",
     "globby": "^11.1.0",
-    "jest": "^29.7.0",
+    "jest": "^29.0.0 || ^30.2.0",
     "jsonc-eslint-parser": "^2.4.0",
-    "ts-node": "^10.9.2",
-    "type-fest": "^4.30.1",
-    "typescript": "^5.8.0",
+    "type-fest": "^5.3.1",
+    "typescript": "^5.9.0",
     "typescript-eslint": "^8.15.0",
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "@angular-devkit/core": "~20.2.0",
-    "@angular-devkit/schematics": "~20.2.0",
-    "@angular/compiler": "~20.2.0",
+    "@angular-devkit/core": "~20.3.13",
+    "@angular-devkit/schematics": "~20.3.13",
+    "@angular/compiler": "~20.3.15",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
-    "@eslint/js": "~9.35.0",
-    "@nx/eslint-plugin": "~21.5.0",
-    "@o3r/build-helpers": "^14.0.0-next.0",
-    "@o3r/eslint-plugin": "^14.0.0-next.0",
-    "@o3r/test-helpers": "^14.0.0-next.0",
-    "@schematics/angular": "~20.2.0",
-    "@stylistic/eslint-plugin": "~5.3.0",
-    "@types/jest": "~29.5.2",
-    "@types/node": "^22.0.0",
-    "@typescript-eslint/parser": "~8.43.0",
-    "angular-eslint": "~20.2.0",
+    "@eslint/js": "~9.39.0",
+    "@nx/eslint-plugin": "~21.6.0",
+    "@o3r/build-helpers": "~14.0.0-next.10",
+    "@o3r/eslint-plugin": "~14.0.0-next.10",
+    "@o3r/test-helpers": "~14.0.0-next.10",
+    "@schematics/angular": "~20.3.13",
+    "@stylistic/eslint-plugin": "~5.6.0",
+    "@types/jest": "~30.0.0",
+    "@types/node": "~24.10.0",
+    "@typescript-eslint/parser": "~8.51.0",
+    "angular-eslint": "~20.6.0",
     "cpy-cli": "^6.0.0",
-    "eslint": "~9.35.0",
+    "eslint": "~9.39.0",
     "eslint-import-resolver-node": "~0.3.9",
     "eslint-import-resolver-typescript": "~4.4.0",
     "eslint-plugin-import": "~2.32.0",
     "eslint-plugin-import-newlines": "~1.4.0",
-    "eslint-plugin-jest": "~29.0.0",
-    "eslint-plugin-jsdoc": "~54.7.0",
+    "eslint-plugin-jest": "~29.11.0",
+    "eslint-plugin-jsdoc": "~61.5.0",
     "eslint-plugin-prefer-arrow": "~1.2.3",
-    "eslint-plugin-unicorn": "~60.0.0",
-    "eslint-plugin-unused-imports": "~4.2.0",
+    "eslint-plugin-unicorn": "~62.0.0",
+    "eslint-plugin-unused-imports": "~4.3.0",
     "globals": "^16.0.0",
-    "jest": "~29.7.0",
+    "jest": "~30.2.0",
     "jest-junit": "~16.0.0",
-    "jest-util": "~29.7.0",
+    "jest-util": "~30.2.0",
     "jsonc-eslint-parser": "~2.4.0",
-    "nx": "~21.5.0",
-    "pid-from-port": "^1.1.3",
+    "nx": "~21.6.0",
     "rxjs": "^7.8.1",
     "semver": "^7.5.2",
     "ts-jest": "~29.4.0",
-    "ts-node": "~10.9.2",
     "tslib": "^2.6.2",
-    "type-fest": "^4.30.1",
+    "type-fest": "^5.3.1",
     "typescript": "~5.9.2",
-    "typescript-eslint": "~8.43.0"
+    "typescript-eslint": "~8.51.0"
   },
   "peerDependenciesMeta": {
     "@angular-devkit/core": {

package/schematics/ng-add/eslint/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/ng-add/eslint/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAQL,KAAK,IAAI,EAGV,MAAM,4BAA4B,CAAC;AAsCpC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,MAAM,EAAE,cAAc,MAAM,KAAG,IAyD3E,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/ng-add/eslint/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAOL,KAAK,IAAI,EAGV,MAAM,4BAA4B,CAAC;AAsEpC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,MAAM,EAAE,cAAc,MAAM,KAAG,IAgE3E,CAAC"}

package/schematics/ng-add/eslint/index.js

@@ -5,6 +5,11 @@ const path = require("node:path");
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const schematics_2 = require("@o3r/schematics");
+/**
+ * Setup the lint task in the angular.json file
+ * @param projectName
+ * @param extension
+ */
 const editAngularJson = (projectName, extension) => (tree, context) => {
     let workspace = null;
     try {
@@ -24,13 +29,36 @@ const editAngularJson = (projectName, extension) => (tree, context) => {
         options: {
             eslintConfig: `${workspaceProject.root}/eslint.config.${extension}`,
             lintFilePatterns: [
-                `${workspaceProject.sourceRoot || path.posix.join(workspaceProject.root, 'src')}/**/*.ts`
+                `${workspaceProject.root}/**/*.{m,c,}{j,t}s`,
+                `${workspaceProject.root}/**/*.json`,
+                `${workspaceProject.root}/**/*.html`
             ]
         }
     };
     workspace.projects[projectName] = workspaceProject;
     tree.overwrite('/angular.json', JSON.stringify(workspace, null, 2));
 };
+/**
+ * Add the lint task in the package.json
+ * @param projectPath
+ * @param projectName
+ */
+const editPackageJson = (projectPath, projectName) => (tree) => {
+    const packageJsonPath = path.posix.join(projectPath, 'package.json');
+    const packageJson = tree.readJson(packageJsonPath);
+    packageJson.scripts ??= {};
+    packageJson.scripts.lint ??= `ng lint ${projectName}`;
+    tree.overwrite(packageJsonPath, JSON.stringify(packageJson, null, 2));
+};
+const isInstalled = (packageName) => {
+    try {
+        require.resolve(packageName);
+    }
+    catch {
+        return false;
+    }
+    return true;
+};
 /**
  * Update ESLint Config
  * @param rootPath
@@ -50,6 +78,8 @@ const updateEslintConfig = (rootPath, projectName) => (tree, context) => {
     const templateOptions = {
         extension: 'mjs',
         codeBeforeConfig: '',
+        playwrightInstalled: isInstalled('playwright'),
+        jest: isInstalled('jest'),
         codeAfterConfig: '',
         oldConfig: '',
         relativePathToRoot: path.posix.relative(projectRootPath, '.'),
@@ -75,7 +105,12 @@ const updateEslintConfig = (rootPath, projectName) => (tree, context) => {
         tree.delete(filePath);
     }
     return (0, schematics_1.chain)([
-        projectName ? editAngularJson(projectName, templateOptions.extension) : (0, schematics_1.noop)(),
+        ...projectName
+            ? [
+                editAngularJson(projectName, templateOptions.extension),
+                editPackageJson(projectRootPath, projectName)
+            ]
+            : [],
         (0, schematics_1.applyToSubtree)(projectRootPath, [
             (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)((0, schematics_2.getTemplateFolder)(rootPath, __dirname, `./templates/${projectRootPath === '.' ? 'workspace' : 'project'}`)), [
                 (0, schematics_1.template)(templateOptions),

package/schematics/ng-add/eslint/templates/project/eslint.local.config.__extension__.template

@@ -31,5 +31,18 @@ const __dirname = dirname(__filename);
         ...globals.browser
       }<% } %>
     }
-  }
+  }<% if (playwrightInstalled) { %>,
+     {
+      name: '<%= packageName %>/e2e',
+      files: [
+        '**/e2e-playwright/**/*.{j,t}s'
+      ],
+      languageOptions: {
+        globals: {
+          ...globals.node,
+          NodeJS: true
+        }
+      }
+     }
+   <% } %>
 ]);

package/schematics/ng-add/schema.json

@@ -18,7 +18,8 @@
     },
     "fix": {
       "type": "boolean",
-      "description": "Fix known issues with our ESLint config after Otter application or library generation"
+      "description": "Fix known issues with our ESLint config after Otter application or library generation",
+      "default": true
     },
     "skipLinter": {
       "type": "boolean",

package/src/rules/base.cjs

@@ -1,6 +1,6 @@
 'use strict';
 /**
- * Get the @o3r plugin
+ * Get the `@o3r` plugin
  * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
  * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.Config} config
  */

package/src/rules/template/otter.cjs

@@ -2,7 +2,7 @@
 const o3rBaseConfig = require('../base.cjs');
 
 /**
- * Get the @o3r template recommended rules
+ * Get the `@o3r` template recommended rules
  * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
  * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} config
  */

package/src/rules/typescript/jsdoc.cjs

@@ -20,7 +20,17 @@ const config = [
       'jsdoc/check-tag-names': [
         'error',
         {
-          definedTags: ['note', 'title', 'o3rRestrictionKey', 'o3rCategory', 'o3rCategories', 'o3rWidget', 'o3rWidgetParam', 'o3rRequired']
+          definedTags: [
+            'experimental',
+            'note',
+            'title',
+            'o3rRestrictionKey',
+            'o3rCategory',
+            'o3rCategories',
+            'o3rWidget',
+            'o3rWidgetParam',
+            'o3rRequired'
+          ]
         }
       ],
       'jsdoc/no-defaults': 'off',

package/src/rules/typescript/otter.cjs

@@ -2,7 +2,7 @@
 const o3rBaseConfig = require('../base.cjs');
 
 /**
- * Get the @o3r typescript recommended rules
+ * Get the `@o3r` typescript recommended rules
  * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
  * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.Config} config
  */

package/src/rules/typescript/stylistic.cjs

@@ -2,6 +2,14 @@
 const stylistic = require('@stylistic/eslint-plugin');
 const { convertWarningsToErrors } = require('../utils.cjs');
 
+const defaultCommatDangleOptions = {
+  arrays: 'never',
+  objects: 'never',
+  imports: 'always-multiline',
+  exports: 'always-multiline',
+  functions: 'never'
+};
+
 /**
  * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
  */
@@ -15,13 +23,7 @@ const config = [
       ...convertWarningsToErrors(stylistic.configs.recommended),
       '@stylistic/arrow-parens': ['error', 'always'],
       '@stylistic/brace-style': ['error', '1tbs'],
-      '@stylistic/comma-dangle': ['error', {
-        arrays: 'never',
-        objects: 'never',
-        imports: 'always-multiline',
-        exports: 'always-multiline',
-        functions: 'never'
-      }],
+      '@stylistic/comma-dangle': ['error', defaultCommatDangleOptions],
       '@stylistic/indent': [
         'error',
         2,
@@ -95,6 +97,18 @@ const config = [
         'inside'
       ]
     }
+  },
+  {
+    name: '@o3r/eslint-config/stylistic-es-overrides',
+    files: [
+      '**/*.{c,m}{t,j}s'
+    ],
+    rules: {
+      '@stylistic/comma-dangle': ['error', {
+        ...defaultCommatDangleOptions,
+        generics: 'ignore'
+      }]
+    }
   }
 ];
 

package/src/rules/typescript.cjs

@@ -7,6 +7,7 @@ const angular = require('angular-eslint');
 const importPlugin = require('eslint-plugin-import');
 const jsdoc = require('eslint-plugin-jsdoc');
 const unicorn = require('eslint-plugin-unicorn');
+const globals = require('globals');
 const typescript = require('typescript-eslint');
 const commentsConfigOverrides = require('./typescript/comments.cjs');
 const angularConfigOverrides = require('./typescript/eslint-angular.cjs');
@@ -23,29 +24,19 @@ const stylisticConfig = require('./typescript/stylistic.cjs');
 const unicornConfig = require('./typescript/unicorn.cjs');
 const unusedImportsConfig = require('./typescript/unused-imports.cjs');
 
-/**
- * Get the jest config if dependency is present
- * @param {'recommended' | 'overrides'} type
- * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} config
- */
-const getJestConfig = (type) => {
+const checkDependency = (packageName) => {
   try {
-    require.resolve('jest');
-    return type === 'overrides'
-      ? require('./typescript/jest.cjs')
-      : [{
-        // Name added for debugging purpose with @eslint/config-inspector
-        name: 'jest/flat-recommended',
-        files: [
-          '**/*.{c,m,}{t,j}s'
-        ],
-        ...require('eslint-plugin-jest').configs['flat/recommended']
-      }];
+    require.resolve(packageName);
   } catch {
-    return [];
+    return false;
   }
+  return true;
 };
 
+const hasPlaywrightInstalled = checkDependency('@playwright/test');
+
+const hasJestDependency = checkDependency('jest');
+
 /**
  * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
  */
@@ -87,7 +78,17 @@ const configArray = [
     ],
     ...unicorn.default.configs.recommended
   },
-  ...(getJestConfig('recommended')),
+  ...(hasJestDependency
+    ? [{
+      // Name added for debugging purpose with @eslint/config-inspector
+      name: 'jest/flat-recommended',
+      files: [
+        '**/*.{c,m,}{t,j}s'
+      ],
+      ...require('eslint-plugin-jest').configs['flat/recommended']
+    }]
+    : []
+  ),
   {
     // Name added for debugging purpose with @eslint/config-inspector
     name: 'import/recommended',
@@ -107,7 +108,18 @@ const configArray = [
   ...typescriptConfigOverrides,
   ...angularConfigOverrides,
   ...jsdocConfigOverrides,
-  ...(getJestConfig('overrides')),
+  ...(hasJestDependency
+    ? require('./typescript/jest.cjs')
+    : [{
+      name: '@o3r/eslint-config/typescript/jasmine-globals',
+      files: ['**/*.{c,m,}ts'],
+      languageOptions: {
+        globals: {
+          ...globals.jasmine
+        }
+      }
+    }]
+  ),
   ...preferArrowConfig,
   ...stylisticConfig,
   ...unicornConfig,
@@ -132,7 +144,33 @@ const configArray = [
         }
       }
     }
-  }
+  }, {
+    name: '@o3r/eslint-config/node-files',
+    files: [
+      '**/schematics/**/*.{j,t}s',
+      ...hasJestDependency ? ['**/jest.config.{c,m,}{j,t}s'] : []
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        NodeJS: true
+      }
+    }
+  },
+  ...hasPlaywrightInstalled
+    ? [{
+      name: '@o3r/eslint-config/e2e-playwright',
+      files: [
+        '**/e2e-playwright/**/*.{j,t}s'
+      ],
+      languageOptions: {
+        globals: {
+          ...globals.node,
+          NodeJS: true
+        }
+      }
+    }]
+    : []
 ];
 
 module.exports = configArray;