https://github.com/tobua/skip-local-postinstall
Skip postinstall on local npm installs.
https://github.com/tobua/skip-local-postinstall
local npm postinstall skip
Last synced: about 2 months ago
JSON representation
Skip postinstall on local npm installs.
- Host: GitHub
- URL: https://github.com/tobua/skip-local-postinstall
- Owner: tobua
- Created: 2020-09-05T18:17:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-12T09:17:00.000Z (over 2 years ago)
- Last Synced: 2025-03-26T03:41:41.648Z (2 months ago)
- Topics: local, npm, postinstall, skip
- Language: JavaScript
- Homepage: https://npmjs.com/skip-local-postinstall
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# skip-local-postinstall
Skips (successfully exits current process) when postinstall is called locally instead of being called when the package has been published to npm.
```js
// package.json
"scripts": {
"postinstall": "node ./installation.js"
}
```
```js
// installation.js
import { skip } from 'skip-local-postinstall'
skip()
// This code will only be executed when installed through npm.
console.log('Installing from npm.')
```
Requires [`process.env.INIT_CWD`](https://github.com/npm/cli/issues/2033) variable available in all stable npm releases. Credits to Már Örlygsson for suggesting this implementaiton on [Stackoverflow](https://stackoverflow.com/a/53239387/3185545s).
## Compiled Postinstall File
In cases where you want to run a postinstall script for compiled files (i.e. source in TypeScript) the file will not be there when installing the package locally. To address that this plugin also includes a bin script. It's arguments will be passed directly to the `node` command and can include additional arguments apart from the file to run.
```js
// package.json
"scripts": {
"postinstall": "skip-local-postinstall ./dist/installation.js"
}
```
## Alternative
It's also possible to encapsulate som of the desired functionality in a one-line script. However, this only works when the script is the result of a build process and the build is removed before installation.
```js
// package.json
"scripts": {
"postinstall": "node -e \"try{import('./dist/postinstall.js')}catch(e){}\""
}
```
When using a CommonJS package without `{ type: "module" }` in package.json a require call can be used.
```js
"node -e \"try{require('./dist/postinstall.js')}catch(e){}\""
```