Repository navigation
ESLint for JSDoc #18
Description
eslint.config.js
{
// https://github.com/gajus/eslint-plugin-jsdoc
name: 'jsdoc',
files: ['**/*.js', '**/*.ts'],
extends: [
jsdoc.configs['flat/recommended-typescript']
]
},/workspaces/wattbox-api (lint) $ eslint
/workspaces/wattbox-api/src/client.ts
21:1 warning Expected only 0 line after block description jsdoc/tag-lines
23:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
24:1 warning Expected no lines between tags jsdoc/tag-lines
114:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
115:1 warning Expected only 0 line after block description jsdoc/tag-lines
117:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
118:1 warning Expected no lines between tags jsdoc/tag-lines
128:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
129:1 warning Expected only 0 line after block description jsdoc/tag-lines
131:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
132:1 warning Expected no lines between tags jsdoc/tag-lines
142:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
143:1 warning Expected only 0 line after block description jsdoc/tag-lines
145:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
146:1 warning Expected no lines between tags jsdoc/tag-lines
156:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
157:1 warning Expected only 0 line after block description jsdoc/tag-lines
159:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
160:1 warning Expected no lines between tags jsdoc/tag-lines
170:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
171:1 warning Expected only 0 line after block description jsdoc/tag-lines
173:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
174:1 warning Expected no lines between tags jsdoc/tag-lines
184:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
185:1 warning Expected only 0 line after block description jsdoc/tag-lines
187:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
188:1 warning Expected no lines between tags jsdoc/tag-lines
198:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
199:1 warning Expected only 0 line after block description jsdoc/tag-lines
202:1 warning Expected no lines between tags jsdoc/tag-lines
203:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
226:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
228:1 warning Expected only 0 line after block description jsdoc/tag-lines
230:1 warning @param "outlet" does not match an existing function parameter jsdoc/check-param-names
231:1 warning Expected no lines between tags jsdoc/tag-lines
232:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
243:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
244:1 warning Expected only 0 line after block description jsdoc/tag-lines
246:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
247:1 warning Expected no lines between tags jsdoc/tag-lines
269:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
270:1 warning Expected only 0 line after block description jsdoc/tag-lines
272:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
273:1 warning Expected no lines between tags jsdoc/tag-lines
283:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
284:1 warning Expected only 0 line after block description jsdoc/tag-lines
286:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
287:1 warning Expected no lines between tags jsdoc/tag-lines
297:5 warning Missing JSDoc @returns declaration jsdoc/require-returns
298:1 warning Expected only 0 line after block description jsdoc/tag-lines
300:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
301:1 warning Expected no lines between tags jsdoc/tag-lines
361:1 warning Expected only 0 line after block description jsdoc/tag-lines
363:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
364:1 warning Expected no lines between tags jsdoc/tag-lines
373:1 warning Expected only 0 line after block description jsdoc/tag-lines
376:1 warning Expected no lines between tags jsdoc/tag-lines
377:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
389:1 warning Expected only 0 line after block description jsdoc/tag-lines
393:1 warning Expected no lines between tags jsdoc/tag-lines
394:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
404:1 warning Expected only 0 line after block description jsdoc/tag-lines
408:1 warning Expected no lines between tags jsdoc/tag-lines
409:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
419:1 warning Expected only 0 line after block description jsdoc/tag-lines
423:1 warning Expected no lines between tags jsdoc/tag-lines
424:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
434:1 warning Expected only 0 line after block description jsdoc/tag-lines
438:1 warning Expected no lines between tags jsdoc/tag-lines
439:1 warning Invalid JSDoc tag name "remarks" jsdoc/check-tag-names
/workspaces/wattbox-api/src/example.ts
4:1 warning Missing JSDoc comment jsdoc/require-jsdoc
✖ 71 problems (0 errors, 71 warnings)
0 errors and 39 warnings potentially fixable with the `--fix` option.
Activity
michaelahern commentedon Apr 3, 2026
Implemented in #40