govuk_tech_docs 6.6.0.rc.0 → 6.6.0.rc.1.local.tested

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6096710e4145ce5e6baa3ee4f23afa9889977e15bcb364dddb884839b16f67c
-  data.tar.gz: 467b585f9e29e743385b150f410d12cddc6a044b5848bc8919721b508df8aabe
+  metadata.gz: 5d8f1a09931a6fc1f3b2d39eea04f96bfcc6699b79d73ce27970ea33f4a7060c
+  data.tar.gz: 0e185cb68044b8dacfebe5b9437593d4b5fd6cc86fcb8d3020ffb7e0dc357e93
 SHA512:
-  metadata.gz: 69bf615c9bdf8720436c955e57e900fd4d7dc08e9218f419000ef54e60ba4b21cc2a64d3c767185aeeb34a06449c8042b7bcadc031df22d55b5ff10f024dbad7
-  data.tar.gz: 28e61bb359c43ede3222630272cb7e3740b24011d4d7dabbf5dc751b654058deb3ac54046b6dc08c5907192e3c3121e038df71b917fcca39575526aa17c57377
+  metadata.gz: 277412b1a77b042c88aed474b93072928d1bae1b7499fd33cf6e51bdd6a4f24b15fbde6909fafb84626e3724a239ae26f526fcae2622756c7237cd95d0c59695
+  data.tar.gz: cd2dbbcead9cdfd78d43518f97c61f2a224d8bcc4ddd3b4b2505320a85b7ee15c88095ed2530836099a55dee65f1af6db5a864ca02ff0b775560e14390294227

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased changes
 
+## 6.6.0.rc.1.local.tested
+
+- Updated gem packaging to include GOV.UK Frontend, Nunjucks and all required production npm dependencies.
+- Excluded development-only npm dependencies from the published gem.
+- Updated JavaScript test and lint tasks to install development dependencies explicitly.
+- Updated the release workflow to read the gem version without evaluating the gemspec.
+
 ## 6.5.2
 
 - Pin GOV.UK front end to `6.4.0` to fix stylesheet issue

data/Rakefile

@@ -6,18 +6,18 @@ RSpec::Core::RakeTask.new(:spec)
 namespace :jasmine do
   desc "Test JavaScript with headless browser"
   task :ci do
-    sh "npm test"
+    sh "npm ci --include=dev && npm test"
   end
   desc "Test JavaScript in browser"
   task :server do
-    sh "npm run test-server"
+    sh "npm ci --include=dev && npm run test-server"
   end
 end
 
 desc "Lint Ruby and JavaScript"
 task :lint do
   sh "rubocop -a spec/test-site documentation lib spec Rakefile"
-  sh "npm run lint --silent"
+  sh "npm ci --include=dev && npm run lint --silent"
 end
 
 task default: ["lint", "spec", "jasmine:ci"]

data/govuk_tech_docs.gemspec

@@ -2,19 +2,58 @@ require "English"
 
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require "govuk_tech_docs/version"
 
-# npm is not necessarily expected in a gemspec, this makes a big assumption about the environment
-# Additionally, for actions such as evaluating the gemspec (e.g. for vulnerability patching) we do not actaully want npm packages
-# We will move these sections into specific rake tasks when we get a chance
-if system("which npm > /dev/null 2>&1")
-  `npm ci`
-  abort "npm ci failed to run" unless $CHILD_STATUS.success?
-  unless File.exist?("node_modules/govuk-frontend/dist/govuk/_base.scss")
-    abort "govuk-frontend and other npm packages not installed"
+npm_available = system(
+  "npm",
+  "--version",
+  out: File::NULL,
+  err: File::NULL
+)
+
+npm_runtime_files = []
+
+if npm_available
+  include_dev_dependencies =
+    ENV["INCLUDE_NPM_DEV_DEPENDENCIES"] == "true"
+
+  npm_install_args = %w[npm ci]
+  npm_install_args << "--omit=dev" unless include_dev_dependencies
+
+  system(*npm_install_args) ||
+    abort("#{npm_install_args.join(' ')} failed")
+
+  required_npm_files = %w[
+    node_modules/govuk-frontend/package.json
+    node_modules/govuk-frontend/dist/govuk/_base.scss
+    node_modules/govuk-frontend/dist/govuk/components/button/macro.njk
+    node_modules/nunjucks/package.json
+  ]
+
+  missing_npm_files = required_npm_files.reject do |file|
+    File.file?(file)
+  end
+
+  unless missing_npm_files.empty?
+    abort(
+      "Required npm files were not installed:\n" \
+        "#{missing_npm_files.join("\n")}"
+    )
+  end
+
+  npm_runtime_files = Dir.glob(
+    "node_modules/**/*",
+    File::FNM_DOTMATCH
+  ).select do |path|
+    File.file?(path) || File.symlink?(path)
   end
 else
