Getting Started
Updating
How to check your current version, pull in the latest components, and — if you're a design system contributor — how to build and publish a new release.
For engineers consuming the package
Check your current version
Run this in the root of your product repo to see which version is installed:
npm list @mnee-ui/uiOr open package.json and look for "@mnee-ui/ui" in the dependencies section.
Update to the latest version
Run the standard npm install with the @latest tag:
npm install @mnee-ui/ui@latestTo pin to a specific version instead:
npm install @mnee-ui/ui@0.0.3@import "@mnee-ui/ui/styles" line picks up any new tokens automatically after the install.What can change between versions
| Semver bump | What changed | Action required? |
|---|---|---|
| patch (0.0.x) | Bug fixes, visual tweaks, token value adjustments | None — safe to update |
| minor (0.x.0) | New components, new props or variants added to existing ones | None for existing usage — new APIs are additive |
| major (x.0.0) | Breaking prop renames, removed components, token renames | Read the release notes before updating |
For design system contributors
The following workflow applies when you've added or updated components and are ready to ship a new version of the package to npm.
1. Build the library
This runs tsup to produce dist/index.js (CJS) and dist/index.mjs (ESM), then runs tsc for type declarations:
npm run build:libdist/ folder was updated before continuing. The CSS file at components/ui/mnee-ui.css is published as-is — no build step needed for styles.2. Bump the version
Edit package.json and increment "version" following semver. Or use npm's built-in version command:
npm version patch # 0.0.2 → 0.0.3 (bug fix / tweak)npm version minor # 0.0.2 → 0.1.0 (new component or prop)npm version major # 0.0.2 → 1.0.0 (breaking change)3. Publish
The package is scoped public, so pass --access public (already set in publishConfig, but shown here for clarity):
npm publish --access publicnpm will package only the files listed under "files" in package.json: the dist/ folder and components/ui/mnee-ui.css. The doc site source, Storybook config, and other dev files are excluded automatically.
Full release checklist
| Component added or updated in | components/ui/<name>.tsx |
| Exported from | components/ui/index.ts |
| Doc page created or updated in | app/docs/components/<name>/page.tsx |
| Sidebar entry added in | components/site/Sidebar.tsx |
| Library built with | npm run build:lib |
| Version bumped in | package.json |
| Published with | npm publish --access public |