@averay/codeformat 0.1.8 → 0.1.9

package/index.js

@@ -5,6 +5,7 @@ import typescriptParser from '@typescript-eslint/parser';
 import prettierConfig from 'eslint-config-prettier';
 import eslintCommentsPlugin from 'eslint-plugin-eslint-comments';
 import importPlugin from 'eslint-plugin-import';
+import jsdocPlugin from 'eslint-plugin-jsdoc';
 import promisePlugin from 'eslint-plugin-promise';
 import regexpPlugin from 'eslint-plugin-regexp';
 import sonarjsPlugin from 'eslint-plugin-sonarjs';
@@ -21,6 +22,10 @@ export const extensions = {
   ts: ['ts', 'tsx', 'cts', 'cts', 'mts', 'mtsx'],
 };
 
+/**
+ * @param {{ tsconfigPath?: string }} options Project-specific customisations
+ * @returns {object[]} The complete ESLint config
+ */
 export function makeEslintConfig(options = {}) {
   return [
     // JavaScript & TypeScript
@@ -34,6 +39,7 @@ export function makeEslintConfig(options = {}) {
       plugins: {
         'eslint-comments': eslintCommentsPlugin,
         import: importPlugin,
+        jsdoc: jsdocPlugin,
         promise: promisePlugin,
         regexp: regexpPlugin,
         sonarjs: sonarjsPlugin,
@@ -52,7 +58,7 @@ export function makeEslintConfig(options = {}) {
       files: [`**/*.{${extensions.ts.join(',')}}`],
       languageOptions: {
         parser: typescriptParser,
-        parserOptions: { project: options.tsconfigPath },
+        parserOptions: options.tsconfigPath == null ? {} : { project: options.tsconfigPath },
       },
       plugins: {
         '@typescript-eslint': typescriptPlugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@averay/codeformat",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "author": "Adam Averay (https://adamaveray.com.au/)",
   "homepage": "https://github.com/adamaveray/codeformat",
   "repository": {
@@ -39,6 +39,7 @@
     "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^40.0.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-regexp": "^1.12.0",
     "eslint-plugin-sonarjs": "^0.18.0",

package/rulesets/ruleset-shared.js

@@ -2,6 +2,7 @@
 
 import eslintCommentsPlugin from 'eslint-plugin-eslint-comments';
 import importPlugin from 'eslint-plugin-import';
+import jsdocPlugin from 'eslint-plugin-jsdoc';
 import promisePlugin from 'eslint-plugin-promise';
 import regexpPlugin from 'eslint-plugin-regexp';
 import sonarjsPlugin from 'eslint-plugin-sonarjs';
@@ -258,6 +259,17 @@ export default {
   ],
   'import/prefer-default-export': 'error',
 
+  ...jsdocPlugin.configs.recommended.rules,
+  'jsdoc/check-indentation': 'error',
+  'jsdoc/check-syntax': 'error',
+  'jsdoc/match-description': ['error', { matchDescription: '[A-Z]', tags: { param: true, returns: true } }],
+  'jsdoc/no-bad-blocks': 'error',
+  'jsdoc/no-defaults': 'error',
+  'jsdoc/require-asterisk-prefix': 'error',
+  'jsdoc/require-jsdoc': 'off',
+  'jsdoc/require-returns': 'off',
+  'jsdoc/sort-tags': 'error',
+
   ...promisePlugin.configs.recommended.rules,
   'promise/no-multiple-resolved': 'error',
 

package/rulesets/ruleset-typescript.js

@@ -219,4 +219,8 @@ export default {
   '@typescript-eslint/triple-slash-reference': 'error',
   '@typescript-eslint/unbound-method': 'off', // Does not support @autobind nor recognise binding in constructors
   '@typescript-eslint/unified-signatures': 'error',
+
+  'jsdoc/no-types': 'error',
+  'jsdoc/require-param-type': 'off',
+  'jsdoc/require-returns-type': 'off',
 };