-  warn "npm is not available, no assets will be generated.  If you did not expect this please confirm your environment settings."
+  warn(
+    "npm is not available, so npm runtime packages will not be included. " \
+      "This is expected when evaluating the gemspec, but npm must be " \
+      "available when building the distributable gem."
+  )
 end
 
 Gem::Specification.new do |spec|
@@ -23,20 +62,28 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Government Digital Service"]
   spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
 
-  spec.summary       = "Gem to distribute the GOV.UK Tech Docs Template"
-  spec.description   = "Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem for the project."
-  spec.homepage      = "https://github.com/alphagov/tech-docs-gem"
-  spec.license       = "MIT"
+  spec.summary = "Gem to distribute the GOV.UK Tech Docs Template"
+  spec.description = <<~DESCRIPTION.strip
+    Gem to distribute the GOV.UK Tech Docs Template.
+    See https://github.com/alphagov/tech-docs-gem for the project.
+  DESCRIPTION
 
-  files_in_git = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.homepage = "https://github.com/alphagov/tech-docs-gem"
+  spec.license  = "MIT"
 
-  # Include assets from GOV.UK Frontend library in the distributed gem
-  govuk_frontend_assets = Dir["node_modules/govuk-frontend/**/*.{scss,js,mjs,woff,woff2,png,svg,ico}", "node_modules/govuk-frontend/dist/govuk/assets/**/*.json"]
+  files_in_git = `git ls-files -z`
+                   .split("\x0")
+                   .reject do |file|
+    file.match?(%r{\A(?:test|spec|features|\.github|documentation)/})
+  end
+
+  spec.files = (files_in_git + npm_runtime_files).uniq.sort
 
-  spec.files         = files_in_git + govuk_frontend_assets
+  spec.bindir = "exe"
+  spec.executables = spec.files
+                         .grep(%r{\Aexe/})
+                         .map { |file| File.basename(file) }
 
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
   spec.required_ruby_version = ">= 3.3.0"
@@ -44,17 +91,28 @@ Gem::Specification.new do |spec|
   spec.add_dependency "autoprefixer-rails"
   spec.add_dependency "chronic"
   spec.add_dependency "concurrent-ruby"
-  spec.add_dependency "csv" # TODO: remove once tilt declares this itself.
-  spec.add_dependency "haml", ">= 6", "< 8" # middleman-core (4.6.3) depends on haml (>= 4.0.5, < 7)
+
+  # TODO: remove once tilt declares this itself.
+  spec.add_dependency "csv"
+
+  # middleman-core 4.6.3 depends on haml >= 4.0.5 and < 7.
+  spec.add_dependency "haml", ">= 6", "< 8"
+
   spec.add_dependency "middleman"
   spec.add_dependency "middleman-autoprefixer"
   spec.add_dependency "middleman-compass"
   spec.add_dependency "middleman-livereload"
   spec.add_dependency "middleman-search-gds"
