@o3r/eslint-config 11.6.0-prerelease.10

package/schematics/ng-add/index.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngAdd = void 0;
+const path = require("node:path");
+const schematics_1 = require("@angular-devkit/schematics");
+const index_1 = require("./eslint/index");
+const index_2 = require("./vscode/index");
+const reportMissingSchematicsDep = (logger) => (reason) => {
+    logger.error(`[ERROR]: Adding @o3r/eslint-config has failed.
+You need to install '@o3r/schematics' package to be able to use the eslint-config package. Please run 'ng add @o3r/schematics' .`);
+    throw reason;
+};
+const handleOtterEslintErrors = (projectName) => async (tree, context) => {
+    if (!projectName) {
+        return;
+    }
+    const { getWorkspaceConfig } = await Promise.resolve().then(() => require('@o3r/schematics'));
+    const workspace = getWorkspaceConfig(tree);
+    if (!workspace) {
+        return;
+    }
+    const workspaceProject = workspace.projects[projectName];
+    if (!workspaceProject) {
+        context.logger.warn('No project detected, linter task can not be added.');
+        return;
+    }
+    const projectRoot = workspaceProject.root;
+    const mainTsPath = path.posix.join(projectRoot, 'src/main.ts');
+    if (tree.exists(mainTsPath)) {
+        const mainTsContent = tree.readText(mainTsPath);
+        tree.overwrite(mainTsPath, '/* eslint-disable no-console -- console.error is used to log error in the browser while initializing the Angular application */\n' + mainTsContent);
+    }
+    const appComponentPath = path.posix.join(projectRoot, 'src/app/app.component.ts');
+    if (tree.exists(appComponentPath)) {
+        const appComponentContent = tree.readText(appComponentPath);
+        tree.overwrite(appComponentPath, appComponentContent.replace(/^(\s+)(title =)/m, '$1public $2'));
+    }
+    context.logger.warn('Linter errors may occur and should be fixed by hand or by running the linter with the option `--fix`.');
+};
+function ngAddFn(options) {
+    /* ng add rules */
+    return async (tree, context) => {
+        let installJestPlugin = false;
+        try {
+            require.resolve('jest');
+            installJestPlugin = true;
+        }
+        catch { }
+        const devDependenciesToInstall = [
+            '@eslint-community/eslint-plugin-eslint-comments',
+            '@eslint/js',
+            '@o3r/eslint-plugin',
+            '@stylistic/eslint-plugin',
+            '@typescript-eslint/parser',
+            '@typescript-eslint/utils',
+            '@typescript-eslint/types',
+            'angular-eslint',
+            'eslint',
+            'eslint-import-resolver-node',
+            'eslint-import-resolver-typescript',
+            'eslint-plugin-import',
+            'eslint-plugin-import-newlines',
+            ...(installJestPlugin ? ['eslint-plugin-jest'] : []),
+            'eslint-plugin-jsdoc',
+            'eslint-plugin-prefer-arrow',
+            // TODO: reactivate once https://github.com/nirtamir2/eslint-plugin-sort-export-all/issues/18 is fixed
+            // 'eslint-plugin-sort-export-all',
+            'eslint-plugin-unicorn',
+            'eslint-plugin-unused-imports',
+            'globby',
+            'globals',
+            'jsonc-eslint-parser',
+            'typescript-eslint',
+            // TODO could be removed once #2482 is fixed
+            'yaml-eslint-parser',
+            ...(options.projectName ? ['@angular-eslint/builder'] : [])
+        ];
+        const { getExternalDependenciesVersionRange, setupDependencies, getWorkspaceConfig, getO3rPeerDeps, getProjectNewDependenciesTypes, getPackageInstallConfig } = await Promise.resolve().then(() => require('@o3r/schematics'));
+        const depsInfo = getO3rPeerDeps(path.resolve(__dirname, '..', '..', 'package.json'), true, /^@(?:o3r|ama-sdk)/);
+        const workspaceProject = options.projectName ? getWorkspaceConfig(tree)?.projects[options.projectName] : undefined;
+        const { NodeDependencyType } = await Promise.resolve().then(() => require('@schematics/angular/utility/dependencies'));
+        const packageJsonPath = path.resolve(__dirname, '..', '..', 'package.json');
+        const dependencies = depsInfo.o3rPeerDeps.reduce((acc, dep) => {
+            acc[dep] = {
+                inManifest: [{
+                        range: `${options.exactO3rVersion ? '' : '~'}${depsInfo.packageVersion}`,
+                        types: getProjectNewDependenciesTypes(workspaceProject)
+                    }],
+                ngAddOptions: { exactO3rVersion: options.exactO3rVersion }
+            };
+            return acc;
+        }, getPackageInstallConfig(packageJsonPath, tree, options.projectName, true, !!options.exactO3rVersion));
+        Object.entries(getExternalDependenciesVersionRange(devDependenciesToInstall, packageJsonPath, context.logger))
+            .forEach(([dep, range]) => {
+            dependencies[dep] = {
+                inManifest: [{
+                        range,
+                        types: [NodeDependencyType.Dev]
+                    }]
+            };
+        });
+        return () => (0, schematics_1.chain)([
+            setupDependencies({
+                projectName: options.projectName,
+                dependencies,
+                ngAddToRun: depsInfo.o3rPeerDeps
+            }),
+            index_2.updateVscode,
+            (0, index_1.updateEslintConfig)(__dirname),
+            options.projectName && workspaceProject?.root
+                ? (0, schematics_1.chain)([
+                    (0, index_1.updateEslintConfig)(__dirname, options.projectName),
+                    options.fix ? handleOtterEslintErrors(options.projectName) : (0, schematics_1.noop)()
+                ])
+                : (0, schematics_1.noop)()
+        ])(tree, context);
+    };
+}
+/**
+ * Add Otter eslint-config to an Angular Project
+ * @param options Options for the schematic
+ */
+const ngAdd = (options) => async (_, { logger }) => {
+    const { createSchematicWithMetricsIfInstalled } = await Promise.resolve().then(() => require('@o3r/schematics')).catch(reportMissingSchematicsDep(logger));
+    return createSchematicWithMetricsIfInstalled(ngAddFn)(options);
+};
+exports.ngAdd = ngAdd;
+//# sourceMappingURL=index.js.map

