appcd-gulp

appcd-gulp

Common gulp tasks and utilities.

Visit https://github.com/appcelerator/appc-daemon for more information.

:warning: appcd-gulp@2.x requires Gulp 4. Use appcd-gulp@1.x for Gulp 3 compatibility.

Report issues to GitHub issues. Official issue tracker in JIRA.

Prerequisites

appcd-gulp requires you to globally install gulp 4.x:

[sudo] npm i -g gulp

Installation

npm i appcd-gulp --save-dev

Usage

Create a file in the root of your project called gulpfile.js:

'use strict';

require('appcd-gulp')({
	gulp:     require('gulp'),
	pkgJson:  require('./package.json'),
	template: 'standard',
	babel:    'node8'
});

There is currently only one template: standard.

You can specify the Node.js version you wish to transpile down to. Possibly values are node4, node6, node7, node8, node10, node12, and node14.

Gulp Tasks

Completely deletes all generated folders or a specific type:

$ gulp clean
$ gulp clean-coverage
$ gulp clean-dist
$ gulp clean-docs

Run eslint against your source code and tests.

$ gulp lint
$ gulp lint-src
$ gulp lint-test

Invoke Babel and transpile your code into the dist directory.

$ gulp build

Build and run unit tests using Mocha.

$ gulp test

Build and run unit tests with coverage reports using Mocha and nyc.

$ gulp coverage

Watch source files for changes to trigger a re-build.

$ gulp watch

Watch source and test files for changes to trigger a re-build and run tests.

$ gulp watch-test

Legal

This project is open source under the Apache Public License v2 and is developed by Axway, Inc and the community. Please read the LICENSE file included in this distribution for more information.