-  # middleman-sprockets is very old and out of date.  V4.1.0 has a breaking change.  Will look to replace with gem "dartsass-sprockets" or uses sass in the package.json
+
+  # middleman-sprockets is very old and out of date.
+  # Version 4.1.0 contains a breaking change.
   spec.add_dependency "middleman-sprockets", "4.0.0"
+
   spec.add_dependency "middleman-syntax"
-  spec.add_dependency "mutex_m" # TODO: remove once activesupport declares this itself.
+
+  # TODO: remove once Active Support declares this itself.
+  spec.add_dependency "mutex_m"
+
   spec.add_dependency "nokogiri"
   spec.add_dependency "openapi3_parser"
   spec.add_dependency "redcarpet"
@@ -69,4 +127,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop-govuk"
-end
+end

data/lib/govuk_tech_docs/govuk_nunjuck_componenet_renderer.rb

@@ -36,6 +36,8 @@ module GovukTechDocs
       render_nunjucks_template(nunjucks_template_string, { "template_data" => template_data }, search_paths)
     # rubocop:disable Lint/UselessAssignment
     rescue StandardError => e
+      puts e.message
+      puts e.backtrace.join("\n")
       raise "Could not load GOV.UK component #{component_name} with data #{template_data}.  Called with  #{nunjucks_template_string}"
     end
     # rubocop:enable Lint/UselessAssignment

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.6.0.rc.0".freeze
+  VERSION = "6.6.0.rc.1.local.tested".freeze
 end

data/lib/tasks/lint.rake

@@ -23,18 +23,16 @@ namespace :lint do
 
       # IO.popen runs the command and exposes the Process ID (PID)
       IO.popen(["vale", "--config=#{vale_config_path}", "--output=JSON", file]) do |io|
-        begin
-          # If a file takes longer than 10 seconds, raise a timeout
-          Timeout.timeout(10) do
-            file_output = io.read
-          end
-          # If we reach here, it finished safely
-          puts "\e[32mDone\e[0m"
-        rescue Timeout::Error
-          # The regex hung. Send a SIGKILL to the Vale process to stop it chewing CPU
-          Process.kill("KILL", io.pid)
-          puts "\e[31mHUNG (Skipped due to timeout)\e[0m" # Red text
+        # If a file takes longer than 10 seconds, raise a timeout
+        Timeout.timeout(10) do
+          file_output = io.read
         end
+        # If we reach here, it finished safely
+        puts "\e[32mDone\e[0m"
+      rescue Timeout::Error
+        # The regex hung. Send a SIGKILL to the Vale process to stop it chewing CPU
+        Process.kill("KILL", io.pid)
+        puts "\e[31mHUNG (Skipped due to timeout)\e[0m" # Red text
       end
 
       # Merge JSON only if we got a valid response (ignores timeouts)
@@ -57,22 +55,22 @@ namespace :lint do
   end
 
   desc "Debug Vale to find which rule hangs on a specific file."
-  require 'timeout'
+  require "timeout"
 
   desc "Debug specific Vale rules for regex hangs"
   task :debug, [:rules] do |_, args|
     # Accepts Rake args (rake "debug[Rule1,Rule2]") or ENV vars (rake debug RULES=Rule1,Rule2)
-    raw_input = args[:rules] || ENV['RULES']
+    raw_input = args[:rules] || ENV["RULES"]
 
     if raw_input.nil? || raw_input.strip.empty?
       abort "Please provide rules to test. \nUsage: rake \"debug[Rule1,Rule2]\" OR rake debug RULES=Rule1,Rule2"
     end
 
     # Split by comma, remove whitespace, and drop any empty strings
-    rules = raw_input.split(',').map(&:strip).reject(&:empty?)
+    rules = raw_input.split(",").map(&:strip).reject(&:empty?)
 
-    style_prefix = 'style-guide'
-    target_file = './build/search/index.html'
+    style_prefix = "style-guide"
+    target_file = "./build/search/index.html"
 
     puts "Hunting for the hanging regex in #{target_file}..."
     puts "Testing #{rules.size} rule(s): #{rules.join(', ')}\n\n"
