diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index 33e08b2446d5..d954f1d55cdc 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -10,7 +10,7 @@ far! - Commit (write) rights to `loopback-next` repo - Ability to review and land pull requests, edit/categorize/close issues -## What are a maintainer's responsibilities? +## What are responsibilities of a maintainer? We ask you to follow the existing processes, see http://loopback.io/doc/en/contrib/Governance.html. This means mostly: diff --git a/docs/site/DEVELOPING.md b/docs/site/DEVELOPING.md index 4c480a12e54a..3eaa9edcabc0 100644 --- a/docs/site/DEVELOPING.md +++ b/docs/site/DEVELOPING.md @@ -71,12 +71,31 @@ for intra-dependencies: npm ci ``` +As part of `npm ci` or `npm i`, TypeScript project references are automatically +updated for each package with in the monorepo. + The next step is to compile all packages from TypeScript to JavaScript: ```sh npm run build ``` +To force a clean build: + +```sh +npm run clean && npm run build +``` + +Please note that `npm run clean` removes `dist`, `*.tsbuildinfo`, and other +generated files from each package to clean the state for builds. + +To build an individual package: + +```sh +cd // For example, cd `packages/context`. +npm run build +``` + Please note that we are automatically running the build from `pretest` script, therefore you should not need to run this command as part of your [red-green-refactor cycle](http://www.jamesshore.com/Blog/Red-Green-Refactor.html). @@ -183,8 +202,16 @@ from package-lock files.** If you ever end up with corrupted or out-of-date package locks, run the following commands to fix the problem: +To rebuild `package-lock.json` for all packages. + +```sh +npm update-package-locks +``` + +To update `package-lock.json` for a list of packages: + ```sh -$ npm run update-package-locks +npm update-package-locks -- --scope --scope ``` ### Adding dependencies