Skip to content

Commit

Permalink
docs: improve npm link instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar committed Jun 1, 2022
1 parent 2571fd0 commit 4249f5b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ If you need to change files within `node_modules/@tacc/core-styles/source`:

If you need to test file changes with [Core CMS] changes:

0. You should stash, commit, or revert any changes to `package.json` or `package-lock.json`.
1. Clone [Core Styles].
2. Allow live edit of node module via your [Core Styles] clone:

Expand All @@ -309,6 +310,10 @@ If you need to test file changes with [Core CMS] changes:

4. Make changes in your [Core Styles] clone as necessary.
5. Build changes.†
6. Undo changes to `package.json` and `package-lock.json`.
- _Warning: Do __not__ commit `npm link`'s automatic changes to `package.json` and `package-lock.json`!_
- __Notice__: If you run `npm install` or `npm ci`, the live-edit link is destroyed. Repeat these steps to restore it._
<sub>\* Use of `npm link` _without `--save`_ is overwritten by `npm install`. See [details](https://github.com/npm/cli/issues/2380#issuecomment-1029967927).</sub>\
<sub>† See [How to Build Static Files](#how-to-build-static-files).</sub>
Expand Down

0 comments on commit 4249f5b

Please sign in to comment.