Skip to content

Commit 6d3c259

Browse files
ryancbahanclaude
andcommitted
Remove eslint-plugin-jsdoc from eslint-plugin-cli
Move the jsdoc plugin dependency and registration from eslint-plugin-cli to the root eslint.config.js where the jsdoc rules are actually configured. The single jsdoc/require-returns-description rule that was in eslint-plugin-cli's config.js is redundant with the comprehensive jsdoc rule set in the root config, so it's removed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 85b975c commit 6d3c259

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

eslint.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import nxPlugin from '@nx/eslint-plugin'
22
import cliPlugin from '@shopify/eslint-plugin-cli'
3+
import jsdocPlugin from 'eslint-plugin-jsdoc'
34

45
// Spread the CLI plugin's base config which includes all necessary plugins
56
const config = [
@@ -44,6 +45,9 @@ const config = [
4445
'**/public/node/result.ts',
4546
'**/public/node/themes/**/*',
4647
],
48+
plugins: {
49+
jsdoc: jsdocPlugin,
50+
},
4751
settings: {
4852
jsdoc: {
4953
publicFunctionsOnly: true,

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"bugsnag-build-reporter": "^2.0.0",
5757
"commander": "^9.4.0",
5858
"esbuild": "0.27.4",
59+
"eslint-plugin-jsdoc": "50.7.1",
5960
"eslint": "^9.26.0",
6061
"execa": "^7.2.0",
6162
"fast-glob": "3.3.3",

packages/eslint-plugin-cli/config.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ const shopifyPlugin = require('@shopify/eslint-plugin')
22
const vitestPlugin = require('@vitest/eslint-plugin')
33
const unusedImportsPlugin = require('eslint-plugin-unused-imports')
44
const tsdocPlugin = require('eslint-plugin-tsdoc')
5-
const jsdocPlugin = require('eslint-plugin-jsdoc')
65
const noCatchAllPlugin = require('eslint-plugin-no-catch-all')
76
const eslintConfigPrettier = require('eslint-config-prettier')
87
const globals = require('globals')
@@ -176,7 +175,6 @@ const baseRules = {
176175
},
177176
],
178177
'tsdoc/syntax': 'error',
179-
'jsdoc/require-returns-description': 'error',
180178
'promise/catch-or-return': ['error', {allowFinally: true}],
181179
'no-unused-vars': 'off',
182180
'@typescript-eslint/no-unused-vars': [
@@ -280,7 +278,6 @@ const config = [
280278
vitest: vitestPlugin,
281279
'unused-imports': unusedImportsPlugin,
282280
tsdoc: tsdocPlugin,
283-
jsdoc: jsdocPlugin,
284281
'no-catch-all': noCatchAllPlugin,
285282
'@shopify/cli': cliPlugin,
286283
},

packages/eslint-plugin-cli/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"@typescript-eslint/eslint-plugin": "8.56.1",
2121
"@typescript-eslint/parser": "8.56.1",
2222
"eslint-config-prettier": "10.1.5",
23-
"eslint-plugin-jsdoc": "50.7.1",
2423
"eslint-plugin-no-catch-all": "1.1.0",
2524
"eslint-plugin-prettier": "5.5.1",
2625
"eslint-plugin-react": "7.37.5",

pnpm-lock.yaml

Lines changed: 3 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)