sassdoc - npm Package Compare versions

Comparing version 2.0.0-rc.14 to 2.0.0-rc.15

dist/sassdoc.js

@@ -16,14 +16,15 @@ "use strict";
 var g2b = _require.g2b;
-var errors = require("./errors");
 
+
 var Environment = require("./environment");
 var Logger = require("./logger");
 var Parser = require("./parser");
+var errors = require("./errors");
+var sorter = require("./sorter");
 var exclude = require("./exclude");
 var recurse = require("./recurse");
-var sorter = require("./sorter");
 
-var difference = require("lodash.difference"); // jshint ignore:line
 var fs = require("fs");
 var path = require("path"); // jshint ignore:line
+var difference = require("lodash.difference"); // jshint ignore:line
 var mkdir = denodeify(require("mkdirp"));
@@ -37,4 +38,15 @@ var safeWipe = require("safe-wipe");
 /**
- * @return {Stream}
+ * Expose lower API blocks.
  */
+exports.Environment = Environment;
+exports.Logger = Logger;
+exports.Parser = Parser;
+exports.sorter = sorter;
+exports.errors = errors;
+
+
+/**
+ * Boostrap Parser and AnnotationsApi, execute parsing phase.
+ * @return {Stream.Promise}
+ */
 function parseFilter() {
@@ -55,2 +67,3 @@ var env = arguments[0] === undefined ? {} : arguments[0];
 /**
+ * Ensure a proper Environment Object and events.
  * @return {Object}
@@ -78,14 +91,6 @@ */
 /**
- * Expose API.
- */
-exports.Environment = Environment;
-exports.Logger = Logger;
-exports.Parser = Parser;
-exports.sorter = sorter;
-exports.errors = errors;
-
-
-/**
- * @param {String} src
+ * Default public API method.
+ * @param {String | Array} src
  * @param {Object} env
+ * @return {Promise | Stream}
  * @see srcEnv
@@ -103,4 +108,43 @@ */
   /**
+   * Safely wipe and re-create the destination directory.
    * @return {Promise}
    */
+  function refresh(env) {
+    // jshint ignore:line
+    return safeWipe(env.dest, {
+      force: true,
+      parent: is.string(env.src) ? g2b(env.src) : null,
+      silent: true }).then(function () {
+      return mkdir(env.dest);
+    }).then(function () {
+      env.logger.log("Folder \"" + env.dest + "\" successfully refreshed.");
+    })["catch"](function (err) {
+      // Friendly error for already existing directory.
+      throw new errors.SassDocError(err.message);
+    });
+  }
+
+  /**
+   * Render theme with parsed data context.
+   * @return {Promise}
+   */
+  function theme(env) {
+    // jshint ignore:line
+    var promise = env.theme(env.dest, env);
+
+    if (!is.promise(promise)) {
+      var type = Object.prototype.toString.call(promise);
+      throw new errors.Error("Theme didn't return a promise, got " + type + ".");
+    }
+
+    return promise.then(function () {
+      var themeName = env.themeName || "anonymous";
+      env.logger.log("Theme \"" + themeName + "\" successfully rendered.");
+    });
+  }
+
+  /**
+   * Execute full SassDoc sequence from a source directory.
+   * @return {Promise}
+   */
   function documentize(env) {
@@ -140,40 +184,3 @@ var data;
   /**
-   * Safely wipe and re-create the destination dir.
-   */
-  function refresh(env) {
-    // jshint ignore:line
-    return safeWipe(env.dest, {
-      force: true,
-      parent: is.string(env.src) ? g2b(env.src) : null,
-      silent: true }).then(function () {
-      return mkdir(env.dest);
-    }).then(function () {
-      env.logger.log("Folder \"" + env.dest + "\" successfully refreshed.");
-    })["catch"](function (err) {
-      // Friendly error for already existing directory.
-      throw new errors.SassDocError(err.message);
-    });
-  }
-
-  /**
-   * Render theme with parsed data.
-   */
-  function theme(env) {
-    // jshint ignore:line
-    var promise = env.theme(env.dest, env);
-
-    if (!is.promise(promise)) {
-      var type = Object.prototype.toString.call(promise);
-      throw new errors.Error("Theme didn't return a promise, got " + type + ".");
-    }
-
-    return promise.then(function () {
-      var themeName = env.themeName || "anonymous";
-      env.logger.log("Theme \"" + themeName + "\" successfully rendered.");
-    });
-  }
-
-  /**
-   * Pipe SassDoc to Vinyl files streams.
-   *
+   * Execute full SassDoc sequence from a Vinyl files stream.
    * @return {Stream}
@@ -232,4 +239,6 @@ */
 /**
- * @param {String} src
+ * Parse and return data object.
+ * @param {String | Array} src
  * @param {Object} env
+ * @return {Promise | Stream}
  * @see srcEnv
@@ -249,2 +258,5 @@ */
 
+  /**
+   * @return {Promise}
+   */
   function documentize(env) {
@@ -272,3 +284,4 @@ var data;
   /**
-   * Don't pass chuncks, but pass final data at the end.
+   * Don't pass files through, but pass final data at the end.
+   * @return {Stream}
    */
@@ -293,2 +306,5 @@ function stream(env) {
 
+/**
+ * Source directory fetching and parsing.
+ */
 function baseDocumentize(env) {
@@ -307,3 +323,3 @@ var filter, streams, pipeline;
           env.logger.debug(function () {
-            fs.writeFile("sassdoc-data.json", JSON.stringify(data, null, 2));
+            fs.writeFile("sassdoc-data.json", JSON.stringify(data, null, 2) + "\n");
 
@@ -314,3 +330,2 @@ return "Dumping data to \"sassdoc-data.json\".";
 
-
         streams = [// jshint ignore:line
@@ -421,5 +436,6 @@ vfs.src(env.src), recurse(), exclude(env.exclude || []), converter({ from: "sass", to: "scss" }), filter];
 /**
- * Log success message.
+ * Log final success message.
  */
 function okay(env) {
+  // jshint ignore:line
   env.logger.log("Process over. Everything okay!");
@@ -434,2 +450,4 @@ }
 
-/* jshint ignore:start */
+/* jshint ignore:start */
+
+/* jshint ignore:end */

package.json

@@ -24,3 +24,3 @@ {
   ],
-  "version": "2.0.0-rc.14",
+  "version": "2.0.0-rc.15",
   "license": {
@@ -98,3 +98,3 @@ "type": "MIT",
     "sass-convert": "^0.3.0",
-    "sassdoc-theme-default": "2.0.0-rc.10",
+    "sassdoc-theme-default": "2.0.0-rc.11",
     "scss-comment-parser": "0.5.1-rc.5",
@@ -101,0 +101,0 @@ "through2": "^0.6.3",

No alert changes

Improved metrics

Total package byte prevSize

156668

increased by0.37%

Lines of code

4328

increased by0.39%

Dependency changes

• + Addedbluebird@2.11.0(transitive)

• + Addedconsolidate@0.13.1(transitive)

• + Addedfs-extra@0.13.0(transitive)

• + Addedncp@1.0.1(transitive)

• + Addedsassdoc-theme-default@2.0.0-rc.11(transitive)

• + Addedthemeleon@3.0.2(transitive)

• - Removedacorn@1.2.22.7.0(transitive)

• - Removedacorn-globals@1.0.9(transitive)

• - Removedasap@1.0.0(transitive)

• - Removedasync-each@0.1.6(transitive)

• - Removedcharacter-parser@1.2.1(transitive)

• - Removedchokidar@0.12.6(transitive)

• - Removedclean-css@3.4.28(transitive)

• - Removedcommander@2.6.02.8.1(transitive)

• - Removedconstantinople@3.0.2(transitive)

• - Removedcss@1.0.8(transitive)

• - Removedcss-parse@1.0.4(transitive)

• - Removedcss-stringify@1.0.5(transitive)

• - Removedfs-extra@0.30.0(transitive)

• - Removedfsevents@0.3.8(transitive)

• - Removedgraceful-fs@2.0.3(transitive)

• - Removedgraceful-readlink@1.0.1(transitive)

• - Removedhandlebars@2.0.0(transitive)

• - Removedis-promise@1.0.12.2.2(transitive)

• - Removedjade@1.11.0(transitive)

• - Removedjstransformer@0.0.2(transitive)

• - Removedklaw@1.3.1(transitive)

• - Removedmustache@0.8.2(transitive)

• - Removednan@2.22.0(transitive)

• - Removednunjucks@1.3.4(transitive)

• - Removedoptimist@0.3.7(transitive)

• - Removedpromise@2.0.06.1.0(transitive)

• - Removedreaddirp@1.3.0(transitive)

• - Removedsassdoc-theme-default@2.0.0-rc.10(transitive)

• - Removedsource-map@0.1.430.4.4(transitive)

• - Removedthemeleon@2.0.1(transitive)

• - Removedtransformers@2.1.0(transitive)

• - Removeduglify-js@2.2.52.3.6(transitive)

• - Removedvoid-elements@2.0.1(transitive)

• - Removedwith@4.0.3(transitive)

• Updatedsassdoc-theme-default@2.0.0-rc.11