Skip to content

Commit 8047dba

Browse files
committed
feat: use pnpm
1 parent 5355d8b commit 8047dba

File tree

9 files changed

+30032
-24621
lines changed

9 files changed

+30032
-24621
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ With npm
2323
npm install react-scroll-parallax
2424
```
2525

26-
or yarn
26+
or pnpm
2727

2828
```
29-
yarn add react-scroll-parallax
29+
pnpm add react-scroll-parallax
3030
```
3131

3232
## Example

docs/development.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,29 @@ Scripts and procedures for developing locally.
77
Install node modules
88

99
```
10-
yarn install
10+
pnpm install
1111
```
1212

1313
Start storybook
1414

1515
```
16-
yarn start
16+
pnpm start
1717
```
1818

1919
## Testing
2020

2121
Run Jest tests
2222

2323
```
24-
yarn test
24+
pnpm test
2525
```
2626

2727
## Prettier
2828

2929
Run prettier on source files
3030

3131
```
32-
yarn prettier
32+
pnpm prettier
3333
```
3434

3535
## Publishing New Version to NPM

docs/tsdx-readme.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based]
1313
The recommended workflow is to run TSDX in one terminal:
1414

1515
```bash
16-
npm start # or yarn start
16+
npm start # or pnpm start
1717
```
1818

1919
This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
@@ -25,7 +25,7 @@ Then run either Storybook or the example playground:
2525
Run inside another terminal:
2626

2727
```bash
28-
yarn storybook
28+
pnpm storybook
2929
```
3030

3131
This loads the stories from `./stories`.
@@ -38,23 +38,23 @@ Then run the example inside another:
3838

3939
```bash
4040
cd example
41-
npm i # or yarn to install dependencies
42-
npm start # or yarn start
41+
npm i # or pnpm install to install dependencies
42+
npm start # or pnpm start
4343
```
4444

4545
The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
4646

47-
To do a one-off build, use `npm run build` or `yarn build`.
47+
To do a one-off build, use `npm run build` or `pnpm build`.
4848

49-
To run tests, use `npm test` or `yarn test`.
49+
To run tests, use `npm test` or `pnpm test`.
5050

5151
## Configuration
5252

5353
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
5454

5555
### Jest
5656

57-
Jest tests are set up to run with `npm test` or `yarn test`.
57+
Jest tests are set up to run with `npm test` or `pnpm test`.
5858

5959
### Bundle analysis
6060

@@ -142,7 +142,7 @@ Alternatively, if you already have a git repo connected, you can set up continuo
142142

143143
```bash
144144
netlify init
145-
# build command: yarn build && cd example && yarn && yarn build
145+
# build command: pnpm build && cd example && pnpm install && pnpm build
146146
# directory to deploy: example/dist
147147
# pick yes for netlify.toml
148148
```

documentation/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
55
### Installation
66

77
```
8-
$ yarn
8+
$ pnpm install
99
```
1010

1111
### Local Development
1212

1313
```
14-
$ yarn start
14+
$ pnpm start
1515
```
1616

1717
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1818

1919
### Build
2020

2121
```
22-
$ yarn build
22+
$ pnpm build
2323
```
2424

2525
This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
2929
Using SSH:
3030

3131
```
32-
$ USE_SSH=true yarn deploy
32+
$ USE_SSH=true pnpm deploy
3333
```
3434

3535
Not using SSH:
3636

3737
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
38+
$ GIT_USER=<Your GitHub username> pnpm deploy
3939
```
4040

4141
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

documentation/docs/intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ With npm
3030
npm install react-scroll-parallax
3131
```
3232

33-
or yarn
33+
or pnpm
3434

3535
```
36-
yarn add react-scroll-parallax
36+
pnpm add react-scroll-parallax
3737
```
3838

3939
## Example

0 commit comments

Comments
 (0)