Skip to content

Commit

Permalink
Rename package.json scripts for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
ty2k committed Nov 29, 2023
1 parent 3575728 commit 066374f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions packages/react-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,18 +74,18 @@ Components live in `./src/components` and are targeted by the build process with

Storybook stories live in `./src/stories`.

Run `npm run storybook` to access the Storybook instance for the component library.
Run `npm run storybook-dev` to access the Storybook instance for the component library.

### Vite kitchen sink application

Vite uses the components code directly from `./src/components` in groups of content in `./src/pages`.

Run `npm run vite` to access the Vite React demo app.
Run `npm run vite-dev` to access the Vite React demo app.

### Publish new versions

To generate an updated copy of the package for distribution, run the included Rollup script: `npm run rollup`.

This will place artifacts in the `dist` folder, which is targeted for publishing in `package.json` with the [`files` field](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files).

Update the package version in `package.json` and run `npm run publish` to push a new version.
Update the package version in `package.json` and run `npm publish` to push a new version.
12 changes: 6 additions & 6 deletions packages/react-components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"version": "0.0.2",
"type": "module",
"scripts": {
"vite": "vite",
"build-vite": "tsc && vite build",
"rollup": "rollup -c --bundleConfigAsCjs",
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"preview": "vite preview",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build",
"rollup": "rollup -c --bundleConfigAsCjs"
"storybook-dev": "storybook dev -p 6006",
"storybook-build": "storybook build",
"vite-dev": "vite",
"vite-build": "tsc && vite build",
"vite-preview": "vite preview"
},
"main": "dist/cjs/index.cjs",
"module": "dist/esm/index.js",
Expand Down

0 comments on commit 066374f

Please sign in to comment.