Skip to content

Commit

Permalink
chore: tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Mister-Hope committed Dec 5, 2023
1 parent c09e68d commit 54d50b3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 20 deletions.
18 changes: 1 addition & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,26 +64,10 @@ You may need to run this script first after your clone this repository, because

### `pnpm clean`

The `clean` script runs `clean` script in all packages, cleaning all the dist files and caches. In other words, it will remove all the files that generated by `build`, `copy` scripts.
The `clean` script runs `clean` script in all packages, cleaning all the dist files and caches. In other words, it will remove all the files that generated by `build` scripts.

It's used before you want to re-build source files from a clean / initial state.

### `pnpm docs:*`

#### `pnpm docs:build`, `pnpm docs:dev`, `pnpm docs:clean`

The `docs:` prefix indicates that these scripts are for documentation, i.e. the `docs` directory.

VuePress is using itself to build its own documentation site.

You need to run `pnpm build` to build VuePress source files first, then run these `docs:` scripts to develop and build our documentation.

#### `pnpm docs:serve`

Serve the documentation site locally.

You need to run `pnpm docs:build` first to generate the documentation dist files, and then run `pnpm docs:serve` to serve them.

### `pnpm lint`

The `lint` script uses ESLint to check all source files.
Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
"private": true,
"type": "module",
"scripts": {
"build": "pnpm build:all && pnpm build:copy",
"build:all": "pnpm -r --workspace-concurrency=1 --stream build",
"build:copy": "pnpm --parallel --stream copy",
"build": "pnpm -r --workspace-concurrency=1 --stream build",
"clean": "pnpm --parallel --stream clean",
"format": "prettier --write .",
"lint": "eslint --ext .cjs,.js,.ts,.vue . && prettier --check .",
Expand Down

0 comments on commit 54d50b3

Please sign in to comment.