assemble-fs - npm Package Compare versions

Comparing version 0.4.2 to 0.4.3

index.js

@@ -18,4 +18,7 @@ /*!
   return function(app) {
+    if (!this.isApp) return;
     plugin.call(app, app);
+
     return function(collection) {
+      if (!this.isCollection) return;
       plugin.call(collection, collection);
@@ -22,0 +25,0 @@ };

package.json

 {
   "name": "assemble-fs",
   "description": "Assemble plugin to add methods to assemble for working with the file system, like src, dest, copy and symlink.",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "homepage": "https://github.com/assemble/assemble-fs",
@@ -28,14 +28,15 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
     "stream-combiner": "^0.2.2",
-    "through2": "^2.0.0",
-    "vinyl-fs": "^2.3.1"
+    "through2": "^2.0.1",
+    "vinyl-fs": "^2.4.2"
   },
   "devDependencies": {
     "buffer-equal": "^1.0.0",
-    "graceful-fs": "^4.1.2",
-    "gulp-format-md": "^0.1.5",
-    "mocha": "*",
-    "rimraf": "^2.5.0",
-    "should": "*",
-    "sinon": "^1.17.2",
-    "templates": "^0.10.7",
+    "expect": "^1.14.0",
+    "graceful-fs": "^4.1.3",
+    "gulp-format-md": "^0.1.7",
+    "mocha": "^2.4.5",
+    "rimraf": "^2.5.2",
+    "should": "^8.2.2",
+    "sinon": "^1.17.3",
+    "templates": "^0.15.5",
     "vinyl": "^1.1.1"
@@ -52,2 +53,11 @@ },
   "verb": {
+    "run": true,
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
     "related": {
@@ -61,6 +71,9 @@ "list": [
     },
-    "plugins": [
-      "gulp-format-md"
-    ]
+    "reflinks": [
+      "verb"
+    ],
+    "lint": {
+      "reflinks": true
+    }
   }
 }

README.md

@@ -5,4 +5,2 @@ # assemble-fs [![NPM version](https://img.shields.io/npm/v/assemble-fs.svg)](https://www.npmjs.com/package/assemble-fs) [![Build Status](https://img.shields.io/travis/assemble/assemble-fs.svg)](https://travis-ci.org/assemble/assemble-fs)
 
-This is an assemble core plugin, you probably won't need to use this directly.
-
 ## Install
@@ -13,5 +11,7 @@
 ```sh
-$ npm i assemble-fs --save
+$ npm install assemble-fs --save
 ```
 
+This is an assemble core plugin, you probably won't need to use this directly.
+
 ## Usage
@@ -31,75 +31,36 @@
 
-## API
+## History
 
-### [.copy](index.js#L57)
+**v0.3.0**
 
-Copy files with the given glob `patterns` to the specified `dest`.
+* breaking change! plugin is wrapped in a function that now be called when registered. e.g. `fs()`. This is to be consistent with assemble's plugin guidelines, and allows the plugin to be auto-loaded following the same format as other plugins.
+* rename `files` array to `streamFiles`
+* adds `onStream` middleware handler to `src`
+* adds `preWrite` middleware handler to `dest`
 
-**Params**
+## Related projects
 
-* `patterns` **{String|Array}**: Glob patterns of files to copy.
-* `dest` **{String|Function}**: Desination directory.
-* `returns` **{Stream}**: Stream, to continue processing if necessary.
+* [assemble](https://www.npmjs.com/package/assemble): Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… [more](https://www.npmjs.com/package/assemble) | [homepage](https://github.com/assemble/assemble)
+* [assemble-loader](https://www.npmjs.com/package/assemble-loader): Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… [more](https://www.npmjs.com/package/assemble-loader) | [homepage](https://github.com/jonschlinkert/assemble-loader)
+* [assemble-render-file](https://www.npmjs.com/package/assemble-render-file): Assemble plugin for rendering views in a vinyl pipeline. | [homepage](https://github.com/jonschlinkert/assemble-render-file)
+* [assemble-streams](https://www.npmjs.com/package/assemble-streams): Assemble pipeline plugin for pushing a view collection into a vinyl stream. | [homepage](https://github.com/assemble/assemble-streams)
 
-**Example**
+## Contributing
 
-```js
-app.task('assets', function(cb) {
-  app.copy('assets/**', 'dist/')
-    .on('error', cb)
-    .on('finish', cb)
-});
-```
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/assemble-fs/issues/new).
 
-### [.src](index.js#L74)
+## Building docs
 
-Glob patterns or filepaths to source files.
+Generate readme and API documentation with [verb](https://github.com/verbose/verb):
 
-**Params**
-
-* `glob` **{String|Array}**: Glob patterns or file paths to source files.
-* `options` **{Object}**: Options or locals to merge into the context and/or pass to `src` plugins
-
-**Example**
-
-```js
-app.src('src/*.hbs', {layout: 'default'});
+```sh
+$ npm install verb && npm run docs
 ```
 
-### [.symlink](index.js#L92)
+Or, if [verb](https://github.com/verbose/verb) is installed globally:
 
-Glob patterns or paths for symlinks.
-
-**Params**
-
-* `glob` **{String|Array}**
-
-**Example**
-
-```js
-app.symlink('src/**');
+```sh
+$ verb
 ```
 
-### [.dest](index.js#L108)
-
-Specify a destination for processed files.
-
-**Params**
-
-* `dest` **{String|Function}**: File path or rename function.
-* `options` **{Object}**: Options and locals to pass to `dest` plugins
-
-**Example**
-
-```js
-app.dest('dist/');
-```
-
-## Related projects
-
-* [assemble](https://www.npmjs.com/package/assemble): Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… [more](https://www.npmjs.com/package/assemble) | [homepage](https://github.com/assemble/assemble)
-* [assemble-loader](https://www.npmjs.com/package/assemble-loader): Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… [more](https://www.npmjs.com/package/assemble-loader) | [homepage](https://github.com/jonschlinkert/assemble-loader)
-* [assemble-render-file](https://www.npmjs.com/package/assemble-render-file): Assemble plugin for rendering views in a vinyl pipeline. | [homepage](https://github.com/jonschlinkert/assemble-render-file)
-* [assemble-streams](https://www.npmjs.com/package/assemble-streams): Assemble pipeline plugin for pushing a view collection into a vinyl stream. | [homepage](https://github.com/jonschlinkert/assemble-streams)
-
 ## Running tests
@@ -110,18 +71,5 @@
 ```sh
-$ npm i -d && npm test
+$ npm install -d && npm test
 ```
 
-## Contributing
-
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/assemble-fs/issues/new).
-
-## History
-
-**v0.3.0**
-
-* breaking change! plugin is wrapped in a function that now be called when registered. e.g. `fs()`. This is to be consistent with assemble's plugin guidelines, and allows the plugin to be auto-loaded following the same format as other plugins.
-* rename `files` array to `streamFiles`
-* adds `onStream` middleware handler to `src`
-* adds `preWrite` middleware handler to `dest`
-
 ## Author
@@ -137,6 +85,6 @@
 Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
-Released under the MIT license.
+Released under the [MIT license](https://github.com/assemble/assemble-fs/blob/master/LICENSE).
 
 ***
 
-_This file was generated by [verb](https://github.com/verbose/verb) on January 19, 2016._
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on March 09, 2016._

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

Lines of code

156

increased by1.3%

Worsened metrics

Total package byte prevSize

10130

decreased by-5.49%

Dev dependency count

10

increased by11.11%

Number of lines in readme file

85

decreased by-37.96%

Dependency changes

• Updatedthrough2@^2.0.1

• Updatedvinyl-fs@^2.4.2