patch tsdoc/syntax (#122)

.eslintrc.cjs

@@ -7,7 +7,7 @@ module.exports = {
   },
   extends: ['love'],
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc'],
+  plugins: ['@typescript-eslint', 'eslint-plugin-local-rules'],
   parserOptions: {
     project: true,
   },
@@ -17,10 +17,10 @@ module.exports = {
     '@typescript-eslint/return-await': 'off',
     '@typescript-eslint/strict-boolean-expressions': 'off',
     '@typescript-eslint/unbound-method': 'off',
+    'local-rules/tsdoc/syntax': 'warn',
     'multiline-ternary': 'off',
     'no-extra-boolean-cast': 'off',
     'no-return-await': 'off',
-    'tsdoc/syntax': 'warn',
     '@typescript-eslint/no-invalid-void-type': ['error', {
       allowAsThisParameter: true,
     }],

.npmignore

@@ -148,6 +148,7 @@ out
 /.gitattributes
 /.github
 /.rollup.cache
+/*.cjs
 /*.ts
 /dist/assets
 /jest.config.cjs

eslint-local-rules.cjs

@@ -0,0 +1,29 @@
+// https://github.com/microsoft/tsdoc/issues/220#issuecomment-1629947425
+// eslint-disable-file
+const _ = require('lodash')
+const eslintPluginTsdoc = require('eslint-plugin-tsdoc')
+const fs = require('fs')
+
+fs.writeFileSync('./debug.txt', 'test\r\n', { flag: 'as' })
+
+function eslintPluginTsdocPatch () {
+  const origRule = eslintPluginTsdoc.rules.syntax
+  return {
+    ...origRule,
+    create: context => {
+      const patched = {
+        report: opts => {
+          // fs.writeFileSync('./debug.txt', `${JSON.stringify(opts)}\r\n`, { flag: 'as' })
+          if (opts.messageId === 'tsdoc-param-tag-with-invalid-name' && opts?.data?.unformattedText?.indexOf?.('non-word characters') !== -1) return
+          return context.report(opts)
+        },
+      }
+      Object.setPrototypeOf(patched, context)
+      return origRule.create(patched)
+    },
+  }
+}
+
+module.exports = {
+  'tsdoc/syntax': eslintPluginTsdocPatch(),
+}

package.json

@@ -51,6 +51,7 @@
     "eslint-config-love": "^43",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-local-rules": "^2.0.1",
     "eslint-plugin-n": "^17.7.0",
     "eslint-plugin-promise": "^6.2.0",
     "eslint-plugin-pug": "^1.2.5",