@pipeline/pipe-scripts

1.0.0 • Public • Published

@pipelinejs/pipe-scripts

Build Status Dependency Status devDependency Status Code Climate Test Coverage

A pipe plugin which utilizes browserify and babel to compile your JavaScript bundles.

Features

  • Easily compile your application package bundles.
  • Automatic minification of your bundles based on the PIPELINE_ENV environment variable.

Installation

npm i -D @pipeline/pipe-scripts

Example pipefile.js

import pipe from '@pipelinejs/pipe';
import scripts from '@pipelinejs/pipe-scripts';

// Register the plugin.
pipe.use(scripts).configure({
	id: 'compile:scripts'
});

// Register your application packages.
pipe.package('myPackage').configure({
	directory: 'myPackage/',

	// Example configuration for the scripts task.
	// All paths are relative to it's parent, f.e.:
	// `src` and `dest` are relative to the `directory` of your package.
	// `src` and `dest` of your bundle, are relative to the parents `src` and `dest` path.
	scripts: {
		src: 'src/js/',
		dest: 'dist/js/',

		bundles: [{
			id: 'app',
			src: 'index.js',
			dest: 'index.min.js'
		}]
	}
});

Contributing

We use xo to lint the code, please take care to run npm test before you commit something. If you add or modify methods or the API, please add unit tests as specified in the *.spec.js files.

License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

none

Package Sidebar

Install

npm i @pipeline/pipe-scripts

Weekly Downloads

0

Version

1.0.0

License

MIT

Last publish

Collaborators

  • pipeline