Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douglasjunior/ignore-dependency-scripts
Script to prevent dependencies to execute post/pre install scripts when installed directly from git.
https://github.com/douglasjunior/ignore-dependency-scripts
dependency git npm postinstall yarn
Last synced: about 1 month ago
JSON representation
Script to prevent dependencies to execute post/pre install scripts when installed directly from git.
- Host: GitHub
- URL: https://github.com/douglasjunior/ignore-dependency-scripts
- Owner: douglasjunior
- License: mit
- Created: 2022-11-14T15:08:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-21T18:12:40.000Z (about 2 years ago)
- Last Synced: 2024-11-15T21:51:58.250Z (2 months ago)
- Topics: dependency, git, npm, postinstall, yarn
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ignore-dependency-scripts
- Size: 25.4 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Ignore dependency post/pre install scripts
[](https://github.com/douglasjunior/ignore-dependency-scripts/blob/master/LICENSE)
[](https://www.npmjs.com/package/ignore-dependency-scripts)
[](#usage)
Script to prevent dependencies to execute post/pre install scripts when installed directly from git.
*Alternative to [typicode/pinst](https://github.com/typicode/pinst) and [bahmutov/am-i-a-dependency](https://github.com/bahmutov/am-i-a-dependency).*
## Why?
Sometimes when working with private projects, we have the need to reuse some parts of our code in many projects. But, we know that maintaining a private `npm registry` is a pain and requires a lot of attention.
So, the easiest way, is to install our private repo as a dependency directly from git. But, this comes with some caveats like the inability to use `.npmignore` and the **lack of an option to "prevent pre/post scripts" when installed as a dependency.**
Some examples of scripts that we might want to prevent from running when installed as a dependency is:
- husky install
- npx pod-install
It's a solution for:
- https://stackoverflow.com/q/72092997/2826279
- https://stackoverflow.com/q/54212147/2826279
- https://stackoverflow.com/q/23505318/2826279
- https://stackoverflow.com/q/44749524/2826279
- https://stackoverflow.com/q/41015620/2826279
## Usage
Replace this:
```json
// package.json
"name": "my-library",
"scripts:" {
// "start", "test", "build", etc
"postinstall/preinstall/prepare/etc": "your && scripts && here"
},
```
With this:
```json
// package.json
"name": "my-library",
"scripts:" {
// "start", "test", "build", etc
"postinstall/preinstall/prepare/etc": "npx --yes ignore-dependency-scripts \"your && scripts && here\""
},
```
> Replace `your && scripts && here` by any post/pre install script that you want, like `husky install`, `npx pod-install` or both.
Now, when you run `yarn install` or `npm install` in `./my-library` the `your && scripts && here` will run normally.
But, when you install `my-library` as a dependency (aka `yarn add url/to/my-library.git`) in another repository, the `your && scripts && here` will be ignored.
## How it works
Consider the [usage](#usage) example above.
When `npx --yes ignore-dependency-scripts` is executed, it will check if there is a `.git` folder inside the root directory. (thanks to https://stackoverflow.com/a/68915638/2826279)
If the `.git` folder exists, then you are installing the dependencies of `./my-library` directly.
If the `.git` folder DOES NOT exist, then you are installing `my-library` as a dependency in another repository.
> I think that in future we can extend this package to use other strategies too. PRs will be welcome.
## Contribute
New features, bug fixes and improvements are welcome! For questions and suggestions, use the [issues](https://github.com/douglasjunior/ignore-dependency-scripts/issues).
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=E32BUP77SVBA2)
## License
```
The MIT License (MIT)
Copyright (c) 2022 Douglas Nassif Roma Junior
```
See the full [license file](https://github.com/douglasjunior/ignore-dependency-scripts/blob/master/LICENSE).