build-workflow - npm Package Compare versions

Comparing version 0.1.6 to 0.1.7

configs/changelog.js

@@ -73,3 +73,3 @@ module.exports = function ( grunt, pkg, options ) {
 
-            shortDescription = shortDescription.substr( 0, 70 );
+            shortDescription = shortDescription.substr( 0, 140 );
 
@@ -76,0 +76,0 @@ shortDescription = shortDescription.replace( me.format( '[{0}]', commit.bugId ), '{BUG_ID}' );

demo-structure/grunt-deps/configs/browserify.js

@@ -32,2 +32,10 @@ module.exports = function ( grunt, pkg, opts ) {
 
+        var filter = grunt.option( 'console-filter' );
+
+        if ( filter ) {
+          b.transform( require( 'build-workflow/utils/console-filter' ).configure( {
+            'filter': filter
+          } ));
+        }
+
         return b;
@@ -34,0 +42,0 @@ }

docs/usage.md

@@ -22,7 +22,10 @@ # Usage
   ```sh
+  # from the folder the folder where you have your package.json do:
   cp -rv node_modules/build-workflow/demo-structure/ .
   ```  
 
-4  **Install deps** 
+4  **Install demo deps** 
   ```sh
+  # this is only required for running the demo project
+  # you can ignore it if you want
   npm i -D grunt-http-server
@@ -43,3 +46,3 @@ ```
   
-  - **browserify**. So you can write your code in commonJS style, including a couple of useful transforms like `browserify-shim` and `require-arr`
+  - **browserify**. So you can write your code in commonJS style, including a couple of useful transforms `require-arr`
   - **build-workflow**. (files to format, validate and tasks to be executed during prepush hook)
@@ -46,0 +49,0 @@ - **bump**. To increase the version number

package.json

 {
   "name": "build-workflow",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Simple gruntfile helper to  define build workflows",
@@ -5,0 +5,0 @@ "main": "config-loader.js",

README.md

 # Build Workflow
 
-Simple helper to create grunt build workflows that are easy to configure and use. 
+Simple helper to create **build workflows**, using grunt, that are both easy to use and maintain. 
 
-## what is it?
+## Overview
 
-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 is a small module that aims to simplify the creation of workflows based on grunt. In order to achieve this
+some conventions are followed, i.e. do not use a gigantic `Gruntfile.js` that is soon harder to maintain, preventing
+a lot of spaghetti code by breaking it into different modules, one per each grunt task config, keeping things small
+and focused.
 
@@ -14,11 +16,14 @@ This module is inspired by this blog post [supercharging your gruntfile](http://www.html5rocks.com/en/tutorials/tooling/supercharging-your-gruntfile/)
 
-- config files exports a function that return an object. All the config objects receive the `grunt` object, the `pkg` object and `options` object.
-- allows load custom grunt tasks.
-- do not use yaml, so the aliases should be defined in javascript
-- provide some base common tasks described below
+- **config files** always export a function that return an object. All the config exported functions receive 
+  the `grunt` object, the `pkg`, `package.json` parsed object, and an `options` object, which has some helpers 
+  that will be described later.
+- Custom grunt tasks can be placed inside the `grunt-deps/tasks` folder they will be loaded automatically.
+- It does not use `yaml`, so the aliases for tasks are defined in javascript. This is to keep it simple and avoid 
+  leaving the javascript realm.
+- provide some base common tasks configs, described in the next section.
 
 So, This module will 
 
-- help you break your gigantic grunt file
-- provide some (optional) base tasks and tasks configurations like: 
+- help you break your gigantic grunt file into small modules that are easy to reason about.
+- 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.
@@ -44,2 +49,6 @@ - **check-valid**: Beautify (with `jsbeautify`) and validate the javascript files with `jshint`, `jscs` and `jsvalidate`.
 
-[check usage here](docs/usage.md) 
+For usage info please [read this document](docs/usage.md) 
+
+## Grunt configs/tasks provided by this package
+
+For info about the common configs and tasks please [check this document](docs/grunt.md)

New alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1664205

increased by453.42%

Number of package files

230

increased by58.62%

Lines of code

5716

increased by66.7%

Number of lines in readme file

52

increased by18.18%

Worsened metrics

Number of low license alerts

2

increased by100%

No dependency changes