Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Commit

Permalink
Add caveat about installing other dependencies while package is linked
Browse files Browse the repository at this point in the history
  • Loading branch information
javierbrea committed Nov 7, 2019
1 parent 3753de7 commit f7af8a8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ npm-file-link -ua

### Caveats

### Do not commit local modifications.

Linked packages have have modifications in the `package.json` and in the `package-lock.json` file that should never be pushed to the remote repository.

**Before pushing any change, you must execute:**
Expand All @@ -84,6 +86,10 @@ To avoid pushing local links to the remote repository, this package provides a `
npm-file-link --check
```

### Do not install or modify any other dependency while packages are linked.

While you have locally linked dependencies, the `package-lock.json` file is modified by npm according to local paths references. This file should be reverted after unlinking dependencies, so do not install or upgrade any other dependency while you have local links.

### Support (OS Terminals)

npm-file-link uses [inquirer][inquirer-url] for displaying CLI. You can [consult his OS Terminals support here][inquirer-support].
Expand Down

0 comments on commit f7af8a8

Please sign in to comment.