package/schematics/ng-add/schema.d.ts

@@ -0,0 +1,10 @@
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgAddSchematicsSchema extends SchematicOptionObject {
+    /** Project name */
+    projectName?: string | undefined;
+    /** Use a pinned version for otter packages */
+    exactO3rVersion?: boolean;
+    /** Fix known issues with our ESLint config after Otter application or library generation */
+    fix?: boolean;
+}
+//# sourceMappingURL=schema.d.ts.map

package/schematics/ng-add/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,8CAA8C;IAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,4FAA4F;IAC5F,GAAG,CAAC,EAAE,OAAO,CAAC;CACf"}

package/schematics/ng-add/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/ng-add/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ngAddSchematicsSchema",
+  "title": "Add Otter eslint config",
+  "description": "ngAdd Otter eslint config",
+  "properties": {
+    "projectName": {
+      "type": "string",
+      "description": "Project name",
+      "$default": {
+        "$source": "projectName"
+      }
+    },
+    "exactO3rVersion": {
+      "type": "boolean",
+      "description": "Use a pinned version for otter packages",
+      "default": false
+    },
+    "fix": {
+      "type": "boolean",
+      "description": "Fix known issues with our ESLint config after Otter application or library generation",
+      "default": false
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+  ]
+}

package/schematics/ng-add/tsconfig/index.d.ts

@@ -0,0 +1,8 @@
+import { type Rule } from '@angular-devkit/schematics';
+/**
+ * Update or add tsconfig.eslint.json file
+ * @param rootPath
+ * @param projectTsConfig
+ */
+export declare const updateOrAddTsconfigEslint: (rootPath: string, projectTsConfig?: string) => Rule;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/ng-add/tsconfig/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,KAAK,IAAI,EAGV,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,aAAc,MAAM,+BAAiC,IAa1F,CAAC"}

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateOrAddTsconfigEslint = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+/**
+ * Update or add tsconfig.eslint.json file
+ * @param rootPath
+ * @param projectTsConfig
+ */
+const updateOrAddTsconfigEslint = (rootPath, projectTsConfig = 'tsconfig') => async (tree) => {
+    const tsconfigPath = 'tsconfig.eslint.json';
+    if (tree.exists(tsconfigPath)) {
+        const tsconfig = tree.readJson(tsconfigPath);
+        tsconfig.include = (tsconfig.include || []).concat(`eslint*.config.*js`);
+        tree.overwrite(tsconfigPath, JSON.stringify(tsconfig, null, 2));
+        return () => tree;
+    }
+    const { getTemplateFolder } = await Promise.resolve().then(() => require('@o3r/schematics'));
+    return () => (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)(getTemplateFolder(rootPath, __dirname)), [
+        (0, schematics_1.template)({ projectTsConfig }),
+        (0, schematics_1.renameTemplateFiles)()
+    ]), schematics_1.MergeStrategy.Overwrite);
+};
+exports.updateOrAddTsconfigEslint = updateOrAddTsconfigEslint;
+//# sourceMappingURL=index.js.map

package/schematics/ng-add/tsconfig/templates/tsconfig.eslint.json.template

@@ -0,0 +1,6 @@
+{
+  "extends": "./<%= projectTsConfig %>",
+  "include": [
+    "eslint*.config.*js"
+  ]
+}

package/schematics/ng-add/vscode/index.d.ts

@@ -0,0 +1,6 @@
+import { type Rule } from '@angular-devkit/schematics';
+/**
+ * Update VSCode recommendations and settings
+ */
+export declare const updateVscode: Rule;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/ng-add/vscode/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,IAAI,EACV,MAAM,4BAA4B,CAAC;AAoCpC;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,IAwB1B,CAAC"}

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateVscode = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+/**
+ * Update VSCode recommendations and settings
+ */
+const updateVscode = async () => {
+    const { addVsCodeRecommendations } = await Promise.resolve().then(() => require('@o3r/schematics'));
+    return (0, schematics_1.chain)([
+        addVsCodeRecommendations(['dbaeumer.vscode-eslint']),
+        (tree) => {
+            const vscodeSettingsPath = '.vscode/settings.json';
+            const settings = (tree.exists(vscodeSettingsPath) ? (tree.readJson(vscodeSettingsPath) || {}) : {});
+            settings['eslint.useFlatConfig'] = true;
+            settings['editor.defaultFormatter'] = 'dbaeumer.vscode-eslint';
+            settings['editor.foldingImportsByDefault'] = true;
+            settings['eslint.rules.customizations'] = [
+                { rule: '@stylistic/*', fixable: true, severity: 'off' },
+                { rule: '!@stylistic/*', fixable: true, severity: 'info' }
+            ];
+            settings['editor.codeActionsOnSave'] ||= {};
+            settings['editor.codeActionsOnSave']['source.fixAll.eslint'] = 'explicit';
+            if (tree.exists(vscodeSettingsPath)) {
+                tree.overwrite(vscodeSettingsPath, JSON.stringify(settings, null, 2));
+            }
+            else {
+                tree.create(vscodeSettingsPath, JSON.stringify(settings, null, 2));
+            }
+            return tree;
+        }
+    ]);
+};
+exports.updateVscode = updateVscode;
+//# sourceMappingURL=index.js.map

package/schematics/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/src/rules/base.cjs

@@ -0,0 +1,17 @@
+'use strict';
+/**
+ * Get the @o3r plugin
+ * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
+ * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.Config} config
+ */
+const base = (plugin) => ({
+  name: '@o3r/eslint-config/base',
+  languageOptions: {
+    sourceType: 'module'
+  },
+  plugins: {
+    '@o3r': plugin
+  }
+});
+
+module.exports = base;

package/src/rules/template/angular.cjs

