zkflow-node v1.0.0

ZKflow for node

Gulp tasks for node projects powered by ZKflow

Shields

Quickstart

Just put this code in gulpfile.js

require('zkflow-node').init();

Usage

Make sure you understand how ZKflow works

init

require('zkflow-node').init(options, gulp);

gulp

Optional. If you get task not found error you probably should do

require('zkflow-node').init(options, require('gulp'));

options

Optional. Default options

{
  'lint-js': {
    task: require('zkflow-task-eslint'),
    eslint: {
      rules: {
        quotes: [2, 'single'],
        semi: [2, 'always'],
        eqeqeq: 2,
        strict: 2,
        'vars-on-top': 2,
        'comma-style': 2,
        indent: [2, 2],
        'linebreak-style': [2, 'unix'],
        'one-var': [2, 'never'],
        'no-trailing-spaces': 2,
        'no-multiple-empty-lines': [2, { 'max': 2, 'maxBOF': 0, 'maxEOF': 0 }],
        camelcase: [2, { properties: 'never' }],
        'comma-spacing': 2,
        'key-spacing': 2,
        'object-curly-spacing': [2, 'always']
      },
      env: {
        'node': true,
        'jasmine': true
      },
      extends: 'eslint:recommended'
    }
  },
  test: {
    task: require('zkflow-task-jasmine')
  },
  ci: {
    task: require('zkflow-task-sequence'),
    sequence: ['lint-js', 'test'],
    mode: {
      watch: false,
      eslintFix: false
    }
  },
  default: {
    task: require('zkflow-task-sequence'),
    sequence: ['lint-js', 'test'],
    mode: {
      eslintFix: false
    }
  }
}

mode

require('zkflow-node').mode;

Default mode

{
  watch: true,
  eslintFix: true
}

Sponsors