build-workflow - npm Package Compare versions

Comparing version 7.0.0 to 7.0.1

changelog.md

 
 # Build Workflow - Changelog
+## v7.0.1
+- **Documentation**
+  - Add more documentation about build-workflow - [8803e3a]( https://github.com/royriojas/build-workflow/commit/8803e3a ), [royriojas](https://github.com/royriojas), 20/08/2015 11:41:43
+
+    
 ## v7.0.0
@@ -4,0 +9,0 @@ - **Refactoring**

package.json

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

README.md

@@ -38,16 +38,18 @@ **IMPORTANT**
 Create the following folder structure
+
 ```bash
-
-- grunt-deps
-  - configs           # this will be directory where configs should live
-    - task-name.js    # should correspond to the name of the task and should return an object.
-                      # The object will be set in the cfg as cfg[task-name].
-  - tasks
-    - custom-task.js  # place here custom tasks. These can be either multitasks or single tasks
-                      # that for whatever reason are only needed in the current project
-  - workflows
-    - aliases.js      # use this file to define the sequence of your tasks.
-
-- Gruntfile.js        # the grunt
-- package.json        # your package.json
+your-project
+|--grunt-deps/
+|  |--configs/             # this will be directory where configs should live
+|  |  |--task-name.js      # should correspond to the name of the task and should return an object.
+|  |                       # The object will be set in the cfg as cfg[task-name].
+|  |
+|  |--tasks/               # place here custom tasks. These can be either multitasks or single tasks
+|  |  |--custom-task.js    # that for whatever reason are only needed in the current project
+|  |
+|  |--workflows/
+|     |--aliases.js        # use this file to define the sequence of your tasks.
+|
+|--Gruntfile.js            # the grunt
+|--package.json            # your package.json
 ```
@@ -57,3 +59,4 @@
 
-This is all the code required for your grunt file
+This is all the code required for your grunt file, because all the configuration sections have been moved to
+the their own file.
 
@@ -67,5 +70,72 @@ ```javascript
 
-Since each config block will be defined inside the `config` folder the Gruntfile is effectively broken into several
-pieces which are easier to manage that a gigantic configuration file.
+One of the benefits of this, is that navigating to a given task is super simple. Since each file has the name
+of the task, navigating to it, using sublime or other IDE is super simple. In `Sublime Text` you only need to
+type the name of the task to navigate directly to the file.
 
+## Example: Using grunt babel with build-workflow
+
+1.  Create the following folder structure:
+
+    ```bash
+    your-project
+    |--grunt-deps
+    |  |--configs
+    |  |  |--babel.js // this will have your configuration for babel
+    |  |--workflows
+    |     |--aliases.js // this will have your alias definitions
+    |--Gruntfile.js
+    ```
+
+2.  install `build-workflow` as a dev dependency
+
+    ```bash
+    npm i -D build-workflow
+    ```
+
+3.  the content of your `Gruntfile.js`
+
+    ```javascript
+    module.exports = function ( grunt ) {
+      'use strict';
+      require( 'build-workflow' )( grunt );
+    };
+    ```
+
+4.  the content of your `aliases.js`
+
+    ```javascript
+    module.exports = function ( grunt ) {
+      grunt.task.registerTask('default', ['babel']);
+    };
+    ```
+
+5.  The content of your `babel.js` file
+
+    ```javascript
+    module.exports = function ( grunt ) {
+      return {
+        'target': {
+          options: {
+            sourceMap: true
+          },
+          files: [{
+            src: 'src/**/*.js', // your files to transform
+            expand: true,
+            dest: 'dest/'       // the destination to move the tanspiled code
+          }]
+        }
+      };
+    };
+    ```
+
+6.  Now just run
+
+    ```bash
+    grunt babel
+    ```
+
+    If everythig went ok you should be able to see an output similar to this:
+
+
+
 ## Changelog
@@ -72,0 +142,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

71968

increased by2.58%

Number of lines in readme file

144

increased by94.59%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes