scaffold - npm Package Compare versions

Comparing version 0.2.5 to 0.2.6

index.js

@@ -45,4 +45,23 @@ /*!
 /**
- * Static method that returns true if the given value appears to
- * be a scaffold configuration object or an instance of `Scaffold`.
+ * Static method, returns `true` if the given value is an
+ * instance of `Scaffold` or appears to be a valid `scaffold`
+ * configuration object.
+ *
+ * ```js
+ * Scaffold.isScaffold({});
+ * //=> false
+ *
+ * var blog = new Scaffold({
+ *   post: {
+ *     src: 'content/post.md',
+ *     dest: 'src/posts/'
+ *   }
+ * });
+ * Scaffold.isScaffold(blog);
+ * //=> true
+ * ```
+ * @static
+ * @param {Object} `val` The value to check
+ * @return {Boolean}
+ * @api public
  */
@@ -49,0 +68,0 @@

package.json

 {
   "name": "scaffold",
   "description": "Conventions and API for creating declarative configuration objects for project scaffolds - similar in format to a grunt task, but more portable, generic and can be used by any build system or generator - even gulp.",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "homepage": "https://github.com/jonschlinkert/scaffold",
@@ -29,4 +29,4 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
     "is-scaffold": "^0.1.1",
-    "lazy-cache": "^1.0.3",
-    "use": "^1.1.2"
+    "lazy-cache": "^2.0.1",
+    "use": "^2.0.0"
   },
@@ -40,6 +40,6 @@ "devDependencies": {
     "gulp-mocha": "^2.1.3",
-    "mocha": "*",
-    "repeat-string": "^1.5.2",
-    "should": "*",
-    "stringify-object": "jonschlinkert/stringify-object"
+    "mocha": "^2.4.5",
+    "repeat-string": "^1.5.4",
+    "should": "^8.3.1",
+    "stringify-object": "^2.3.1"
   },
@@ -46,0 +46,0 @@ "keywords": [

README.md

@@ -1,2 +0,2 @@
-# scaffold [![NPM version](https://img.shields.io/npm/v/scaffold.svg)](https://www.npmjs.com/package/scaffold)
+# scaffold [![NPM version](https://img.shields.io/npm/v/scaffold.svg?style=flat)](https://www.npmjs.com/package/scaffold) [![Build Status](https://img.shields.io/travis/jonschlinkert/scaffold.svg?style=flat)](https://travis-ci.org/jonschlinkert/scaffold)
 
@@ -7,19 +7,2 @@ > Conventions and API for creating declarative configuration objects for project scaffolds - similar in format to a grunt task, but more portable, generic and can be used by any build system or generator - even gulp.
 
-- [The goal](#the-goal)
-- [Install](#install)
-- [Usage](#usage)
-- [Examples](#examples)
-- [API](#api)
-- [What is a scaffold?](#what-is-a-scaffold-)
-  * [Comparison table](#comparison-table)
-- [Related projects](#related-projects)
-- [Tests](#tests)
-  * [Test coverage](#test-coverage)
-  * [Running tests](#running-tests)
-- [Contributing](#contributing)
-- [Author](#author)
-- [License](#license)
-
-_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
-
 ## The goal
@@ -36,3 +19,3 @@
 
-The following scaffold "expands" into a configuration object that can be passed to [gulp](http://gulpjs.com), [grunt](http://gruntjs.com/), [assemble](http://assemble.io), [metalsmith](https://github.com/segmentio/metalsmith), or even [yeoman](http://yeoman.io) for scaffolding out various parts of a blog or site (like adding a new post, UI component, etc):
+The following scaffold "expands" into a configuration object that can be passed to [gulp](http://gulpjs.com), [grunt](http://gruntjs.com/), [assemble](https://github.com/assemble/assemble), [metalsmith](https://github.com/segmentio/metalsmith), or even [yeoman](http://yeoman.io) for scaffolding out various parts of a blog or site (like adding a new post, UI component, etc):
 
@@ -107,3 +90,3 @@ ```js
 ```sh
-$ npm i scaffold --save
+$ npm install scaffold --save
 ```
@@ -179,4 +162,29 @@
 
-### [.addTargets](index.js#L68)
+### [.isScaffold](index.js#L68)
 
+Static method, returns `true` if the given value is an instance of `Scaffold` or appears to be a valid `scaffold` configuration object.
+
+**Params**
+
+* `val` **{Object}**: The value to check
+* `returns` **{Boolean}**
+
+**Example**
+
+```js
+Scaffold.isScaffold({});
+//=> false
+
+var blog = new Scaffold({
+  post: {
+    src: 'content/post.md',
+    dest: 'src/posts/'
+  }
+});
+Scaffold.isScaffold(blog);
+//=> true
+```
+
+### [.addTargets](index.js#L87)
+
 Add targets to the scaffold, while also normalizing src-dest mappings and expanding glob patterns in each target.
@@ -198,3 +206,3 @@
 
-### [.addTarget](index.js#L108)
+### [.addTarget](index.js#L127)
 
@@ -251,5 +259,5 @@ Add a single target to the scaffold, while also normalizing src-dest mappings and expanding glob patterns in the target.
 * [boilerplate](https://www.npmjs.com/package/boilerplate): Tools and conventions for authoring and publishing boilerplates that can be generated by any build… [more](https://www.npmjs.com/package/boilerplate) | [homepage](http://boilerplates.io)
-* [generate](https://www.npmjs.com/package/generate): Fast, composable, highly extendable project generator for node.js | [homepage](https://github.com/jonschlinkert/generate)
+* [generate](https://www.npmjs.com/package/generate): Fast, composable, highly extendable project generator with a user-friendly and expressive API. | [homepage](https://github.com/generate/generate)
 * [templates](https://www.npmjs.com/package/templates): System for creating and managing template collections, and rendering templates with any node.js template engine.… [more](https://www.npmjs.com/package/templates) | [homepage](https://github.com/jonschlinkert/templates)
-* [update](https://www.npmjs.com/package/update): Update | [homepage](https://github.com/jonschlinkert/update)
+* [update](https://www.npmjs.com/package/update): Easily keep anything in your project up-to-date by installing the updaters you want to use… [more](https://www.npmjs.com/package/update) | [homepage](https://github.com/update/update)
 * [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://www.npmjs.com/package/verb) | [homepage](https://github.com/verbose/verb)
@@ -261,3 +269,3 @@
 
-As of January 06, 2016:
+As of May 11, 2016:
 
@@ -276,3 +284,3 @@ ```
 ```sh
-$ npm i -d && npm test
+$ npm install -d && npm test
 ```
@@ -293,7 +301,7 @@
 
-Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
-Released under the MIT license.
+Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT license](https://github.com/jonschlinkert/scaffold/blob/master/LICENSE).
 
 ***
 
-_This file was generated by [verb](https://github.com/verbose/verb) on January 06, 2016._
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 11, 2016._

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16192

3.97%

Lines of code

152

14.29%

Number of lines in readme file

298

2.76%

Worsened metrics

Number of low supply chain risk alerts

2

100%

Dependency changes

• + Added

  use@2.0.2
  (transitive)

• Updated

  lazy-cache@^2.0.1

• Updated

  use@^2.0.0