You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tsdx-readme.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based]
13
13
The recommended workflow is to run TSDX in one terminal:
14
14
15
15
```bash
16
-
npm start # or yarn start
16
+
npm start # or pnpm start
17
17
```
18
18
19
19
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:
25
25
Run inside another terminal:
26
26
27
27
```bash
28
-
yarn storybook
28
+
pnpm storybook
29
29
```
30
30
31
31
This loads the stories from `./stories`.
@@ -38,23 +38,23 @@ Then run the example inside another:
38
38
39
39
```bash
40
40
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
43
43
```
44
44
45
45
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).
46
46
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`.
48
48
49
-
To run tests, use `npm test` or `yarn test`.
49
+
To run tests, use `npm test` or `pnpm test`.
50
50
51
51
## Configuration
52
52
53
53
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
54
54
55
55
### Jest
56
56
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`.
58
58
59
59
### Bundle analysis
60
60
@@ -142,7 +142,7 @@ Alternatively, if you already have a git repo connected, you can set up continuo
142
142
143
143
```bash
144
144
netlify init
145
-
# build command: yarn build && cd example && yarn && yarn build
145
+
# build command: pnpm build && cd example && pnpm install && pnpm build
0 commit comments