gulp-dependency-install

0.0.8 • Public • Published

gulp-dependency-install

Join the chat at https://gitter.im/99xt/gulp-dependency-install npm version license

This gulp plugin provides a simple API to install dependencies in multiple nested package.json files. It also allows to define custom local dependencies inside package.json.

Installation

To include gulp-dependency-install in your project use npm install gulp-dependency-install --save

Usage

With directory path argument

Edit your gulpfile.js and include the following (If gulpfile.js not exits, create a new gulpfile.js in the project root).

var gulp = require('gulp');
var gulpDi = require('gulp-dependency-install');
 
gulp.task('npm-install', function () {
    return gulpDi.install();
});

Open a shell/commandline and run the followig command gulp npm-install --dir <your-directory> Note: This executes npm install for all the nested package.json files inside '' path.

With directory path variables

var gulp = require('gulp');
var gulpDi = require('gulp-dependency-install');
 
gulp.task('npm-install', function () {
    return gulpDi.install(['<your-directory>']);
});

Open a shell/commandline and run the followig command gulp npm-install Note: You can also include multiple directories inside the array.

Custom dependencies

What if you need to share code, but don't wish to publish packages in NPM Registry? You can use the Custom Dependencies feature.

  1. Create a directory(e.g 'your_local_dependencies') in your codebase to store each local dependency(library) code. Create directories for each of the dependencies with a index.js inside, as shown below.

    __/your_local_dependencies
        |__dependency-a
            |__index.js
        |__dependency-b
            |__index.js   
            |__package.json // Optional if you have other npm dependencies
    

    e.g of index.js inside dependency-a

    var sayHello = function() {
        console.log("hello");
    };
    module.exports.sayHello = sayHello;
  2. Open a package.json file in your code base which depends on a local dependency (lets say 'dependency-a' and 'dependency-b') and include the section 'customDependencies', as shown below.

    {
        "dependencies": {},
        "customDependencies": {
            "dependency-a" : "local",
            "dependency-b" : "local"
        }
    }
  3. Initialize the custom dependency path for the library, as shown below.

    var gulp = require('gulp');
    var gulpDi = require('gulp-dependency-install');
     
    gulp.task('npm-install', function () {
        gulpDi.init('<your_local_dependencies-directory>'); // Optionally initialize the directory where custom dependencies resides
        return gulpDi.install(['<your-directory>']);
    });

    Open a shell/commandline and run the followig command gulp npm-install

    Note: This executes 'npm install' for all the package.json files, installing NPM dependencies from NPM Registry and copying the custom dependencies from 'your_local_dependencies' directory to the respective 'node_modules' directory..

  4. Finally in your code requrie the dependency similar in using a module from NPM Registry, as shown below.

    var dependencyA = require('dependency-a');
    dependencyA.sayHello(); // Prints "Hello"

License

MIT

Package Sidebar

Install

npm i gulp-dependency-install

Weekly Downloads

44

Version

0.0.8

License

MIT

Last publish

Collaborators

  • mjfernando