Update README.md

[poolifier.git] / .eslintrc.js

diff --git a/.eslintrc.js b/.eslintrc.js
index 04c5b05b596ab76bf7a9aa897900b190e4791b49..6c8063c8a5dcb3da31ee2f12a826b4017263bdfb 100644 (file)
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -9,7 +9,13 @@ module.exports = {
     ecmaVersion: 2020,
     sourceType: 'module'
   },
-  plugins: ['@typescript-eslint', 'promise', 'prettierx'],
+  plugins: [
+    '@typescript-eslint',
+    'promise',
+    'prettierx',
+    'jsdoc',
+    'spellcheck'
+  ],
   extends: [
     'standard',
     'eslint:recommended',
@@ -38,9 +44,36 @@ module.exports = {
         ignoreMemberSort: true,
         ignoreDeclarationSort: true
       }
+    ],
+
+    'spellcheck/spell-checker': [
+      'warn',
+      {
+        skipWords: [
+          'poolifier',
+          'pioardi',
+          'christopher',
+          'ecma',
+          'jsdoc',
+          'readonly',
+          'serializable',
+          'unregister',
+          'workerpool'
+        ],
+        skipIfMatch: ['^@.*', '^plugin:.*']
+      }
     ]
   },
   overrides: [
+    {
+      files: ['src/**/*.ts'],
+      extends: 'plugin:jsdoc/recommended',
+      rules: {
+        'jsdoc/no-types': 'error',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/require-returns-type': 'off'
+      }
+    },
     {
       files: ['*.js'],
       extends: 'plugin:node/recommended',