build-workflow

Build Workflow

Simple helper to create grunt build workflows that are easy to configure and use.

what is it?

This is a simple module that aims to make simpler to create workflows based on grunt. This module helps you break a grunt file in several modules that are easier to maintain and to reason about.

This module is inspired by this blog post supercharging your gruntfile

The main differences are:

• config files exports a function that return an object. All the config objects receive the grunt object, the pkg object and options object. The options object contains a commonConfig object that can be used to share some config info between task configurations, and also exports the gruntTaskUtils module from grunt-ez-frontend a module that exports a registerTasks methods that allows you to register both tasks and multiTasks by passing an object instead of using two different methods.

• allows load custom grunt tasks.

• do not use yaml, so the aliases should be defined in javascript

• provide some base common tasks described below

So, This module will

• help you break your gigantic grunt file
• provide some (optional) base tasks and tasks configurations like:
  • changelog: Create a changelog from the git log info. For more info check the changelog section.
  • check-valid: Beautify (with jsbeautify) and validate the javascript files with jshint, jscs and jsvalidate.
  • install-hooks: Install commit-msg and prepush hooks for git. To enforce the rules for commit messages and to verify all files configured to be beautified and validated are checked before pushing.
  • prepush: the tasks that the prepush hook runs before any push is made.
  • i18n-from-yml: Generate i18n.{lang}.js files from yml translations files. (this is actually inside grunt-ez-frontend)
  • i18n-to-ez-frontend: create an ez-frontend task for each i18n.{lang}.js file to make each of them be minified, had the right version and include the banner header.
  • run-i18n-targets: execute all the ez-frontend targets created by the previous task.
  • css-font: a custom task to create the css and less mixins for a font from the selection.json file obtained from the icomoon app
  • target, js-target, css-target: tasks to run ez-frontend targets.
  • validate-files: a custom task to validate files passed as parameters. Useful to beautify the code from within an IDE.

Usage

check usage here

Changelog

v0.0.25

• Enhancements

  • factorized prepush and check-valid - c1b5069, royriojas, 11/09/2014 12:08:51

    check-valid now can specify options in a config file.

    • useNewer: true. Whether to use grunt-newer to only check changed files
    • tasksToRun: 'jsbeautifier,jscs,jshint,jsvalidate' which tasks to run as part of the check-valid task
    • filesToValidate: what files to validate (an array of globs like: ['src/**/*.js']) By default will use the same files on the filesToValidate Object from common-config.js file.
    • forceBeautify: true. By default the files will be beatufied automatically. If this is set to false. The task will break on the first file that needed beautification.

    Same as check-valid but

    • useNewer: is false by deafult
    • forceBeautify: is false by default.

  • Use grunt-newer to improve speed of validation check - 0c83980, royriojas, 11/09/2014 11:45:31

  • Use grunt newer to validate valid files - 5868d99, royriojas, 11/09/2014 11:38:44