0.0.3 • Published 6 years ago

remove-local-package-directories v0.0.3

Weekly downloads
6
License
MIT
Repository
github
Last release
6 years ago

Remove local directory packages

Build Status

Based on ArnaudRinquin/rm-local-modules

Removes your locally installed modules.

Use case:

  • Make sure you always have latest version of your locally installed modules using it in preinstall. Example. There is a caveat though, as npm@3 preinstall is broken. Works fine with npm@2

CLI Options

-verbose, -v: outputs which modules where detected and if they were successfully removed:

Tried to remove 2 local module(s):
local ✔
sublocal ✔

-dir, -d <path>: the path were to run the tool, defaults to current dir.

Programmatically

var rmLocalModules = require('.');

var opts = {
  log: console.log.bind(console), // optional
  dir: '.', // mandatory
};

rmLocalModules(opts).then(function(results){
  // results is like [
  //   {name: 'local', success: true},
  //   {name: 'local', success: false, error: ... }
  // ]
});

Example

// package.json
{
  // ...
  "scripts": {
    "preinstall": "rm-local-modules"
  },
  "dependencies": {
    "local": "file:local",
    "sublocal": "file:sub/local"
  },
  "devDependencies": {
    "rm-local-modules": "^0.0.0"
  }
}