39
39
Below are notes and instructions on how to get your development environment up and running,
40
40
and enjoyable.
41
41
42
- 1 . ** Install dependencies** -- we use yarn workspaces, so please use yarn instead of npm.
43
- Run, ` yarn install`
42
+ 1 . ** Install dependencies**
43
+ Run, ` pnpm install`
44
44
45
45
2 . ** Workflow** -- we use the amazing [ preconstruct] ( https://github.com/preconstruct/preconstruct )
46
46
package to handle our monorepo build system.
47
47
48
48
3 . ** Local dev** -- when you're working on the code in this repository, you can safely run
49
- ` yarn dev` at the root-level, which will link all packages/** together, so that when a
49
+ ` pnpm dev` at the root-level, which will link all packages/** together, so that when a
50
50
local dependency from packages/** is used by another, it will automatically be linked
51
- without having to run a build command. Just remember: run ` yarn dev` anytime you developing
52
- in this repo. Note, that when you run ` yarn build` it will clear the dev environment, so
53
- you will need to run ` yarn dev` again after a build. However, ` yarn build` should only be
51
+ without having to run a build command. Just remember: run ` pnpm dev` anytime you developing
52
+ in this repo. Note, that when you run ` pnpm build` it will clear the dev environment, so
53
+ you will need to run ` pnpm dev` again after a build. However, ` pnpm build` should only be
54
54
used when making a release.
55
55
56
- 4 . ** Testing** -- to test the system, you can run ` yarn test` at the top-level or at an individual
56
+ 4 . ** Testing** -- to test the system, you can run ` pnpm test` at the top-level or at an individual
57
57
package-level.
58
58
59
- 5 . ** Type-checking** -- to typecheck the system you can run ` yarn typecheck` at any level.
59
+ 5 . ** Type-checking** -- to typecheck the system you can run ` pnpm typecheck` at any level.
60
60
61
- 6 . ** Building** -- to _ compile_ the project to dist files for a release, run ` yarn build` at
61
+ 6 . ** Building** -- to _ compile_ the project to dist files for a release, run ` pnpm build` at
62
62
the root-level. Note building packages repeatedly during development is unnecessary with
63
- ` preconstruct ` . During local development run ` yarn dev` and when building to make a release,
64
- run ` yarn build` .
63
+ ` preconstruct ` . During local development run ` pnpm dev` and when building to make a release,
64
+ run ` pnpm build` .
65
65
66
66
7 . ** Versioning** -- this repository uses the handy [ changesets] ( https://github.com/atlassian/changesets )
67
67
package for package versioning across the monorepo, as well as changelogs. See _ Releasing_ section below.
@@ -73,17 +73,17 @@ and enjoyable.
73
73
74
74
### How to do a release
75
75
76
- 1 . Run ` yarn ` to make sure everything is up to date
76
+ 1 . Run ` pnpm ` to make sure everything is up to date
77
77
2 . Code.. do your magic
78
- 3 . Run ` yarn changeset` to generate a new .changeset/ entry explaining the code changes
78
+ 3 . Run ` pnpm changeset` to generate a new .changeset/ entry explaining the code changes
79
79
4 . Version bump all packages regardless of them having changes or not
80
80
5 . Commit and submit your changes as a PR for review
81
81
6 . Once merged and you're ready to make a release, continue to the next step. If you're not
82
82
ready to make a release, then go back to step 2.
83
- 7 . Run ` yarn build && yarn test` to double check all tests pass
84
- 8 . Run ` yarn version-packages` to bump versions of the packages
83
+ 7 . Run ` pnpm build && pnpm test` to double check all tests pass
84
+ 8 . Run ` pnpm version-packages` to bump versions of the packages
85
85
9 . Commit files after versioning. This is the commit that will be published and tagged: ` git push --no-verify `
86
- 10 . Run ` yarn release` . If the 2FA code timesout while publishing, run the command again
86
+ 10 . Run ` pnpm release` . If the 2FA code timesout while publishing, run the command again
87
87
with a new code, only the packages that were not published will be published.
88
88
11 . Finally, push your git tags, via: ` git push --tags --no-verify `
89
89
@@ -92,15 +92,15 @@ and enjoyable.
92
92
93
93
NOTE: snapshot release is for dev preview, it's similar to the above, but:
94
94
95
- 1 . ` yarn changeset`
96
- 2 . ` yarn changeset version --snapshot`
97
- 3 . ` yarn changeset publish --tag snapshot`
95
+ 1 . ` pnpm changeset`
96
+ 2 . ` pnpm changeset version --snapshot`
97
+ 3 . ` pnpm changeset publish --tag snapshot`
98
98
99
99
100
100
## NOTES
101
101
102
- 1 . Browser tests can be run with ` yarn test` or, separately ` yarn test:server` and ` yarn test:run`
103
- 2 . To run a specific test, run ` yarn test:only <test-file-basename>` , ie. ` yarn test:only window-transport`
102
+ 1 . Browser tests can be run with ` pnpm test` or, separately ` pnpm test:server` and ` pnpm test:run`
103
+ 2 . To run a specific test, run ` pnpm test:only <test-file-basename>` , ie. ` pnpm test:only window-transport`
104
104
105
105
106
106
## TIPS
0 commit comments