Code Monkey home page Code Monkey logo

skip-local-postinstall's Introduction

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.

// package.json
"scripts": {
  "postinstall": "node ./installation.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 variable available in all stable npm releases. Credits to Már Örlygsson for suggesting this implementaiton on Stackoverflow.

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.

// 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.

// 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.

"node -e \"try{require('./dist/postinstall.js')}catch(e){}\""

skip-local-postinstall's People

Contributors

tobua avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

nmccready

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.