Git Product home page Git Product logo

group-dependencies's Introduction

group-dependencies

Node.js CI npm version

What

npm gives you two groups to specify dependencies (i.e. dev and prod). In the real world, we have multiple dependency environments (e.g. test, build, production, development).

Let’s say you run webpack on heroku to build your app. There are 2 options:

  1. Set heroku config:set NPM_CONFIG_PRODUCTION=false to install all dependencies (including testing dependencies)
  2. Put your build dependencies in dependencies (i.e. production environment)

With group-dependencies, you can declare your build dependencies in a separate property, buildDependencies, and install only those packages as needed, by adding to "scripts": { "heroku-postbuild": deps install build" } to your package.json.

Installation

npm install group-dependencies

Usage

First, add a new dependencies group to package.json:

{
  ...
  "devDependencies": {
    "intercept-stdout": "^0.1.2",
    "jest": "^20.0.4",
    "strip-color": "^0.1.0"
  },
  // our new group representing testing dependencies
  "testDependencies": [
    "jest"
  ]
  ...
}

Now you can install only the dependencies for this new group:

# This will install jest@^20.0.4:
deps install test

Command

# Install dependencies in the named group
deps install [GROUP_NAME]

How it works

Any item added to the [GROUP_NAME]Dependencies property will be installed with deps install [GROUP_NAME]. If a matching package is found in devDependencies, that version will be installed.

// Here's the part that matters.
"buildDependencies": [
  "webpack",
  "@babel/preset-env"
]

The decision to use this strategy, with an array, was made so that we can leverage a few things.

  1. In your development enviroment, let npm manage installing your dev dependencies.
  2. You only need to manage package versions in one location, reducing the overhead.

group-dependencies's People

Contributors

itsthatguy avatar aminya avatar

Watchers

James Cloos avatar

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.