diff --git a/eslint.config.js b/eslint.config.js index dd96a5b50e..2ef521d66a 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -1,5 +1,6 @@ import nxPlugin from '@nx/eslint-plugin' import cliPlugin from '@shopify/eslint-plugin-cli' +import jsdocPlugin from 'eslint-plugin-jsdoc' // Spread the CLI plugin's base config which includes all necessary plugins const config = [ @@ -44,6 +45,9 @@ const config = [ '**/public/node/result.ts', '**/public/node/themes/**/*', ], + plugins: { + jsdoc: jsdocPlugin, + }, settings: { jsdoc: { publicFunctionsOnly: true, diff --git a/package.json b/package.json index cd81b6826d..fc6802e3a9 100644 --- a/package.json +++ b/package.json @@ -56,6 +56,7 @@ "bugsnag-build-reporter": "^2.0.0", "commander": "^9.4.0", "esbuild": "0.27.4", + "eslint-plugin-jsdoc": "50.7.1", "eslint": "^9.26.0", "execa": "^7.2.0", "fast-glob": "3.3.3", diff --git a/packages/eslint-plugin-cli/config.js b/packages/eslint-plugin-cli/config.js index 8a67005dff..b01187d5f8 100644 --- a/packages/eslint-plugin-cli/config.js +++ b/packages/eslint-plugin-cli/config.js @@ -2,7 +2,6 @@ const shopifyPlugin = require('@shopify/eslint-plugin') const vitestPlugin = require('@vitest/eslint-plugin') const unusedImportsPlugin = require('eslint-plugin-unused-imports') const tsdocPlugin = require('eslint-plugin-tsdoc') -const jsdocPlugin = require('eslint-plugin-jsdoc') const noCatchAllPlugin = require('eslint-plugin-no-catch-all') const eslintConfigPrettier = require('eslint-config-prettier') const globals = require('globals') @@ -176,7 +175,6 @@ const baseRules = { }, ], 'tsdoc/syntax': 'error', - 'jsdoc/require-returns-description': 'error', 'promise/catch-or-return': ['error', {allowFinally: true}], 'no-unused-vars': 'off', '@typescript-eslint/no-unused-vars': [ @@ -280,7 +278,6 @@ const config = [ vitest: vitestPlugin, 'unused-imports': unusedImportsPlugin, tsdoc: tsdocPlugin, - jsdoc: jsdocPlugin, 'no-catch-all': noCatchAllPlugin, '@shopify/cli': cliPlugin, }, diff --git a/packages/eslint-plugin-cli/package.json b/packages/eslint-plugin-cli/package.json index 3183b3105e..30988fc923 100644 --- a/packages/eslint-plugin-cli/package.json +++ b/packages/eslint-plugin-cli/package.json @@ -20,7 +20,6 @@ "@typescript-eslint/eslint-plugin": "8.56.1", "@typescript-eslint/parser": "8.56.1", "eslint-config-prettier": "10.1.5", - "eslint-plugin-jsdoc": "50.7.1", "eslint-plugin-no-catch-all": "1.1.0", "eslint-plugin-prettier": "5.5.1", "eslint-plugin-react": "7.37.5", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index dca1381823..de8fba7428 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -82,6 +82,9 @@ importers: eslint: specifier: ^9.26.0 version: 9.39.3(jiti@2.6.1) + eslint-plugin-jsdoc: + specifier: 50.7.1 + version: 50.7.1(eslint@9.39.3(jiti@2.6.1)) execa: specifier: ^7.2.0 version: 7.2.0 @@ -569,9 +572,6 @@ importers: eslint-config-prettier: specifier: 10.1.5 version: 10.1.5(eslint@9.39.3(jiti@2.6.1)) - eslint-plugin-jsdoc: - specifier: 50.7.1 - version: 50.7.1(eslint@9.39.3(jiti@2.6.1)) eslint-plugin-no-catch-all: specifier: 1.1.0 version: 1.1.0(eslint@9.39.3(jiti@2.6.1)) @@ -12532,7 +12532,6 @@ snapshots: '@vitest/eslint-plugin': 1.1.44(@typescript-eslint/utils@8.56.1(eslint@9.39.3(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.3(jiti@2.6.1))(typescript@5.9.3)(vitest@3.2.4(@types/node@18.19.70)(jiti@2.6.1)(jsdom@28.1.0)(msw@2.12.10(@types/node@18.19.70)(typescript@5.9.3))(sass@1.97.3)(yaml@2.8.3)) eslint: 9.39.3(jiti@2.6.1) eslint-config-prettier: 10.1.5(eslint@9.39.3(jiti@2.6.1)) - eslint-plugin-jsdoc: 50.7.1(eslint@9.39.3(jiti@2.6.1)) eslint-plugin-no-catch-all: 1.1.0(eslint@9.39.3(jiti@2.6.1)) eslint-plugin-prettier: 5.5.1(eslint-config-prettier@10.1.5(eslint@9.39.3(jiti@2.6.1)))(eslint@9.39.3(jiti@2.6.1))(prettier@3.8.1) eslint-plugin-react: 7.37.5(eslint@9.39.3(jiti@2.6.1))