Skip to content

Docs: Fixing --exact-port CLI Options Documentation#33013

Merged
jonniebigodes merged 6 commits into
storybookjs:nextfrom
nnt1054:patch-1
Nov 18, 2025
Merged

Docs: Fixing --exact-port CLI Options Documentation#33013
jonniebigodes merged 6 commits into
storybookjs:nextfrom
nnt1054:patch-1

Conversation

@nnt1054
Copy link
Copy Markdown
Contributor

@nnt1054 nnt1054 commented Nov 12, 2025

What I did

Fixing --exact-port CLI option documentation from an integer to a boolean.
--exact-port is a boolean as shown in the CLIOptions interface here: https://github.com/storybookjs/storybook/blob/next/code/core/src/types/modules/core-common.ts#L177-L201

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

Reviewed markdown preview for the updated CLI options documentation file in branch here: https://github.com/nnt1054/storybook/blob/patch-1/docs/api/cli-options.mdx

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Updated --exact-port CLI option documentation. Changed from a parameter-based option to a flag, now used with -p to specify the port number.

updating documentation for `--exact-port` CLI option
@nnt1054 nnt1054 changed the title Update cli-options.mdx Fixing --exact-port CLI Options Documentation Nov 12, 2025
@nnt1054 nnt1054 changed the title Fixing --exact-port CLI Options Documentation Docs: Fixing --exact-port CLI Options Documentation Nov 12, 2025
@valentinpalkovic valentinpalkovic added documentation cli ci:docs Run the CI jobs for documentation checks only. labels Nov 17, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 17, 2025

📝 Walkthrough

Walkthrough

The --exact-port CLI option was modified to change from a parameter-taking option that accepts a numeric argument to a boolean flag that works in conjunction with the -p option for port specification. Documentation and usage examples were updated accordingly.

Changes

Cohort / File(s) Change Summary
CLI option documentation
docs/api/cli-options.mdx
Changed --exact-port from accepting a [number] argument to a boolean flag; updated usage example to show combining with -p for port specification

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the new --exact-port flag behavior aligns with actual CLI implementation
  • Confirm -p port specification works correctly with the --exact-port flag
  • Check that no other documentation pages reference the old --exact-port [number] syntax

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2bc062f and 76274f5.

📒 Files selected for processing (1)
  • docs/api/cli-options.mdx (1 hunks)
🔇 Additional comments (1)
docs/api/cli-options.mdx (1)

42-42: Documentation change is accurate—no issues found.

Verification confirms that --exact-port is correctly defined as a boolean flag in the CLIOptions interface (code/core/src/types/modules/core-common.ts:184), and the implementation in server-address.ts treats it as a boolean that causes Storybook to exit if the exact port is unavailable. The documentation update correctly reflects this behavior.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread docs/api/cli-options.mdx Outdated
@jonniebigodes jonniebigodes added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 18, 2025
@jonniebigodes
Copy link
Copy Markdown
Contributor

@nnt1054 thanks for taking the time to put together this pull request and helping us improve the documentation by catching this small typo. We appreciate it.

All good on my end.

I'll merge it once the checklist clears.

Have a great day

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Nov 18, 2025

View your CI Pipeline Execution ↗ for commit 0c0280a

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 44s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-18 15:07:34 UTC

@jonniebigodes jonniebigodes merged commit e79c9b2 into storybookjs:next Nov 18, 2025
9 checks passed
@nnt1054 nnt1054 deleted the patch-1 branch November 18, 2025 17:12
@github-actions github-actions Bot mentioned this pull request Nov 19, 2025
17 tasks
@valentinpalkovic valentinpalkovic removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. cli documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants