Skip to content

docs: migrate flagsmith-cli and flagsmith-nodejs references to @flagsmith scope#7583

Open
kyle-ssg wants to merge 4 commits into
mainfrom
feat/migrate-scoped-npm-package-refs
Open

docs: migrate flagsmith-cli and flagsmith-nodejs references to @flagsmith scope#7583
kyle-ssg wants to merge 4 commits into
mainfrom
feat/migrate-scoped-npm-package-refs

Conversation

@kyle-ssg
Copy link
Copy Markdown
Member

@kyle-ssg kyle-ssg commented May 22, 2026 •
edited
Loading

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to `docs/` if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Aligns docs and frontend code-help with the npm package scope migration happening in:

Also catches the last two unscoped `flagsmith` JS client refs left over from the previously-shipped flagsmith-js-client migration.

  • Frontend code-help:
    • `frontend/common/constants.ts` — `NPM_NODE_CLIENT` now `@flagsmith/nodejs`, which cascades to every Node.js init/install/traits/create-user snippet rendered in the app
    • `frontend/common/code-help/offline_{client,server}/*` — `npm i flagsmith-cli` → `npm i @flagsmith/cli`
    • `frontend/web/components/pages/environment-settings/tabs/warehouse-tab/WarehouseEventCodeHelp.tsx` — JS and Node sample snippets updated
  • Docs:
    • `docs/docs/integrating-with-flagsmith/CLI.md` — global install snippet
    • `docs/docs/integrating-with-flagsmith/sdks/client-side-sdks/javascript.md` — defaults flow install snippet
    • `docs/docs/integrating-with-flagsmith/sdks/server-side.mdx` — npm install, all `import ... from 'flagsmith-nodejs'` snippets, and the tsdocs.dev links
    • `docs/plugins/flagsmith-versions/index.js` — `flagsmith` fetch flipped to `@flagsmith/flagsmith` (already on npm). `flagsmith-nodejs` stays on the old name for now because the new package is not on npm yet and Vercel build 404s otherwise — flip this line once feat: migrate npm package to @flagsmith organization scope flagsmith-nodejs-client#270 publishes `@flagsmith/nodejs`

GitHub repo URLs are left as-is — only the npm package names are moving.

How did you test this code?

  • Eyeballed every replaced snippet
  • `grep -rn "flagsmith-cli\|flagsmith-nodejs"` across `docs/` and `frontend/` to confirm remaining refs are only GitHub repo URLs
  • Constant rename in `constants.ts` cascades through all Node code-help templates via the existing `${NPM_NODE_CLIENT}` interpolation — no per-template edits needed
  • Verified registry responses: `curl -sI https://registry.npmjs.org/@flagsmith/flagsmith\` → 200, `@flagsmith/nodejs` → 404 (hence the partial revert in the version fetcher)

Follow-ups (post-publish)

  • Flip `fetchNpmVersions('flagsmith-nodejs')` → `fetchNpmVersions('@flagsmith/nodejs')` in `docs/plugins/flagsmith-versions/index.js` once the new SDK package is on npm.

🤖 Generated with Claude Code

@kyle-ssg @claude
docs(npm-scope): update flagsmith-cli and flagsmith-nodejs references
98fbba1 
Point install snippets, code-help templates, imports, and the npm version
fetcher at the new scoped package names @flagsmith/cli and
@flagsmith/nodejs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kyle-ssg kyle-ssg requested review from a team as code owners May 22, 2026 16:10
@kyle-ssg kyle-ssg removed the request for review from a team May 22, 2026 16:10
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 22, 2026 4:17pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview May 22, 2026 4:17pm
flagsmith-frontend-staging Ignored Ignored Preview May 22, 2026 4:17pm

Request Review

@kyle-ssg kyle-ssg requested review from matthewelwell and talissoncosta and removed request for a team May 22, 2026 16:10
@github-actions github-actions Bot added front-end Issue related to the React Front End Dashboard docs Documentation updates labels May 22, 2026
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels May 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026 •
edited
Loading

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api-test:pr-7583 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-7583 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-frontend:pr-7583 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-api:pr-7583 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-private-cloud:pr-7583 Finished ✅ Results ✅

gemini-code-assist[bot]
gemini-code-assist Bot reviewed May 22, 2026
View reviewed changes
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the package names for the Flagsmith CLI and Node.js SDK from their legacy versions to the new scoped versions, @flagsmith/cli and @flagsmith/nodejs. These updates are applied consistently across documentation, code help snippets, and internal constants. Additionally, an unused import was removed from the offline server CLI helper. I have no feedback to provide as there were no review comments to evaluate.

@kyle-ssg @claude
docs(npm-scope): align flagsmith JS client refs with @Flagsmith/flags…
b021a20 
…mith

The flagsmith web SDK already moved to @Flagsmith/flagsmith on npm; this
catches the last two consumer-facing refs (warehouse code-help snippet
and the npm version fetcher).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 22, 2026
Open
Open
@kyle-ssg @claude
docs(npm-scope): keep flagsmith-nodejs in version fetcher until publish
f472517 
@flagsmith/nodejs is not on npm yet (the SDK PR has not merged), so the
version fetcher 404s and breaks the Vercel build. Revert just that line
back to the unscoped name for now; flip it after the SDK publishes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels May 22, 2026
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels May 22, 2026
@kyle-ssg @claude
docs(npm-scope): update JS SDK version pin and CDN URLs
a154be0 
@Flagsmith/flagsmith starts at 11.0.0 so the JsVersion ~9 default no
longer resolves and the Docusaurus SSG step errors out. Bump the default
spec to ^12 and switch the jsdelivr URLs in quick-start to the scoped
package path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026 •
edited
Loading

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  37.9 seconds
commit  98fbba1
info  🔄 Run: #16946 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  43.3 seconds
commit  98fbba1
info  🔄 Run: #16946 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  43.6 seconds
commit  98fbba1
info  🔄 Run: #16946 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  38.5 seconds
commit  b021a20
info  🔄 Run: #16947 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  41.4 seconds
commit  98fbba1
info  🔄 Run: #16946 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  36.2 seconds
commit  b021a20
info  🔄 Run: #16947 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  39 seconds
commit  f472517
info  🔄 Run: #16948 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  31.7 seconds
commit  b021a20
info  🔄 Run: #16947 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  34.9 seconds
commit  b021a20
info  🔄 Run: #16947 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  42.6 seconds
commit  f472517
info  🔄 Run: #16948 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  57.8 seconds
commit  f472517
info  🔄 Run: #16948 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  49.1 seconds
commit  f472517
info  🔄 Run: #16948 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  36.8 seconds
commit  a154be0
info  🔄 Run: #16949 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  39.1 seconds
commit  a154be0
info  🔄 Run: #16949 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  44.1 seconds
commit  a154be0
info  🔄 Run: #16949 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 1 suite
duration  50 seconds
commit  a154be0
info  🔄 Run: #16949 (attempt 1)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026 •
edited
Loading

Visual Regression

19 screenshots compared. See report for details.
View full report

@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@talissoncosta talissoncosta talissoncosta approved these changes

@matthewelwell matthewelwell Awaiting requested review from matthewelwell matthewelwell is a code owner automatically assigned from Flagsmith/flagsmith-docs

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kyle-ssg @talissoncosta