@o3r/eslint-config 11.6.0-prerelease.8

package/src/rules/typescript/eslint.cjs

@@ -0,0 +1,146 @@
+'use strict';
+const eslint = require('@eslint/js');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+const defaultNewCapOptions = {
+  newIsCap: true,
+  capIsNew: true,
+  properties: true,
+  capIsNewExceptions: [
+    'AsyncInput',
+    'Component',
+    'Directive',
+    'HostBinding',
+    'HostListener',
+    'Inject',
+    'Injectable',
+    'Input',
+    'Localization',
+    'NgModule',
+    'Optional',
+    'Output',
+    'Pipe',
+    'ViewChild',
+    'ViewChildren',
+    'SkipSelf',
+    'Host',
+    'ContentChildren',
+    'O3rComponent',
+    'ConfigObserver',
+    'O3rConfig'
+  ]
+};
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/eslint-js',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(eslint.configs.recommended),
+      complexity: 'off',
+      'constructor-super': 'error',
+      curly: 'error',
+      'dot-notation': 'error',
+      eqeqeq: [
+        'error',
+        'smart'
+      ],
+      'getter-return': 'error',
+      'guard-for-in': 'error',
+      'id-denylist': ['error',
+        'any',
+        'Number',
+        'String',
+        'string',
+        'Boolean',
+        'boolean',
+        'Undefined',
+        'undefined'
+      ],
+      'id-match': 'error',
+      'max-classes-per-file': 'off',
+      'new-cap': [
+        'error',
+        defaultNewCapOptions
+      ],
+      'no-alert': 'error',
+      'no-bitwise': 'error',
+      'no-caller': 'error',
+      'no-console': 'error',
+      'no-dupe-args': 'error',
+      'no-dupe-keys': 'error',
+      'no-empty': 'off',
+      'no-empty-function': 'off',
+      'no-eval': 'error',
+      'no-func-assign': 'error',
+      'no-import-assign': 'error',
+      'no-inner-declarations': 'error',
+      'no-invalid-this': 'off',
+      'no-iterator': 'error',
+      'no-loop-func': 'error',
+      'no-multi-str': 'error',
+      'no-new-native-nonconstructor': 'error',
+      'no-new-wrappers': 'error',
+      'no-obj-calls': 'error',
+      'no-proto': 'error',
+      'no-restricted-imports': ['error', {
+        patterns: [
+          'rxjs/internal/*'
+        ]
+      }],
+      'no-sequences': 'error',
+      'no-setter-return': 'error',
+      'no-shadow': 'off',
+      'no-this-before-super': 'error',
+      'no-undef': 'error',
+      'no-undef-init': 'error',
+      'no-underscore-dangle': [
+        'error',
+        {
+          allowAfterThis: true
+        }
+      ],
+      'no-unreachable': 'error',
+      'no-unsafe-negation': 'error',
+      'object-shorthand': 'off',
+      'one-var': [
+        'error',
+        'never'
+      ],
+      radix: 'error',
+      'sort-imports': [
+        'error',
+        {
+          allowSeparatedGroups: false,
+          ignoreDeclarationSort: true,
+          ignoreCase: true
+        }
+      ],
+      strict: [
+        'error',
+        'global'
+      ]
+    }
+  },
+  {
+    name: '@o3r/eslint-config/eslint-js/typescript',
+    files: [
+      '**/*.{c,m,}ts'
+    ],
+    rules: {
+      'new-cap': [
+        'error',
+        {
+          ...defaultNewCapOptions,
+          newIsCap: false
+        }
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/import-newlines.cjs

@@ -0,0 +1,23 @@
+'use strict';
+const importNewlinesPlugin = require('eslint-plugin-import-newlines');
+
+/** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} */
+const config = [
+  {
+    name: '@o3r/eslint-config/import-newlines',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    plugins: {
+      'import-newlines': importNewlinesPlugin
+    },
+    rules: {
+      'import-newlines/enforce': [
+        'error',
+        0
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/import.cjs

@@ -0,0 +1,29 @@
+'use strict';
+const importPlugin = require('eslint-plugin-import');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/import',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(importPlugin.flatConfigs.recommended),
+      ...convertWarningsToErrors(importPlugin.flatConfigs.typescript),
+      'import/first': 'error',
+      'import/newline-after-import': 'error',
+      'import/no-cycle': 'error',
+      'import/no-unresolved': 'error',
+      'import/order': ['error', {
+        'newlines-between': 'never',
+        alphabetize: { order: 'asc', caseInsensitive: true }
+      }]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/jest.cjs

@@ -0,0 +1,26 @@
+'use strict';
+const jest = require('eslint-plugin-jest');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/jest',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(jest.configs['flat/recommended']),
+      'jest/expect-expect': [
+        'error',
+        {
+          assertFunctionNames: ['expect', 'expectObservable']
+        }
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/jsdoc.cjs

@@ -0,0 +1,53 @@
+'use strict';
+const jsdoc = require('eslint-plugin-jsdoc');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/jsdoc',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(jsdoc.configs['flat/recommended']),
+      // TODO fix issue with ESLint v9+
+      // 'jsdoc/check-examples': ['error', {
+      //   'exampleCodeRegex': '^```(?:javascript|typescript|java|json|yaml|shell)?([\\s\\S]*)```\\s*$'
+      // }],
+      'jsdoc/check-tag-names': [
+        'error',
+        {
+          definedTags: ['note', 'title', 'o3rCategory', 'o3rCategories', 'o3rWidget', 'o3rWidgetParam', 'o3rRequired']
+        }
+      ],
+      'jsdoc/no-defaults': 'off',
+      'jsdoc/no-undefined-types': 'off',
+      'jsdoc/require-description': 'error',
+      'jsdoc/require-jsdoc': [
+        'error',
+        {
+          publicOnly: true
+        }
+      ],
+      'jsdoc/require-param-description': 'off',
+      'jsdoc/require-param-type': 'off',
+      'jsdoc/require-property-type': 'off',
+      'jsdoc/require-returns': 'off',
+      'jsdoc/require-returns-type': 'off'
+    }
+  },
+  {
+    name: '@o3r/eslint-config/jsdoc/js',
+    files: ['**/*.{c,m,}js'],
+    rules: {
+      'jsdoc/require-param-type': 'error',
+      'jsdoc/require-returns-description': 'off',
+      'jsdoc/require-returns-type': 'error'
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/otter.cjs

@@ -0,0 +1,24 @@
+'use strict';
+const o3rBaseConfig = require('../base.cjs');
+
+/**
+ * Get the @o3r typescript recommended rules
+ * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Plugin} plugin
+ * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.Config} config
+ */
+const o3rTypescriptRecommended = (plugin) => [
+  o3rBaseConfig(plugin),
+  {
+    name: '@o3r/eslint-config/typescript-recommended',
+    // Same files as the ones asked by `typescript-eslint` recommendation
+    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    rules: {
+      '@o3r/matching-configuration-name': 'error',
+      '@o3r/no-folder-import-for-module': 'error',
+      '@o3r/no-multiple-type-configuration-property': 'error',
+      '@o3r/o3r-categories-tags': 'error'
+    }
+  }
+];
+
+module.exports = o3rTypescriptRecommended;

package/src/rules/typescript/prefer-arrow.cjs

@@ -0,0 +1,25 @@
+'use strict';
+const preferArrowPlugin = require('eslint-plugin-prefer-arrow');
+
+/** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} */
+const config = [
+  {
+    name: '@o3r/eslint-config/prefer-arrow',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    plugins: {
+      'prefer-arrow': preferArrowPlugin
+    },
+    rules: {
+      'prefer-arrow/prefer-arrow-functions': [
+        'error',
+        {
+          allowStandaloneDeclarations: true
+        }
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/sort-export-all.cjs

@@ -0,0 +1,24 @@
+'use strict';
+module.exports = [];
+// TODO: reactivate once https://github.com/nirtamir2/eslint-plugin-sort-export-all/issues/18 is fixed
+// const sortExportAll = require('eslint-plugin-sort-export-all');
+
+// /**
+//  * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+//  */
+// const config = [
+//   {
+//     name: '@o3r/eslint-config/sort-export-all',
+//     plugins: {
+//       'sort-export-all': sortExportAll
+//     },
+//     files: [
+//       '**/*.{c,m,}{t,j}s'
+//     ],
+//     rules: {
+//       'sort-export-all/sort-export-all': 'error'
+//     }
+//   }
+// ];
+
+// module.exports = config;

package/src/rules/typescript/stylistic.cjs

@@ -0,0 +1,101 @@
+'use strict';
+const stylistic = require('@stylistic/eslint-plugin');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/stylistic',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(stylistic.configs['recommended-flat']),
+      '@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/indent': [
+        'error',
+        2,
+        {
+          FunctionDeclaration: {
+            parameters: 'off'
+          },
+          SwitchCase: 1
+        }
+      ],
+      '@stylistic/linebreak-style': [
+        'error',
+        'unix'
+      ],
+      '@stylistic/max-len': [
+        'error',
+        {
+          code: 200
+        }
+      ],
+      '@stylistic/member-delimiter-style': [
+        'error',
+        {
+          multiline: {
+            delimiter: 'semi',
+            requireLast: true
+          },
+          singleline: {
+            delimiter: 'semi',
+            requireLast: false
+          }
+        }
+      ],
+      '@stylistic/no-extra-semi': 'error',
+      '@stylistic/no-multiple-empty-lines': 'error',
+      '@stylistic/operator-linebreak': [
+        'error',
+        'before',
+        {
+          overrides: { '=': 'none' }
+        }
+      ],
+      '@stylistic/quotes': [
+        'error',
+        'single',
+        {
+          avoidEscape: true,
+          allowTemplateLiterals: true
+        }
+      ],
+      '@stylistic/quote-props': [
+        'error',
+        'as-needed'
+      ],
+      '@stylistic/semi': [
+        'error',
+        'always'
+      ],
+      '@stylistic/space-unary-ops': 'error',
+      '@stylistic/spaced-comment': [
+        'error',
+        'always',
+        {
+          markers: [
+            '/'
+          ]
+        }
+      ],
+      '@stylistic/wrap-iife': [
+        'error',
+        'inside'
+      ]
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/unicorn.cjs

@@ -0,0 +1,51 @@
+'use strict';
+const unicorn = require('eslint-plugin-unicorn');
+const { convertWarningsToErrors } = require('../utils.cjs');
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+  {
+    name: '@o3r/eslint-config/unicorn',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    rules: {
+      ...convertWarningsToErrors(unicorn.configs['flat/recommended']),
+      'unicorn/catch-error-name': 'off',
+      'unicorn/consistent-function-scoping': 'off',
+      'unicorn/filename-case': [
+        'error',
+        {
+          case: 'kebabCase',
+          ignore: [
+            '^public_api.[cm]?ts$'
+          ]
+        }
+      ],
+      'unicorn/import-style': 'off',
+      'unicorn/no-array-for-each': 'off',
+      'unicorn/no-array-reduce': 'off',
+      'unicorn/no-await-expression-member': 'off',
+      'unicorn/no-null': 'off',
+      'unicorn/no-typeof-undefined': 'off',
+      'unicorn/no-useless-undefined': 'off',
+      'unicorn/no-useless-promise-resolve-reject': 'off',
+      'unicorn/prefer-code-point': 'off',
+      'unicorn/prefer-dom-node-text-content': 'off',
+      'unicorn/prefer-global-this': 'off',
+      'unicorn/prefer-module': 'off',
+      'unicorn/prefer-set-has': 'off',
+      'unicorn/prefer-spread': 'off',
+      'unicorn/prefer-string-raw': 'off',
+      'unicorn/prefer-string-replace-all': 'off',
+      'unicorn/prefer-string-slice': 'off',
+      'unicorn/prefer-top-level-await': 'off',
+      'unicorn/prefer-type-error': 'off',
+      'unicorn/prevent-abbreviations': 'off'
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript/unused-imports.cjs

@@ -0,0 +1,20 @@
+'use strict';
+const unusedImportsPlugin = require('eslint-plugin-unused-imports');
+
+/** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} */
+const config = [
+  {
+    name: '@o3r/eslint-config/unused-imports',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    plugins: {
+      'unused-imports': unusedImportsPlugin
+    },
+    rules: {
+      'unused-imports/no-unused-imports': 'error'
+    }
+  }
+];
+
+module.exports = config;

package/src/rules/typescript.cjs

@@ -0,0 +1,138 @@
+'use strict';
+const eslint = require('@eslint/js');
+const comments = require('@eslint-community/eslint-plugin-eslint-comments/configs');
+const o3r = require('@o3r/eslint-plugin');
+const stylistic = require('@stylistic/eslint-plugin');
+const angular = require('angular-eslint');
+const importPlugin = require('eslint-plugin-import');
+const jsdoc = require('eslint-plugin-jsdoc');
+const unicorn = require('eslint-plugin-unicorn');
+const typescript = require('typescript-eslint');
+const commentsConfigOverrides = require('./typescript/comments.cjs');
+const angularConfigOverrides = require('./typescript/eslint-angular.cjs');
+const typescriptConfigOverrides = require('./typescript/eslint-typescript.cjs');
+const eslintConfigOverrides = require('./typescript/eslint.cjs');
+const importNewlinesConfig = require('./typescript/import-newlines.cjs');
+const importConfig = require('./typescript/import.cjs');
+const jsdocConfigOverrides = require('./typescript/jsdoc.cjs');
+const otterConfig = require('./typescript/otter.cjs');
+const preferArrowConfig = require('./typescript/prefer-arrow.cjs');
+// TODO: reactivate once https://github.com/nirtamir2/eslint-plugin-sort-export-all/issues/18 is fixed
+// const sortExportAll = require('./typescript/sort-export-all.cjs');
+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) => {
+  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']
+      }];
+  } catch {
+    return [];
+  }
+};
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const configArray = [
+  {
+    // Name added for debugging purpose with @eslint/config-inspector
+    name: '@eslint/js/recommended',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    ...eslint.configs.recommended
+  },
+  ...[
+    ...typescript.configs.recommended,
+    ...typescript.configs.recommendedTypeChecked,
+    ...angular.configs.tsRecommended
+  ].map((config) => ({
+    // Same files as the ones asked by `typescript-eslint/eslint-recommended`
+    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    ...config
+  })),
+  {
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    ...jsdoc.configs['flat/recommended']
+  },
+  {
+    // Name added for debugging purpose with @eslint/config-inspector
+    name: 'stylistic/recommended',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    ...stylistic.configs['recommended-flat']
+  },
+  {
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    ...unicorn.configs['flat/recommended']
+  },
+  ...(getJestConfig('recommended')),
+  {
+    // Name added for debugging purpose with @eslint/config-inspector
+    name: 'import/recommended',
+    files: ['**/*.{c,m,}{t,j}s'],
+    ...importPlugin.flatConfigs.recommended
+  },
+  {
+    // Name added for debugging purpose with @eslint/config-inspector
+    name: 'import/typescript',
+    files: ['**/*.{c,m,}ts'],
+    ...importPlugin.flatConfigs.typescript
+  },
+  comments.recommended,
+  // All recommended first as the order has an importance
+  ...eslintConfigOverrides,
+  ...commentsConfigOverrides,
+  ...typescriptConfigOverrides,
+  ...angularConfigOverrides,
+  ...jsdocConfigOverrides,
+  ...(getJestConfig('overrides')),
+  ...preferArrowConfig,
+  ...stylisticConfig,
+  ...unicornConfig,
+  ...importConfig,
+  ...importNewlinesConfig,
+  // TODO: reactivate once https://github.com/nirtamir2/eslint-plugin-sort-export-all/issues/18 is fixed
+  // ...sortExportAll,
+  ...unusedImportsConfig,
+  ...otterConfig(o3r),
+  {
+    name: '@o3r/eslint-config/typescript/language-options',
+    files: [
+      '**/*.{c,m,}{t,j}s'
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'module',
+      parserOptions: {
+        ecmaFeatures: {
+          modules: true,
+          jsx: false
+        }
+      }
+    }
+  }
+];
+
+module.exports = configArray;

package/src/rules/utils.cjs

@@ -0,0 +1,21 @@
+'use strict';
+/**
+ * Convert the rules set as `warn` to `error`
+ * @param {import('@typescript-eslint/utils').TSESLint.FlatConfig.Config | import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} config config to process
+ * @returns {import('@typescript-eslint/utils').TSESLint.FlatConfig.Rules} only the upgraded rules
+ */
+function convertWarningsToErrors(config) {
+  /** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.Rules} */
+  const warningRulesUpgraded = {};
+  (Array.isArray(config) ? config : [config]).forEach(({ rules = {} }) => {
+    Object.entries(rules).forEach(([ruleName, ruleEntry]) => {
+      const severity = Array.isArray(ruleEntry) ? ruleEntry[0] : ruleEntry;
+      if (severity === 1 || severity === 'warn') {
+        warningRulesUpgraded[ruleName] = Array.isArray(ruleEntry) ? ['error', ...ruleEntry.slice(1)] : 'error';
+      }
+    });
+  });
+  return warningRulesUpgraded;
+}
+
+module.exports = { convertWarningsToErrors };