ci: using pnpm workspace

Author: ulivz

.github/CONTRIBUTING.md

@@ -1,22 +1,22 @@
 ## Development Setup
 
-This project uses a monorepo setup that requires using [Yarn](https://yarnpkg.com) because it relies on [Yarn workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/).
+This project uses a monorepo setup that requires using [pnpm](https://pnpm.io/) because it relies on [pnpm workspaces](https://pnpm.io/workspaces).
 
 ```sh
-# Install all dependencies.
-yarn
+# Install all dependencies, i.e. pnpm install --prefer-offline
+npm run bootstrap
 
 # Serves VuePress' own docs with itself.
-yarn dev
+npm run dev
 
 # Build VuePress' own docs with itself.
-yarn build
+npm run build
 
 # Clean dependencies.
-yarn clean
+npm run clean
 
 # Useful when creating new a package.
-yarn boot
+npm run boot
 ```
 
 ## Testing Setup
@@ -25,10 +25,10 @@ VuePress leverages [jest](https://jestjs.io/) for its tests, testing process dep
 
 ```bash
 # Execute all the test suites.
-yarntest
+npm runtest
 
 # Execute tests under specfic package. 
-yarntest -p=core ## OR --package=core
+npm runtest -p=core ## OR --package=core
 ```
 
 ## Core Packages

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,7 +24,7 @@ about: Create a report to help us improve
 
 <!-- If you are reporting a bug that can ONLY be reproduced on your repository, PLEASE provide this repo link. That takes guessing work out of the way and saves us time. -->
 
-<!-- If your repo isn't public, you can use `codesandbox` or `yarn create vuepress` to create a minimal reproduction -->
+<!-- If your repo isn't public, you can use `codesandbox` or `npm create vuepress` to create a minimal reproduction -->
 
 #### What is expected?
 

.github/workflows/pull-request-ci.yml

@@ -11,32 +11,34 @@ jobs:
  - uses: actions/setup-node@v1
 with:
 node-version: '12'
- - name: Get yarn cache directory path
-id: yarn-cache-dir-path
-run: echo "::set-output name=dir::$(yarn cache dir)"
- - uses: actions/cache@v1
+
+ - name: Cache pnpm modules
+uses: actions/cache@v2
 with:
-path: ${{steps.yarn-cache-dir-path.outputs.dir }}
-key: ${{runner.os }}-node-modules-${{hashFiles('yarn.lock') }}
+path: ~/.pnpm-store
+key: ${{runner.os }}-${{hashFiles('**/pnpm-lock.yaml') }}
 restore-keys: |
- ${{runner.os }}-node-modules-
  ${{runner.os }}-
 
+ - uses: pnpm/[email protected]
+with:
+version: 6.0.2
+run_install: true
+
  - name: Install dependencies
-if: steps.yarn-cache.outputs.cache-hit != 'true'
-run: yarn
+run: pnpm run bootstrap
 
  - name: Run tsc
-run: yarn tsc
+run: pnpm run tsc
 
  - name: Run unit tests
-run: yarn test
+run: pnpm run test
 
  - name: Check linter
-run: yarn lint
+run: pnpm run lint
 
  - name: Check markdown linter
-run: yarn workspace docs lint-md
+run: pnpm run workspace docs lint-md
 
  - name: Build vuepress
-run: yarn build 
+run: pnpm run build 

.gitpod.yml

@@ -2,5 +2,5 @@ ports:
  - port: 8080
 onOpen: open-preview
 tasks:
- - init: yarn
-command: yarn dev
+ - init: npm run bootstrap
+command: npm run dev

README.md

@@ -29,9 +29,9 @@ Check out our docs at https://vuepress.vuejs.org/.
 Want to contribute? Check our [Contributing Guide](.github/CONTRIBUTING.md) and [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
 
 ```bash
-yarn install# install all dependencies
-yarn dev # serves VuePress' own docs with itself
-yarn test# make sure your code change pass the test
+npm run bootstrap# install all dependencies
+npm run dev# serves VuePress' own docs with itself
+npm run test# make sure your code change pass the test
 ```
 
 If you don't have a local checkout, you can also open [VuePress in Gitpod](https://gitpod.io/#https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md), a free online IDE for GitHub.

lerna.json

@@ -1,7 +1,10 @@
 {
-"npmClient": "yarn",
-"useWorkspaces": true,
 "version": "1.8.2",
+"packages": [
+"packages/@vuepress/*",
+"packages/vuepress",
+"packages/docs"
+ ],
 "command":{
 "version":{
 "allowBranch": "master",

package.json

@@ -1,32 +1,28 @@
 {
 "private": true,
 "description": "Minimalistic doc generator with Vue component based layout system",
-"workspaces": [
-"packages/@vuepress/*",
-"packages/vuepress",
-"packages/docs"
- ],
 "scripts":{
 "boot": "node scripts/bootstrap.js",
-"build": "yarn tsc && yarn build:docs",
-"build:docs": "yarn workspace docs build",
+"bootstrap": "pnpm install --prefer-offline",
+"build": "npm run tsc && npm run build:docs",
+"build:docs": "lerna exec --scope=docs -- npm run build",
 "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 2",
-"clean": "lerna clean && rm -rf node_modules",
-"dev": "yarn tsc && yarn dev:docs",
-"dev:docs": "yarn workspace docs dev",
+"clean": "lerna clean --yes && rm -rf node_modules",
+"dev": "npm run tsc && npm run dev:docs",
+"dev:docs": "lerna exec --scope=docs -- npm run dev",
 "lint": "eslint packages --ext .js,.ts,.vue",
 "packages:changed": "lerna changed",
 "packages:diff": "lerna diff",
 "packages:list": "lerna ls -l",
-"register-vuepress": "lerna exec --scope vuepress -- yarn link",
-"release": "yarn lint && yarn build && yarn test && node scripts/release.js",
+"register-vuepress": "lerna exec --scope vuepress -- npm run link",
+"release": "npm run lint && npm run build && npm run test && node scripts/release.js",
 "remote-version": "node scripts/remote-version.js",
-"show-help": "yarn workspace docs show-help",
+"show-help": "lerna exec --scope=docs -- npm run show-help",
 "test": "node scripts/test.js",
-"tsc": "yarn workspace @vuepress/shared-utils tsc",
-"unregister-vuepress": "lerna exec --scope vuepress -- yarn unlink",
+"tsc": "lerna exec --scope @vuepress/shared-utils -- npm run tsc",
+"unregister-vuepress": "lerna exec --scope vuepress -- npm run unlink",
 "update-core-team": "all-contributors generate",
-"view-info": "yarn tsc && yarn workspace docs view-info"
+"view-info": "npm run tsc && lerna exec --scope docs -- npm run view-info"
  },
 "husky":{
 "hooks":{

packages/@vuepress/shared-utils/package.json

@@ -19,12 +19,12 @@
  },
 "license": "MIT",
 "author": "ULIVZ <[email protected]>",
+"main": "lib/index.js",
+"types": "types/index.d.ts",
 "files": [
 "lib",
 "types"
  ],
-"main": "lib/index.js",
-"types": "types/index.d.ts",
 "scripts":{
 "tsc": "tsc",
 "update-index": "node scripts/update-index.js"
@@ -36,6 +36,7 @@
 "globby": "^9.2.0",
 "gray-matter": "^4.0.1",
 "hash-sum": "^1.0.2",
+"markdown-it-emoji": "^1.4.0",
 "semver": "^6.0.0",
 "toml": "^3.0.0",
 "upath": "^1.1.0"

packages/docs/package.json

@@ -21,7 +21,7 @@
 "scripts":{
 "build": "vuepress build docs --temp .temp",
 "dev": "vuepress dev docs --temp .temp",
-"lint-md": "yarn lint-md:style && yarn lint-md:wording",
+"lint-md": "npm run lint-md:style && npm run lint-md:wording",
 "lint-md:style": "remark --quiet --frail .",
 "lint-md:wording": "textlint ./docs/**/*.md",
 "show-help": "vuepress --help",

packages/vuepress/README.md

@@ -32,9 +32,9 @@ The docs are available at <https://vuepress.vuejs.org>
 Want to contribute? Check our [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
 
 ```bash
-yarn# Install and link dependencies for this monorepo
-yarn dev # serves VuePress' own docs with itself
-yarn test# make sure your code change pass the test
+npm run bootstrap# Install and link dependencies for this monorepo
+npm run dev# serves VuePress' own docs with itself
+npm run test# make sure your code change pass the test
 ```
 
 If you don't have a local checkout, you can also open [VuePress in Gitpod](https://gitpod.io/#https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md), a free online IDE for GitHub.