main-bower-files - npm Package Compare versions

Comparing version 2.9.0 to 2.11.0

index.js

 module.exports = process.env.LIB_COV ? require('./lib-cov') : require('./lib');

lib/index.js

@@ -21,3 +21,3 @@ var readFile           = require('fs').readFileSync,
         filter = null;
-    } else if (typeof filter !== 'string' && Array.isArray(filter) === false) {
+    } else if (typeof filter !== 'string' && Array.isArray(filter) === false && !(filter instanceof RegExp)) {
         if (typeof opts === 'function') {
@@ -24,0 +24,0 @@ cb = opts;

lib/logger.js

@@ -0,0 +0,0 @@ var chalk = require('chalk'),

lib/package_collection.js

@@ -71,2 +71,3 @@ var path                = require('path'),
         var name,
+            group = this.opts.group || null,
             includeDev = this.opts.includeDev || false,
@@ -83,16 +84,31 @@ includeSelf = this.opts.includeSelf || false,
 
-        if (includeDev !== 'exclusive') {
-            for (name in dependencies) {
-                this.add(name, path.join(this.opts.paths.bowerDirectory, path.sep, name));
+        // add packages from group option or add packages entirely from bower file
+        if (group && bowerJson.group) {
+            if (!bowerJson.group[group]) {
+                throw new Error('group "' + group + '" does not exists in bower.json');
             }
-        }
 
-        if (includeDev !== false) {
-            for (name in devDependencies) {
-                this.add(name, path.join(this.opts.paths.bowerDirectory, path.sep, name));
+            var deps = bowerJson.group[group];
+
+            if (deps instanceof Array) {
+                for (var i in deps) {
+                    this.add(deps[i], path.join(this.opts.paths.bowerDirectory, path.sep, deps[i]));
+                }
             }
-        }
+        } else {
+            if (includeDev !== 'exclusive') {
+                for (name in dependencies) {
+                    this.add(name, path.join(this.opts.paths.bowerDirectory, path.sep, name));
+                }
+            }
 
-        if (includeSelf !== false) {
-            this.add(main, path.join(path.dirname(this.opts.paths.bowerJson)));
+            if (includeDev !== false) {
+                for (name in devDependencies) {
+                    this.add(name, path.join(this.opts.paths.bowerDirectory, path.sep, name));
+                }
+            }
+
+            if (includeSelf !== false) {
+                this.add(main, path.join(path.dirname(this.opts.paths.bowerJson)));
+            }
         }
@@ -99,0 +115,0 @@ },

lib/package.js

@@ -0,0 +0,0 @@ var path     = require('path'),

package.json

 {
   "name": "main-bower-files",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Get main files from your installed bower packages.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -31,5 +31,6 @@ main-bower-files
 
-If first argument is type of `String` or `Array` it will be used as a filter, otherwise it will be used as options.
+If first argument is type of `String`, `Array` or `RegExp` it will be used as a filter, otherwise it will be used as options.
 
-This will read your `bower.json`, iterate through your dependencies and returns an array of filesdefined in the main property of the packages `bower.json`.
+This will read your `bower.json`, iterate through your dependencies and returns an array of files defined in the main property of the packages `bower.json`.
+
 You can override the behavior if you add an `overrides` property to your own `bower.json`.
@@ -52,2 +53,3 @@
 `mainBowerFiles` returns an array of files where each file is a absolute path without any globs (** or *). gulp requires globs in these paths to apply the base path. Because of this, you always have to tell gulp your bower base path (the path to the bower_components directory) explicitly.
+
 Here is an example:
@@ -68,3 +70,5 @@
 ### Usage with grunt
+
 Install this plugin with the following command:
+
 ```bash
@@ -75,2 +79,3 @@ npm install --save-dev main-bower-files
 Once that's done, add this line to your project's Gruntfile:
+
 ```javascript
@@ -81,2 +86,3 @@ grunt.loadNpmTasks('main-bower-files');
 In your project's Gruntfile, add a section named `bower` to the data object passed into `grunt.initConfig()`, like so:
+
 ```javascript
@@ -130,3 +136,4 @@ grunt.initConfig({
 
-Type: `String` or `Array` or `Object`  
+Type: `String` or `Array` or `Object`
+
 You can specify which files should be selected. You can `main-bower-files` select files based on the `process.env.NODE_ENV` if you provide an `Object` with `keys` as the environment, e.g.:
@@ -161,3 +168,4 @@
 
-Type: `Boolean` Default: `false`  
+Type: `Boolean` Default: `false`
+
 Set to `true` if you want to ignore this package.
@@ -167,3 +175,4 @@
 
-Type: `Object`  
+Type: `Object`
+
 You can override the dependencies of a package. Set to `null` to ignore the dependencies.
@@ -177,3 +186,4 @@
 
-Type: `boolean` Default: `false`  
+Type: `boolean` Default: `false`
+
 Set to `true` to enable debugging output.
@@ -183,3 +193,4 @@
 
-Type: `String` or `Array` or `Object` Default: `null`  
+Type: `String` or `Array` or `Object` Default: `null`
+
 You can specify for all packages a default main property which will be used if the package does not provide a main property.
@@ -189,3 +200,4 @@
 
-Type: `String` Default: `process.env.NODE_ENV`  
+Type: `String` Default: `process.env.NODE_ENV`
+
 If `process.env.NODE_ENV` is not set you can use this option.
@@ -195,5 +207,8 @@
 
-Type: `Object` or `String`  
+Type: `Object` or `String`
+
 You can specify the paths where the following bower specific files are located:
-`bower_components`, `.bowerrc` and `bower.json`  
+
+`bower_components`, `.bowerrc` and `bower.json`
+
 For example:
@@ -212,3 +227,4 @@
 
-If a `String` is supplied instead, it will become the basepath for default paths.  
+If a `String` is supplied instead, it will become the basepath for default paths.
+
 For example:
@@ -229,4 +245,6 @@
 
-Type: `boolean` Default: `false`  
+Type: `boolean` Default: `false`
+
 Set this to true if you want that the plugin checks every file for existence.
+
 If enabled and a file does not exists, the plugin will throw an exception.
@@ -236,4 +254,6 @@
 
-Type: `mixed` Default: `false`  
+Type: `mixed` Default: `false`
+
 You can include your devDependencies in two ways:
+
 * Set this option to `inclusive` or true to add the devDependencies to your dependencies
@@ -244,7 +264,10 @@ * or use `exclusive` to exclude your dependencies
 
-Type: `boolean` Default: `false`  
+Type: `boolean` Default: `false`
+
 Set this to true to add the main files to your dependencies
 
 ### filter
-Type: `RegExp` or `function` or `glob` Default: `null`  
+
+Type: `RegExp` or `function` or `glob` Default: `null`
+
 You can filter the list of files by a regular expression, glob or callback function (the first and only argument is the file path).
@@ -254,5 +277,33 @@
 
-Type: `object` Default: `{}`  
-Set default overrides option which can be overriden in the `overrides` section of the `bower.json`
+Type: `object` Default: `{}`
 
+Set default overrides option which can be overridden in the `overrides` section of the `bower.json`
+
+### group
+
+Type: `String` Default: `null`
+
+You can specify a group of dependencies you want to read from bower.json
+
+For example:
+
+```json
+{
+    "dependencies": {
+        "BOWER-PACKAGE-1": "*",
+        "BOWER-PACKAGE-2": "*",
+        "BOWER-PACKAGE-3": "*",
+        "BOWER-PACKAGE-4": "*"
+    },
+    "group": {
+        "home": [ "BOWER-PACKAGE-1" ],
+        "admin": [ "BOWER-PACKAGE-1", "BOWER-PACKAGE-2", "BOWER-PACKAGE-3" ]
+    }
+}
+```
+
+```javascript
+mainBowerFiles({ paths: 'path/for/project', group: 'home' });
+```
+
 ## LICENSE
@@ -282,2 +333,1 @@
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

tasks/main-bower-files.js

@@ -0,0 +0,0 @@ 'use strict';

test/_bower_with_comments.json

@@ -0,0 +0,0 @@ {

test/_bower.json

@@ -0,0 +0,0 @@ {

test/_cyclic_bower.json

@@ -0,0 +0,0 @@ {

test/_dependencies_bower.json

@@ -0,0 +0,0 @@ {

test/_empty.json

 {
 }

test/_env_based_bower.json

@@ -0,0 +0,0 @@ {

test/_includedev_bower.json

@@ -0,0 +0,0 @@ {

test/_includedev_devdepsonly_bower.json

@@ -0,0 +0,0 @@ {

test/_includeSelf_bower.json

 {
   "main": "main.js"
 }

test/_nojson_bower.json

@@ -0,0 +0,0 @@ {

test/_not_existing_file.json

@@ -0,0 +0,0 @@ {

test/_not_existing_main.json

@@ -0,0 +0,0 @@ {

test/_other_dependencies_bower.json

@@ -0,0 +0,0 @@ {

test/_recursive_bower.json

@@ -0,0 +0,0 @@ {

test/fixtures/cyclic-a/bower.json

@@ -0,0 +0,0 @@ {

test/fixtures/cyclic-a/cyclic-a.js

 // I do nothing

test/fixtures/cyclic-b/bower.json

@@ -0,0 +0,0 @@ {

test/fixtures/cyclic-b/cyclic-b.js

 // I do nothing

test/fixtures/decoy/bower.json

 {
     "main": "./decoy.js"
 }

test/fixtures/decoy/decoy.js

 // I do nothing

test/fixtures/decoy/example/simple.js

 // I do nothing and should not be listed.

test/fixtures/deepPaths/bower.json

 {
     "main": "lib/deeppaths.js"
 }

test/fixtures/envBased/bower.json

 {
     "main": "default.js"
 }

test/fixtures/hasPackageNoBower/hasPackageNoBower.js

 //I also do nothing

test/fixtures/hasPackageNoBower/package.json

@@ -0,0 +0,0 @@ {

test/fixtures/ignore/ignore.js

 // I do nothing and should not be on the list, because I was ignored by the bower.json

test/fixtures/includeDev/bower.json

 {
   "main": "./includeDev.js"
 }

test/fixtures/includeDev/includeDev.js

 // I do nothing

test/fixtures/multi/bower.json

@@ -0,0 +0,0 @@ {

test/fixtures/multi/multi.js

 // I do nothing

test/fixtures/not-existing-file/bower.json

 {
     "main": "not-existing-file.js"
 }

test/fixtures/not-existing-main/bower.json

 {
     "name": "not-existing-main"
 }

test/fixtures/overwritten/another.js

 // I do nothing, but I am on the list!

test/fixtures/overwritten/bower.json

 {
     "main": "./overwritten.js"
 }

test/fixtures/overwritten/overwritten.js

 // I do nothing and should not be on the list, because I was overwritten by the bower.json

test/fixtures/recursive/bower.json

@@ -0,0 +0,0 @@ {

test/fixtures/recursive/recursive.js

 // I do nothing

test/fixtures/simple/bower.json

 {
     "main": "./simple.js"
 }

test/fixtures/simple/simple.js

 // I do nothing

test/main.js

@@ -30,3 +30,3 @@ var mainBowerFiles = require('../'),
 
-            if (typeof filter === 'string' || Array.isArray(filter)) {
+            if (typeof filter === 'string' || Array.isArray(filter) || filter instanceof RegExp) {
                 delete options.filter;
@@ -293,2 +293,34 @@ srcFiles = mainBowerFiles(filter, options, options.callback || undefined);
     });
+
+    it('should select all files if no group options pass to function', function(done) {
+        expect([
+            '/fixtures/simple/simple.js',
+            '/fixtures/overwritten/overwritten.js',
+            '/fixtures/multi/multi.js',
+            '/fixtures/multi/multi.css',
+            '/fixtures/hasPackageNoBower/hasPackageNoBower.js',
+            '/fixtures/deepPaths/lib/deeppaths.js',
+            '/fixtures/decoy/decoy.js'
+        ]).fromConfig('/_bower_with_group.json').when(done);
+    });
+
+    it('should select the expected files from group propery in bower.json', function(done) {
+        expect([
+            '/fixtures/simple/simple.js',
+            '/fixtures/multi/multi.js',
+            '/fixtures/multi/multi.css'
+        ]).fromConfig('/_bower_with_group.json', { group: 'group1' }).when(done);
+    });
+
+    it('should throw an exception if group name does not exist', function() {
+        var when = expect([]).fromConfig('/_bower_with_group.json', { group: 'nonExistingGroup' }).when;
+
+        when.should.throw('group "nonExistingGroup" does not exists in bower.json');
+    });
+
+    it('should ignore nonexisting packages in the group', function(done) {
+        expect([
+            '/fixtures/simple/simple.js'
+        ]).fromConfig('/_bower_with_group.json', { group: 'containDepsError' }).when(done);
+    });
 });

No alert changes

Improved metrics

Total package byte prevSize

41300

increased by4.35%

Number of package files

65

increased by3.17%

Lines of code

846

increased by7.09%

Number of lines in readme file

316

increased by18.8%

No dependency changes