@@ -13,35 +13,38 @@ Beachball is a CLI tool for automating semantic version bumping, changelog gener
1313
1414## Commands
1515
16+ Beachball currently uses Node 14. Before running tests, you may need to activate ` nvm ` : on Mac or Linux, ` source ~/.nvm/nvm.sh && nvm use ` .
17+
1618### Top-level
1719
1820These commands work at the top level of the monorepo.
1921
2022DO NOT run ` jest ` or ` tsc ` directly from the top level!
2123
22- | Task | Command |
23- | ------------------ | ----------------------- |
24- | Build | ` yarn build ` |
25- | Test | ` yarn test ` |
26- | Lint (code + deps) | ` yarn lint ` |
27- | Lint code only | ` yarn lint:code ` |
28- | Format | ` yarn format ` |
29- | Update snapshots | ` yarn update-snapshots ` |
30-
31- ### Per-package commands
32-
33- These commands work in the ` beachball ` package and potentially other future packages.
34-
35- | Task | Command |
36- | ----------------------------- | ------------------------------- |
37- | Build | ` yarn build ` |
38- | All tests in correct order | ` yarn test:all ` |
39- | Unit tests only | ` yarn test:unit ` |
40- | Functional tests only | ` yarn test:func ` |
41- | E2E tests only | ` yarn test:e2e ` |
42- | Single test file (wraps jest) | ` yarn test <test path or name> ` |
43- | Lint | ` yarn lint ` |
44- | Update snapshots | ` yarn update-snapshots ` |
24+ | Task | Command |
25+ | ----------------------------------- | ----------------------- |
26+ | Build | ` yarn build ` |
27+ | Run all tests (NOT a specific test) | ` yarn test ` |
28+ | Lint (code + deps) | ` yarn lint ` |
29+ | Lint code only | ` yarn lint:code ` |
30+ | Format | ` yarn format ` |
31+ | Update snapshots | ` yarn update-snapshots ` |
32+
33+ ### Commands
34+
35+ These commands work in an individual package (` cd packages/<name> ` ).
36+
37+ | Task | Command |
38+ | ---------------------------------------- | ------------------------------- |
39+ | Build | ` yarn build ` |
40+ | Test (packages other than ` beachball ` ) | ` yarn test ` |
41+ | Single test file (wraps jest) | ` yarn test <test path or name> ` |
42+ | (` beachball ` ) All tests in correct order | ` yarn test:all ` |
43+ | (` beachball ` ) Unit tests only | ` yarn test:unit ` |
44+ | (` beachball ` ) Functional tests only | ` yarn test:func ` |
45+ | (` beachball ` ) E2E tests only | ` yarn test:e2e ` |
46+ | Lint | ` yarn lint ` |
47+ | Update snapshots | ` yarn update-snapshots ` |
4548
4649## Architecture
4750
0 commit comments