Gulp-project-cypper NPM

Gulp Project Module for JS apps

Just cool tools for your cool projects.

Install

npm install gulp-project-cypper --save-dev

Example

const gulpProject = require('gulp-project-cypper');
const resolve = require('path').resolve;

gulpProject(resolve('./package.json'));

// or 

const pkg = require('./package.json');
gulpProject(pkg["gulp-project"]);

// or

const opt = {
	"sourceFile": "main.js",
	"sourceFolder": "./src/",
	...
};
gulpProject(opt);

Run gulp tasks

Node tasks
`gulp node` (runs file specified in option node)
`gulp nodeW`*

Browser tasks
`gulp browserify` (deploys files in sourceFolder into one file. File name is sourceFile and folder containing it is distFolder**)
`gulp browserifyW`*
`gulp browser` (runs `gulp browserify` and creates localhost in distFolder on port 1114.)
`gulp browserW`* (localhost is not created when watcher runs it again)

Github tasks***
`gulp gitIt` (do `gulp gitAdd` -> `gulp gitCommit` -> `gulp gitPush`)
`gulp gitIt`*
`gulp gitSetup` (do `gulp gitInit` -> `gulp gitAdd` -> `gulp gitAddremote`)
`gulp gitInit` (git init)
`gulp gitAdd` (git add git.cwd/**)
`gulp gitAddremote` (git remote add origin git.remote)
`gulp gitCheckout` (git checkout -b git.branch)
`gulp gitCommit` (git commit -m git.commitMessage)
`gulp gitPush` (git push origin git.branch)
`gulp gitMerge` (git merge git.branch)
`gulp gitFetch` (git fetch origin git.branch)
`gulp gitPull` (git pull origin git.branch)

Notes:

prefix W means that command runs the same as without W, but also program watches for changes in sourceFolder. If some occurs, runs command(without W) again.
deploys - means to do tasks bellow (in exactly followed order):
- rollupify (first)
- babelES2016
- babelES2015
- browserify
- uglify
- prettify
- banner (last)
- order has issues, will be changed in future, this is experimental.
all github tasks use option git, everything is experimental.

API

gulpProject(str , obj)

str
Type: string.
Absolyte path to your package.json.
Program extracts gulp-project option from your json. - pkg["gulp-project"]. Also if you change your package.json, you don't need to restart watchers, program will update options automatically. If you pass object you don't have that feature.

obj
Type: object.
Options for your project.

Options

sourceFile: "main.js"
sourceFolder: "./src/"
distFolder: "./dist/"
uglify: false
prettify: false
banner:
- on: true
- content: "/* Cypper */ \n"
babelES2015: false
babelES2016-2017: true
rollupify: true
browserify: true
strict: true (if file in sourceFolder don't have "use-strict"; on the top, put it there)
git:
- remote: "https://github.com/cypper/NaN.git"
- branch: "master"
- cwd: "./"
- files: "./*", "!./node_modules/"
- commitMessage: "cypper"
jshint:
- on: false
- opt:
  - strict: true
  - browser: true
  - browserify: true
  - devel: true
  - eqeqeq: true
  - eqnull: true
  - maxdepth: 3
  - undef: true
  - plusplus: false
  - quotmark: "dounle"
  - esversion: 6
node:
- es-modules: true
- timeout: 10000
- cwd: "./src/"
- sourceFile: "main.js"