@@ -84,24 +82,20 @@ namespace :lint do
 
       # Run Vale for just this single rule
       IO.popen(["vale", "--filter=#{filter_string}", "--output=line", target_file]) do |io|
-        begin
-          # If the regex loops catastrophically, it hits this 5-second limit
-          Timeout.timeout(5) do
-            io.read
-          end
-
-          # If it finishes within 5 seconds, the rule is safe
-          puts "\e[32mPassed (No hang)\e[0m"
-
-        rescue Timeout::Error
-          # The regex froze! Kill the underlying process to save CPU and flag it
-          Process.kill("KILL", io.pid)
-          puts "\e[31m💥 HUNG! (This is the broken regex)\e[0m"
+        # If the regex loops catastrophically, it hits this 5-second limit
+        Timeout.timeout(5) do
+          io.read
         end
+
+        # If it finishes within 5 seconds, the rule is safe
+        puts "\e[32mPassed (No hang)\e[0m"
+      rescue Timeout::Error
+        # The regex froze! Kill the underlying process to save CPU and flag it
+        Process.kill("KILL", io.pid)
+        puts "\e[31m💥 HUNG! (This is the broken regex)\e[0m"
       end
     end
 
     exit 0
   end
-
 end

data/node_modules/.bin/nunjucks-precompile

@@ -0,0 +1 @@
+../nunjucks/bin/precompile

data/node_modules/.package-lock.json

@@ -0,0 +1,62 @@
+{
+  "name": "tech-docs-gem",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "node_modules/a-sync-waterfall": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/a-sync-waterfall/-/a-sync-waterfall-1.0.1.tgz",
+      "integrity": "sha512-RYTOHHdWipFUliRFMCS4X2Yn2X8M87V/OpSqWzKKOGhzqyUxzyVmhHDH9sAvG+ZuQf/TAOFsLCpMw09I1ufUnA==",
+      "license": "MIT"
+    },
+    "node_modules/asap": {
+      "version": "2.0.6",
+      "resolved": "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz",
+      "integrity": "sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==",
+      "license": "MIT"
+    },
+    "node_modules/commander": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz",
+      "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 6"
+      }
+    },
+    "node_modules/govuk-frontend": {
+      "version": "6.6.0",
+      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-6.6.0.tgz",
+      "integrity": "sha512-xctkWrQvLnvQt7fyjQ3MGX9S0wz0x0RQuLxCeoXF+s8EjGICG81/DYQGKN5qgO+0KVT12UAaRwUsGY6fulRcRg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 4.2.0"
+      }
+    },
+    "node_modules/nunjucks": {
+      "version": "3.2.4",
+      "resolved": "https://registry.npmjs.org/nunjucks/-/nunjucks-3.2.4.tgz",
+      "integrity": "sha512-26XRV6BhkgK0VOxfbU5cQI+ICFUtMLixv1noZn1tGU38kQH5A5nmmbk/O45xdyBhD1esk47nKrY0mvQpZIhRjQ==",
+      "license": "BSD-2-Clause",
+      "dependencies": {
+        "a-sync-waterfall": "^1.0.0",
+        "asap": "^2.0.3",
+        "commander": "^5.1.0"
+      },
+      "bin": {
+        "nunjucks-precompile": "bin/precompile"
+      },
+      "engines": {
+        "node": ">= 6.9.0"
+      },
+      "peerDependencies": {
+        "chokidar": "^3.3.0"
+      },
+      "peerDependenciesMeta": {
+        "chokidar": {
+          "optional": true
+        }
+      }
+    }
+  }
+}

data/{documentation → node_modules/a-sync-waterfall}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2018 Crown Copyright (Government Digital Service)
+Copyright (c) 2013 Elan Shanker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
+of this software and associated documentation files (the “Software”), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/node_modules/a-sync-waterfall/README.md

