Skip to content

Commit 54ec93c

Browse files
committed
fix: re-enable jsdoc checks
I forgot to add `eslint-plugin-jsdoc` when creating our new configuration, even though it's present in the legacy configurations. This change re-adds the plugin and configures it for better interaction with TypeScript.
1 parent 4500572 commit 54ec93c

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

lib/eslint.mjs

+24
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import formatjs from 'eslint-plugin-formatjs'
33
import html from 'eslint-plugin-html'
44
import htmlSettings from 'eslint-plugin-html/src/settings.js'
55
import importPlugin from 'eslint-plugin-import'
6+
import jsdoc from 'eslint-plugin-jsdoc'
67
import jsxA11y from 'eslint-plugin-jsx-a11y'
78
import markdown from 'eslint-plugin-markdown'
89
import react from 'eslint-plugin-react'
@@ -131,6 +132,29 @@ const makeEslintConfig = ({ tsconfigRootDir, globals: globalsIn } = {}) => {
131132
'import/no-duplicates': 'error', // Forbid duplicate imports
132133
},
133134
},
135+
// eslint-plugin-jsdoc
136+
jsdoc.configs['flat/recommended-error'],
137+
{
138+
files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
139+
extends: [jsdoc.configs['flat/recommended-typescript-error']],
140+
},
141+
{
142+
rules: {
143+
// If JSDoc comments are present, they must be informative (non-trivial).
144+
// For example, the description "The foo." on a variable called "foo" is not informative.
145+
// https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md
146+
'jsdoc/informative-docs': ['error'],
147+
148+
// Require JSDoc comments on public / exported items.
149+
// https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md
150+
'jsdoc/require-jsdoc': [
151+
'error',
152+
{
153+
publicOnly: true,
154+
},
155+
],
156+
},
157+
},
134158
// eslint-plugin-jsx-a11y
135159
jsxA11y.flatConfigs.recommended,
136160
// eslint-plugin-markdown

lib/prettier.mjs

+1-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ const prettierConfig = {
2323
}
2424

2525
/**
26-
* Make a Prettier configuration for Scratch style.
27-
* @returns {import("prettier").Config}
26+
* @returns {import("prettier").Config} A Prettier configuration for Scratch style.
2827
*/
2928
const makePrettierConfig = () => prettierConfig
3029

0 commit comments

Comments
 (0)