Skip to content

Commit ef10c7f

Browse files
committed
feat(docs): update docs for TypeScript project refs
1 parent 8afd076 commit ef10c7f

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

docs/MAINTAINING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ far!
1010
- Commit (write) rights to `loopback-next` repo
1111
- Ability to review and land pull requests, edit/categorize/close issues
1212

13-
## What are a maintainer's responsibilities?
13+
## What are responsibilities of a maintainer?
1414

1515
We ask you to follow the existing processes, see
1616
http://loopback.io/doc/en/contrib/Governance.html. This means mostly:

docs/site/DEVELOPING.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,31 @@ for intra-dependencies:
7171
npm ci
7272
```
7373

74+
As part of `npm ci` or `npm i`, TypeScript project references are automatically
75+
updated for each package with in the monorepo.
76+
7477
The next step is to compile all packages from TypeScript to JavaScript:
7578

7679
```sh
7780
npm run build
7881
```
7982

83+
To force a clean build:
84+
85+
```sh
86+
npm run clean && npm run build
87+
```
88+
89+
Please note that `npm run clean` removes `dist`, `*.tsbuildinfo`, and other
90+
generated files from each package to clean the state for builds.
91+
92+
To build an individual package:
93+
94+
```sh
95+
cd <package-dir> // For example, cd `packages/context`.
96+
npm run build
97+
```
98+
8099
Please note that we are automatically running the build from `pretest` script,
81100
therefore you should not need to run this command as part of your
82101
[red-green-refactor cycle](http://www.jamesshore.com/Blog/Red-Green-Refactor.html).
@@ -183,8 +202,16 @@ from package-lock files.**
183202
If you ever end up with corrupted or out-of-date package locks, run the
184203
following commands to fix the problem:
185204

205+
To rebuild `package-lock.json` for all packages.
206+
207+
```sh
208+
npm update-package-locks
209+
```
210+
211+
To update `package-lock.json` for a list of packages:
212+
186213
```sh
187-
$ npm run update-package-locks
214+
npm update-package-locks -- --scope <package-name-1> --scope <package-name-2>
188215
```
189216

190217
### Adding dependencies

0 commit comments

Comments
 (0)