main-bower-files - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

lib/index.js

@@ -24,5 +24,7 @@ var fs                 = require('fs'),
     if (typeof opts.paths === 'string'){
-        opts.paths.bowerJson        = path.join(opts.paths, defaults.paths.bowerJson);
-        opts.paths.bowerrc          = path.join(opts.paths, defaults.paths.bowerrc);
-        opts.paths.bowerDirectory   = path.join(opts.paths, defaults.paths.bowerDirectory);
+        opts.paths = {
+            bowerJson        : path.join(opts.paths, defaults.paths.bowerJson),
+            bowerrc          : path.join(opts.paths, defaults.paths.bowerrc),
+            bowerDirectory   : path.join(opts.paths, defaults.paths.bowerDirectory)
+        };
     }
@@ -29,0 +31,0 @@

package.json

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

README.md

@@ -5,2 +5,19 @@ main-bower-files
 
+- [Usage](#usage)
+    - [Usage with gulp](#usage-with-gulp)
+    - [Usage with grunt](#usage-with-grunt)
+- [Options](#options)
+    - [Overrides Options](#overrides-options)
+        - [main](#main)
+        - [ignore](#ignore)
+        - [dependencies](#dependencies)
+    - [Common Options](#common-options)
+        - [debugging](#debugging)
+        - [main](#main-1)
+        - [env](#env)
+        - [paths](#paths)
+        - [checkExistence](#checkexistence)
+        - [includeDev](#includedev)
+        - [filter](#filter)
+
 ## Usage
@@ -72,6 +89,5 @@
 
-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.:
 
-You can specify which files should be selected. You can `gulp-bower-files` select files based on the `process.env.NODE_ENV` if you provide an `Object` with `keys` as the environment, e.g.:
-
 ```json
@@ -90,6 +106,17 @@ {
 
+You can also use glob pattern to select files, e.g.:
+
+```json
+{
+    "overrides": {
+        "BOWER-PACKAGE": {
+            "main": "**/*.js"
+        }
+    }
+}
+```
+
 #### ignore
 
-Type: `Boolean` Default: `false`
-
+Type: `Boolean` Default: `false`  
 Set to `true` if you want to ignore this package.
@@ -99,4 +126,3 @@
 
-Type: `Object`
-
+Type: `Object`  
 You can override the dependencies of a package. Set to `null` to ignore the dependencies.
@@ -110,4 +136,3 @@
 
-Type: `boolean` Default: `false`
-
+Type: `boolean` Default: `false`  
 Set to `true` to enable debugging output.
@@ -117,4 +142,3 @@
 
-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.
@@ -124,4 +148,3 @@
 
-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.
@@ -131,7 +154,5 @@
 
-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:
@@ -150,4 +171,3 @@
 
-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:
@@ -168,7 +188,15 @@
 
-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.
 
+#### includeDev
+
+Type: `boolean` Default: `false`  
+Set this to true if you want to include your dev dependencies.
+
+### filter
+Type: `RegExp` or `function` Default: `null`  
+You can filter the list of files by a regular expression or a callback function (the first and only argument is the file path).
+
 ## LICENSE
@@ -175,0 +203,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

Improved metrics

Total package byte prevSize

30805

increased by3.39%

Lines of code

628

increased by0.32%

Number of lines in readme file

216

increased by14.89%

No dependency changes