Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
linbudu599 committed Mar 16, 2022
1 parent ac370a9 commit f6737d2
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,11 @@ In fact, all we need to do is to choose some of these projects according to our
```

Projects that are not selected will be removed from the workspace packages dir `/packages`
and a backup will be kept in `node_modules/.LinbuduLab`, you can run `pnpm cli reset` to recover these packages,
or use command `pnpm cli copy` to add removed packages back:
and a backup will be kept in `node_modules/.LinbuduLab`.

- You can run `pnpm cli reset` to recover these packages back to `packages` dir.
- You can use command `pnpm cli copy` to add specified packages back.
- You can execute `pnpm cli cache` to cache workspace packages manually.

```bash
✔ Choose starters you want to copy into workspace · esbuild-plugin-starter, esbuild-react-app
Expand Down Expand Up @@ -145,6 +148,22 @@ Command: `pnpm cli fork [workspace name] <forked worksapce dir>`.

This command will create a fork of the current workspace at specified directory. If destination directory is not specified, it will use `../tmp/forked` as default.

## Upgrade

Command: `pnpm cli upgrade [projectBlurKeyword]`

This command executes deps version checking and upgrading for specified packages. You can use just keyword or complete project name like:

```bash
# input 'vite' has no '-' signal, so it will work for all projects which has 'vite' in its name
pnpm cli u vite

# work for 'vite-react-starter' only
pnpm cli u vite-react-starter
```

Also, if you execute this command with no project name (or no exist project name), it will ask you for working targets.

### Release

> WIP
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"version": "1.0.0",
"scripts": {
"cli": "ts-node -P scripts/tsconfig.script.json scripts/cli.ts",
"cli-dev": "ts-node-dev --respawn --transpile-only -P scripts/tsconfig.script.json scripts/cli.ts",
"cs:add": "changeset add",
"cs:version": "changeset version",
"cs:publish": "changeset publish",
Expand Down

0 comments on commit f6737d2

Please sign in to comment.