Apply dependencies update

[poolifier.git] / .eslintrc.js

diff --git a/.eslintrc.js b/.eslintrc.js
index 6c8063c8a5dcb3da31ee2f12a826b4017263bdfb..93a3c1bdc09c590ba0ff0986dedafab0e8d4e0e8 100644 (file)
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -1,43 +1,28 @@
-module.exports = {
+// @ts-check
+const { defineConfig } = require('eslint-define-config')
+
+module.exports = defineConfig({
   env: {
     es2021: true,
     node: true,
     mocha: true
   },
-  parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module'
   },
-  plugins: [
-    '@typescript-eslint',
-    'promise',
-    'prettierx',
-    'jsdoc',
-    'spellcheck'
-  ],
+  plugins: ['promise', 'prettierx', 'jsdoc', 'spellcheck'],
   extends: [
     'standard',
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:import/errors',
-    'plugin:import/warnings',
-    'plugin:import/typescript',
+    'plugin:import/recommended',
+    'plugin:jsdoc/recommended',
     'plugin:promise/recommended',
-    'plugin:prettierx/standardx',
-    'plugin:prettierx/@typescript-eslint'
+    'plugin:prettierx/standardx'
   ],
   rules: {
     'no-void': 'off',
 
-    // We have some intentionally empty functions
-    '@typescript-eslint/no-empty-function': 'off',
-
-    '@typescript-eslint/no-inferrable-types': [
-      'error',
-      { ignoreProperties: true }
-    ],
-
     'sort-imports': [
       'warn',
       {
@@ -50,11 +35,13 @@ module.exports = {
       'warn',
       {
         skipWords: [
-          'poolifier',
-          'pioardi',
           'christopher',
+          'comparator',
           'ecma',
+          'enum',
+          'inheritdoc',
           'jsdoc',
+          'poolifier',
           'readonly',
           'serializable',
           'unregister',
@@ -66,33 +53,93 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['src/**/*.ts'],
-      extends: 'plugin:jsdoc/recommended',
+      files: ['**/*.ts'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint'],
+      extends: [
+        'plugin:@typescript-eslint/recommended',
+        'plugin:import/typescript'
+      ],
       rules: {
+        // We have some intentionally empty functions
+        '@typescript-eslint/no-empty-function': 'off',
+
+        '@typescript-eslint/no-inferrable-types': [
+          'error',
+          { ignoreProperties: true }
+        ],
+
+        'no-useless-constructor': 'off',
+
+        'jsdoc/match-description': [
+          'warn',
+          {
+            // mainDescription:
+            //   '/^[A-Z`].+?(\\.|:)(\\n\\n.*((\\n{1,2}- .+)|(_.+_)|`.+`|\\n\\n---))?$/us',
+            // matchDescription: '^[A-Z`].+(\\.|`.+`)$',
+            contexts: ['any'],
+            tags: {
+              param: true,
+              returns: true
+            }
+          }
+        ],
         'jsdoc/no-types': 'error',
+        'jsdoc/require-jsdoc': [
+          'warn',
+          {
+            contexts: [
+              'ClassDeclaration',
+              'ClassProperty:not([accessibility=/(private|protected)/])',
+              'ExportNamedDeclaration:has(VariableDeclaration)',
+              'FunctionExpression',
+              'MethodDefinition:not([accessibility=/(private|protected)/]) > FunctionExpression',
+              'TSEnumDeclaration',
+              'TSInterfaceDeclaration',
+              'TSMethodSignature',
+              // 'TSPropertySignature',
+              'TSTypeAliasDeclaration'
+            ]
+          }
+        ],
         'jsdoc/require-param-type': 'off',
         'jsdoc/require-returns-type': 'off'
       }
     },
     {
-      files: ['*.js'],
-      extends: 'plugin:node/recommended',
+      files: ['**/*.js'],
+      extends: 'plugin:node/recommended'
+    },
+    {
+      files: ['tests/**/*.js'],
       rules: {
-        '@typescript-eslint/no-unused-vars': 'off',
-        '@typescript-eslint/no-var-requires': 'off'
+        'jsdoc/require-jsdoc': 'off'
       }
     },
     {
-      files: ['examples/typescript/**/*.ts'],
+      files: ['benchmarks/**/*.js'],
       rules: {
-        'import/no-unresolved': 'off'
+        'jsdoc/require-jsdoc': 'off'
       }
     },
     {
       files: ['examples/**/*.js'],
       rules: {
-        'node/no-missing-require': 'off'
+        'node/no-missing-require': 'off',
+        'jsdoc/require-jsdoc': 'off'
       }
+    },
+    {
+      files: ['examples/typescript/**/*.ts'],
+      rules: {
+        'import/no-unresolved': 'off',
+        'jsdoc/require-jsdoc': 'off'
+      }
+    }
+  ],
+  settings: {
+    jsdoc: {
+      mode: 'typescript'
     }
-  ]
-}
+  }
+})