Skip to content

Remove hidden commands from JSON output exceptions #8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gonzaloriestra merged 1 commit into from
Sep 29, 2026
Merged

Remove hidden commands from JSON output exceptions #8685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/eslint-plugin-cli/rules/command-json-output.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ module.exports = {
if (node.declaration.type !== 'ClassDeclaration') return

const classMembers = node.declaration.body.body
if (classMembers.some((member) => isStaticMemberNamed(member, 'hidden') && member.value?.value === true)) return

if (!hasJsonOutputSchema(classMembers)) {
context.report({node: node.declaration, messageId: 'missingJsonOutputSchema'})
Expand Down
18 changes: 18 additions & 0 deletions packages/eslint-plugin-cli/rules/command-json-output.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ const ruleTester = new RuleTester({

ruleTester.run('command-json-output', rule, {
valid: [
{
name: 'hidden command without JSON support',
filename: '/repo/packages/app/src/cli/commands/app/widgets/hidden.ts',
options: [{exceptions: []}],
code: 'export default class Hidden extends Command { static hidden = true }',
},
{
name: 'finite query command',
filename: '/repo/packages/app/src/cli/commands/app/widgets/list.ts',
Expand Down Expand Up @@ -72,6 +78,18 @@ ruleTester.run('command-json-output', rule, {
},
],
invalid: [
{
name: 'explicitly visible command without JSON support',
filename: '/repo/packages/app/src/cli/commands/app/widgets/visible.ts',
code: 'export default class Visible extends Command { static hidden = false }',
errors: [{messageId: 'missingJsonOutputSchema'}, {messageId: 'missingJsonFlag'}],
},
{
name: 'instance hidden property does not hide a command',
filename: '/repo/packages/app/src/cli/commands/app/widgets/visible.ts',
code: 'export default class Visible extends Command { hidden = true }',
errors: [{messageId: 'missingJsonOutputSchema'}, {messageId: 'missingJsonFlag'}],
},
{
name: 'custom exceptions do not exempt new subcommands',
filename: '/hydrogen/packages/cli/src/commands/hydrogen/dev/status.ts',
Expand Down
18 changes: 0 additions & 18 deletions packages/eslint-plugin-cli/rules/json-output-command-exceptions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ const commandExceptions = [
'packages/app/src/cli/commands/app/config/validate.ts',
'packages/app/src/cli/commands/app/deploy.ts',
'packages/app/src/cli/commands/app/dev/clean.ts',
'packages/app/src/cli/commands/app/security/check.ts',
'packages/app/src/cli/commands/app/security/instructions.ts',
'packages/app/src/cli/commands/app/security/submit.ts',
'packages/app/src/cli/commands/app/env/pull.ts',
'packages/app/src/cli/commands/app/env/show.ts',
'packages/app/src/cli/commands/app/execute.ts',
Expand All @@ -25,8 +22,6 @@ const commandExceptions = [
'packages/app/src/cli/commands/app/function/schema.ts',
'packages/app/src/cli/commands/app/function/typegen.ts',
'packages/app/src/cli/commands/app/generate/extension.ts',
'packages/app/src/cli/commands/app/import-custom-data-definitions.ts',
'packages/app/src/cli/commands/app/import-extensions.ts',
'packages/app/src/cli/commands/app/import/custom-data-definitions.ts',
'packages/app/src/cli/commands/app/import/dashboard-extensions.ts',
'packages/app/src/cli/commands/app/init.ts',
Expand All @@ -39,23 +34,11 @@ const commandExceptions = [
'packages/app/src/cli/commands/app/webhook/trigger.ts',
'packages/cli/src/cli/commands/auth/login.ts',
'packages/cli/src/cli/commands/auth/logout.ts',
'packages/cli/src/cli/commands/cache/clear.ts',
'packages/cli/src/cli/commands/config/autoupgrade/off.ts',
'packages/cli/src/cli/commands/config/autoupgrade/on.ts',
'packages/cli/src/cli/commands/config/autoupgrade/status.ts',
'packages/cli/src/cli/commands/debug/command-flags.ts',
'packages/cli/src/cli/commands/doc/fetch.ts',
'packages/cli/src/cli/commands/doc/search.ts',
'packages/cli/src/cli/commands/docs/generate.ts',
'packages/cli/src/cli/commands/doctor-release/doctor-release.ts',
'packages/cli/src/cli/commands/doctor-release/theme/index.ts',
'packages/cli/src/cli/commands/kitchen-sink/async.ts',
'packages/cli/src/cli/commands/kitchen-sink/index.ts',
'packages/cli/src/cli/commands/kitchen-sink/prompts.ts',
'packages/cli/src/cli/commands/kitchen-sink/static.ts',
'packages/cli/src/cli/commands/notifications/generate.ts',
'packages/cli/src/cli/commands/notifications/list.ts',
'packages/cli/src/cli/commands/send-analytics.ts',
'packages/cli/src/cli/commands/upgrade.ts',
'packages/plugin-did-you-mean/src/commands/config/autocorrect/off.ts',
'packages/plugin-did-you-mean/src/commands/config/autocorrect/on.ts',
Expand All @@ -78,7 +61,6 @@ const commandExceptions = [
'packages/theme/src/cli/commands/theme/share.ts',

// Streaming commands without a single finite result.
'packages/app/src/cli/commands/app/demo/watcher.ts',
'packages/app/src/cli/commands/app/dev.ts',
'packages/app/src/cli/commands/app/graphiql.ts',
'packages/app/src/cli/commands/app/logs.ts',
Expand Down
Loading