@@ -0,0 +1,27 @@
+'use strict';
+const angular = require('angular-eslint');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/eslint-comments',
+    files: [
+      '**/*.html'
+    ],
+    rules: {
+      ...convertWarningsToErrors(angular.configs.templateRecommended),
+      ...convertWarningsToErrors(angular.configs.templateAccessibility),
+      '@angular-eslint/template/interactive-supports-focus': [
+        'error',
+        {
+          allowList: ['ngbNavLink']
+        }
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/template/otter.cjs

@@ -0,0 +1,20 @@
+'use strict';
+const o3rBaseConfig = require('../base.cjs');
+
+/**
+ * Get the @o3r template recommended rules
+ * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
+ * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} config
+ */
+const o3rTemplateRecommended = (plugin) => [
+  o3rBaseConfig(plugin),
+  {
+    name: '@o3r/eslint-config/template-recommended',
+    files: ['**/*.html'],
+    rules: {
+      '@o3r/template-async-number-limitation': 'error'
+    }
+  }
+];
+
+module.exports = o3rTemplateRecommended;

package/src/rules/template.cjs

@@ -0,0 +1,23 @@
+'use strict';
+const o3r = require('@o3r/eslint-plugin');
+const angular = require('angular-eslint');
+const angularOverrideConfig = require('./template/angular.cjs');
+const o3rConfig = require('./template/otter.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const configArray = [
+  ...angular.configs.templateRecommended.map((config) => ({
+    files: ['**/*.html'],
+    ...config
+  })),
+  ...angular.configs.templateAccessibility.map((config) => ({
+    files: ['**/*.html'],
+    ...config
+  })),
+  ...angularOverrideConfig,
+  ...o3rConfig(o3r)
+];
+
+module.exports = configArray;

package/src/rules/typescript/comments.cjs

@@ -0,0 +1,27 @@
+'use strict';
+const comments = require('@eslint-community/eslint-plugin-eslint-comments/configs');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/eslint-comments',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(comments.recommended),
+      '@eslint-community/eslint-comments/disable-enable-pair': 'off',
+      '@eslint-community/eslint-comments/require-description': [
+        'error',
+        {
+          ignore: ['eslint-enable']
+        }
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/eslint-angular.cjs

@@ -0,0 +1,36 @@
+'use strict';
+const angular = require('angular-eslint');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/angular-eslint',
+    // Same files as the ones asked by `typescript-eslint/eslint-recommended`
+    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    rules: {
+      ...convertWarningsToErrors(angular.configs.tsRecommended),
+      '@angular-eslint/component-selector': [
+        'error',
+        {
+          type: 'element',
+          style: 'kebab-case'
+        }
+      ],
+      '@angular-eslint/directive-class-suffix': 'off',
+      '@angular-eslint/directive-selector': [
+        'error',
+        {
+          type: 'attribute',
+          style: 'camelCase'
+        }
+      ],
+      '@angular-eslint/no-empty-lifecycle-method': 'off',
+      '@angular-eslint/no-input-rename': 'off'
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/eslint-typescript.cjs

@@ -0,0 +1,145 @@
+'use strict';
+const typescript = require('typescript-eslint');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/typescript-eslint',
+    // Same files as the ones asked by `typescript-eslint/eslint-recommended`
+    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    rules: {
+      ...convertWarningsToErrors(typescript.configs.recommended),
+      ...convertWarningsToErrors(typescript.configs.recommendedTypeChecked),
+      '@typescript-eslint/adjacent-overload-signatures': 'error',
+      '@typescript-eslint/array-type': [
+        'error',
+        {
+          default: 'array'
+        }
+      ],
+      '@typescript-eslint/consistent-type-assertions': 'error',
+      '@typescript-eslint/dot-notation': 'error',
+      '@typescript-eslint/explicit-member-accessibility': [
+        'error',
+        {
+          accessibility: 'explicit',
+          overrides: {
+            constructors: 'off'
+          }
+        }
+      ],
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/member-ordering': [
+        'error',
+        {
+          default: [
+            'static-field',
+            'instance-field',
+            'constructor',
+            'decorated-method',
+            'private-instance-method',
+            'protected-instance-method',
+            'public-instance-method'
+          ]
+        }
+      ],
+      '@typescript-eslint/naming-convention': [
+        'error',
+        {
+          selector: 'default',
+          format: ['camelCase'],
+          leadingUnderscore: 'allow',
+          trailingUnderscore: 'allow'
+        },
+        {
+          selector: 'variable',
+          format: ['camelCase', 'UPPER_CASE'],
+          leadingUnderscore: 'allow',
+          trailingUnderscore: 'allow'
+        },
+        {
+          selector: 'memberLike',
+          modifiers: ['private'],
+          format: ['camelCase', 'UPPER_CASE'],
+          leadingUnderscore: 'allow'
+        },
+        {
+          selector: 'typeLike',
+          format: ['PascalCase']
+        },
+        {
+          selector: 'property',
+          modifiers: ['readonly'],
+          format: ['camelCase', 'UPPER_CASE'],
+          leadingUnderscore: 'allow'
+        },
+        {
+          selector: 'enumMember',
+          format: ['camelCase', 'UPPER_CASE']
+        },
+        {
+          selector: 'import',
+          format: ['camelCase', 'PascalCase']
+        },
+        {
+          selector: 'objectLiteralProperty',
+          format: null
+        },
+        {
+          selector: 'variable',
+          modifiers: ['destructured'],
+          format: null
+        }
+      ],
+      '@typescript-eslint/no-dupe-class-members': 'error',
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/no-empty-object-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-inferrable-types': 'error',
+      '@typescript-eslint/no-misused-promises': [
+        'error',
+        {
+          checksVoidReturn: false
+        }
+      ],
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-parameter-properties': 'off',
+      '@typescript-eslint/no-redeclare': 'error',
+      '@typescript-eslint/no-shadow': [
+        'error',
+        {
+          hoist: 'all'
+        }
+      ],
+      '@typescript-eslint/no-use-before-define': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          caughtErrors: 'none',
+          ignoreRestSiblings: true
+        }
+      ],
+      '@typescript-eslint/prefer-for-of': 'error',
+      '@typescript-eslint/prefer-function-type': 'error',
+      '@typescript-eslint/prefer-readonly': 'error',
+      '@typescript-eslint/prefer-regexp-exec': 'off',
+      '@typescript-eslint/triple-slash-reference': [
+        'error',
+        {
+          path: 'always',
+          types: 'prefer-import',
+          lib: 'always'
+        }
+      ],
+      '@typescript-eslint/unified-signatures': 'error'
+    }
+  }
+];
+
+module.exports = config;