@@ -0,0 +1,95 @@
+# a-sync-waterfall
+
+Simple, isolated sync/async waterfall module for JavaScript.
+
+Runs an array of functions in series, each passing their results to the next in
+the array. However, if any of the functions pass an error to the callback, the
+next function is not executed and the main callback is immediately called with
+the error.
+
+For browsers and node.js.
+
+## Installation
+* Just include a-sync-waterfall before your scripts.
+* `npm install a-sync-waterfall` if you’re using node.js.
+
+
+## Usage
+
+* `waterfall(tasks, optionalCallback, forceAsync);`
+* **tasks** - An array of functions to run, each function is passed a
+`callback(err, result1, result2, ...)` it must call on completion. The first
+argument is an error (which can be null) and any further arguments will be
+passed as arguments in order to the next task.
+* **optionalCallback** - An optional callback to run once all the functions have
+completed. This will be passed the results of the last task's callback.
+* **forceAsync** An optional flag that force tasks run asynchronously even if they are sync.
+
+##### Node.js:
+
+```javascript
+var waterfall = require('a-sync-waterfall');
+waterfall(tasks, callback);
+```
+
+##### Browser:
+
+```javascript
+var waterfall = require('a-sync-waterfall');
+waterfall(tasks, callback);
+
+// Default:
+window.waterfall(tasks, callback);
+```
+
+##### Tasks as Array of Functions
+
+```javascript
+waterfall([
+  function(callback){
+    callback(null, 'one', 'two');
+  },
+  function(arg1, arg2, callback){
+    callback(null, 'three');
+  },
+  function(arg1, callback){
+    // arg1 now equals 'three'
+    callback(null, 'done');
+  }
+], function (err, result) {
+  // result now equals 'done'
+});
+```
+
+##### Derive Tasks from an Array.map
+
+```javascript
+/* basic - no arguments */
+waterfall(myArray.map(function (arrayItem) {
+  return function (nextCallback) {
+    // same execution for each item, call the next one when done
+    doAsyncThingsWith(arrayItem, nextCallback);
+}}));
+
+/* with arguments, initializer function, and final callback */
+waterfall([function initializer (firstMapFunction) {
+    firstMapFunction(null, initialValue);
+  }].concat(myArray.map(function (arrayItem) {
+    return function (lastItemResult, nextCallback) {
+      // same execution for each item in the array
+      var itemResult = doThingsWith(arrayItem, lastItemResult);
+      // results carried along from each to the next
+      nextCallback(null, itemResult);
+}})), function (err, finalResult) {
+  // final callback
+});
+```
+
+## Acknowledgements
+Hat tip to [Caolan McMahon](https://github.com/caolan) and
+[Paul Miller](https://github.com/paulmillr), whose prior contributions this is
+based upon.
+Also [Elan Shanker](https://github.com/es128) from which this rep is forked
+
+## License
+[MIT](https://raw.github.com/hydiak/a-sync-waterfall/master/LICENSE)

data/node_modules/a-sync-waterfall/index.js

@@ -0,0 +1,83 @@
+// MIT license (by Elan Shanker).
+(function(globals) {
+  'use strict';
+
+  var executeSync = function(){
+    var args = Array.prototype.slice.call(arguments);
+    if (typeof args[0] === 'function'){
+      args[0].apply(null, args.splice(1));
+    }
+  };
+
+  var executeAsync = function(fn){
+    if (typeof setImmediate === 'function') {
+      setImmediate(fn);
+    } else if (typeof process !== 'undefined' && process.nextTick) {
+      process.nextTick(fn);
+    } else {
+      setTimeout(fn, 0);
+    }
+  };
+
+  var makeIterator = function (tasks) {
+    var makeCallback = function (index) {
+      var fn = function () {
+        if (tasks.length) {
+          tasks[index].apply(null, arguments);
+        }
+        return fn.next();
+      };
+      fn.next = function () {
+        return (index < tasks.length - 1) ? makeCallback(index + 1): null;
+      };
+      return fn;
+    };
+    return makeCallback(0);
+  };
+  
+  var _isArray = Array.isArray || function(maybeArray){
+    return Object.prototype.toString.call(maybeArray) === '[object Array]';
+  };
+
+  var waterfall = function (tasks, callback, forceAsync) {
+    var nextTick = forceAsync ? executeAsync : executeSync;
+    callback = callback || function () {};
+    if (!_isArray(tasks)) {
+      var err = new Error('First argument to waterfall must be an array of functions');
+      return callback(err);
+    }
+    if (!tasks.length) {
+      return callback();
+    }
+    var wrapIterator = function (iterator) {
+      return function (err) {
+        if (err) {
+          callback.apply(null, arguments);
+          callback = function () {};
+        } else {
+          var args = Array.prototype.slice.call(arguments, 1);
+          var next = iterator.next();
+          if (next) {
+            args.push(wrapIterator(next));
+          } else {
+            args.push(callback);
+          }
+          nextTick(function () {
+            iterator.apply(null, args);
+          });
+        }
+      };
+    };
+    wrapIterator(makeIterator(tasks))();
+  };
+
+  if (typeof define !== 'undefined' && define.amd) {
+    define([], function () {
+      return waterfall;
+    }); // RequireJS
+  } else if (typeof module !== 'undefined' && module.exports) {
+    module.exports = waterfall; // CommonJS
+  } else {
+    globals.waterfall = waterfall; // <script>
+  }
+})(this);

data/node_modules/a-sync-waterfall/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "a-sync-waterfall",
+  "version": "1.0.1",
+  "description": "Runs a list of async tasks, passing the results of each into the next one",
+  "author": {
+    "name": "Gleb Khudyakov",
+    "url": "https://github.com/hydiak/a-sync-waterfall"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/hydiak/a-sync-waterfall",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:hydiak/a-sync-waterfall.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hydiak/a-sync-waterfall/issues"
+  },
+  "main": "./index",
+  "keywords": ["async", "sync", "waterfall", "tasks", "control", "flow"],
+  "dependencies": {}
+}

data/node_modules/a-sync-waterfall/test.js

@@ -0,0 +1,77 @@
+"use strict";
+const waterfall = require('./index');
+
+var generateSyncTask = function(index) {
+	return function (x){
+		return function(cb){
+			console.log(x);
+			cb(null);
+		};
+	}(index);
+};
+
+
+var generateAsyncTask = function(index) {
+	return function (x){
+		return function(cb){
+			setTimeout(function(){
+				console.log(x);
+				cb(null);
+			}, 0);
+		};
+	}(index);
+};
+
+var generateSyncTasks = function(count){
+	var tasks = [];
+	for(var i=0; i<count; i++) {
+		tasks.push(generateSyncTask(i));
+	}
+	return tasks;
+}
+
+var generateAsyncTasks = function(count){
+	var tasks = [];
+	for(var i=0; i<count; i++) {
+		tasks.push(generateAsyncTask(i));
+	}
+	return tasks;
+}
+
+
+var generateRandomTasks = function(count){
+	var tasks = [];
+	for(var i=0; i<count; i++) {
+		Math.random() > .5 ? tasks.push(generateAsyncTask(i)) : tasks.push(generateSyncTask(i))
+	}
+	return tasks;
+}
+
+var done = function(){
+	console.log('done');
+}
+
+var testSync = function(){
+	waterfall(generateSyncTasks(10), done);
+	console.log('this text should be after waterfall');
+
+};
+
+var testAsync = function(){
+	waterfall(generateAsyncTasks(5), done);
+	console.log('this text should be before waterfall');
+};
+
+var testMixed = function(){
+	waterfall(generateRandomTasks(20), done);
+};
+
+
+console.log('testSync:');
+testSync();
+
+// console.log('\ntestAsync: ');
+// testAsync();
+
+console.log('\ntestMixed: ');
+testMixed();