ncmp

NCMP - NPM Client Modules Postprocessor

NCMP is a simple tool which allows you to perform some postprocessing after npm installs or updates. It is mainly designed for usage in client infrastructures. So if you use npm as your main client package manager.

Installation

npm install ncmp

Usage

One of the goals of this project is to provide a modular as possible tool for npm postprocessing in web client infrastructures. The developers should have full control about all steps at any time.

You have to create a ncmp.json configuration file in the root folder of your project:

{
    "packages": {
        "jquery": ["dist/jquery.js", "dist/jquery.min.js"],
        "aurelia-framework": "dist/amd/aurelia-framework.js",
        "aurelia-templating": "dist/amd/aurelia-templating.js"
    },
    "plugins": []
}

In the "plugins" array you can define a set of plugins (in their execution order) which can do more specific postprocessing.

Plugins

• ncmp-copy-plugin
• ncmp-systemjs-plugin
• ncmp-requirejs-plugin

Writing Plugins

There are some requirements for new plugins:

• The name of the plugin npm module has to be ncmp-XXX-plugin. Where XXX is the string for the "plugins" config section.
• The main file has to define and export a function with this signature: runPlugin(chain). The chain has to be returned.
• To retrieve the config you have to reference ncmp as a peerDependency. The config variable is exported.
• Create a pull request for this README and extend the list of plugins above.

License

MIT