Add some missing jsdoc comments, add jsdoc eslint plugin (#6048)

* Add some missing jsdoc comments, add jsdoc eslint plugin

* remove left over addition

Co-authored-by: absidue <48293849+absidue@users.noreply.github.com>

* move jsdoc eslint rule configuration

* use dash for list instead

* Enable some additional rules

* Apply suggestions from code review

Co-authored-by: PikachuEXE <git@pikachuexe.net>

---------

Co-authored-by: absidue <48293849+absidue@users.noreply.github.com>
Co-authored-by: PikachuEXE <git@pikachuexe.net>
This commit is contained in:
ChunkyProgrammer
2024-11-02 06:38:07 -04:00
committed by GitHub
parent a2df91f1dc
commit a28bb3f0f5
28 changed files with 248 additions and 56 deletions

View File

@@ -10,6 +10,7 @@ import eslintPluginJsonc from 'eslint-plugin-jsonc'
import eslintPluginYml from 'eslint-plugin-yml'
import yamlEslintParser from 'yaml-eslint-parser'
import neostandard from 'neostandard'
import jsdoc from 'eslint-plugin-jsdoc'
import activeLocales from './static/locales/activeLocales.json' with { type: 'json' }
@@ -40,6 +41,7 @@ export default [
],
plugins: {
unicorn: eslintPluginUnicorn,
jsdoc,
},
languageOptions: {
@@ -115,6 +117,15 @@ export default [
'@intlify/vue-i18n/no-deprecated-tc': 'off',
'vue/require-explicit-emits': 'error',
'vue/no-unused-emit-declarations': 'error',
'jsdoc/check-alignment': 'error',
'jsdoc/check-property-names': 'error',
'jsdoc/check-param-names': 'error',
'jsdoc/check-syntax': 'error',
'jsdoc/check-template-names': 'error',
'jsdoc/check-types': 'error',
'jsdoc/no-bad-blocks': 'error',
'jsdoc/no-multi-asterisks': 'error',
},
},