Skip to content

docs: use scoped package name in npx commands - #50

Merged
kamilmysliwiec merged 2 commits into
nestjs:masterfrom
thekhegay:docs/npx-scoped-package-name
Oct 22, 2026
Merged

kamilmysliwiec merged 2 commits into
nestjs:masterfrom
thekhegay:docs/npx-scoped-package-name

Conversation

@thekhegay

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe: README and JSDoc

What is the current behavior?

Issue Number: N/A

README and JSDoc (migrate option of both stores, OutboxSchemaError example) say npx nest-outbox migrate, while docs move to npx @nestjs/outbox migrate in nestjs/docs.nestjs.com#3646. Lockfile still has @nestjs/store-kit 0.1.0, so tests assert old kit text

What is the new behavior?

Follows nestjs/store-kit#36, released in kit 0.1.1, where CLI and store print npx @nestjs/outbox ... instead of nest-outbox .... Two commits:

  • README and JSDoc say npx @nestjs/outbox migrate --url <database url>, comments in tests/integration.ts same
  • lockfile records @nestjs/store-kit 0.1.1, assertions on kit text in tests/postgres/cli.spec.ts and both migrations.spec.ts follow new wording (6 lines)

Package has single bin so npx runs nest-outbox from it, and with scoped name it allways resolves to official package. Bin itself is unchanged, scripts that call nest-outbox keep working

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Build, lint, tsc and full suite pass locally against PostgreSQL 18.6 and MySQL 8.4

@kamilmysliwiec
kamilmysliwiec merged commit 1542371 into nestjs:master Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants