BOOM

.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 4

.eslintrc.yml

@@ -0,0 +1,41 @@
+env:
+  browser: false
+  commonjs: true
+  es6: true
+  node: true
+extends: 'eslint:recommended'
+
+parserOptions:
+  ecmaVersion: "6"
+  sourceType: "module"
+
+rules:
+  indent:
+    - error
+    - 2
+    - SwitchCase: 1
+  linebreak-style:
+    - error
+    - unix
+  quotes:
+    - error
+    - single
+  semi:
+    - error
+    - always
+  no-console:
+    - 0
+
+globals:
+  # Testing
+  suite: true
+  test: true
+  describe: true
+  it: true
+  setup: true
+  before: true
+  beforeEach: true
+  after: true
+  afterEach: true
+  teardown: true
+  assert: true

.gitignore

@@ -0,0 +1,5 @@
+/node_modules/
+npm-debug.log
+dump.rdb
+wiki
+temp

.nvmrc

@@ -0,0 +1 @@
+6.9

Gruntfile.js

@@ -0,0 +1,28 @@
+/*jshint camelcase:false */
+
+module.exports = function (grunt) {
+  // Load all grunt tasks
+  grunt.task.loadNpmTasks('grunt-release');
+
+  // Project configuration.
+  grunt.initConfig({
+    release: {
+      options: {
+        bump: true, //default: true
+        file: 'package.json', //default: package.json
+        add: true, //default: true
+        commit: true, //default: true
+        tag: true, //default: true
+        push: true, //default: true
+        pushTags: true, //default: true
+        npm: true, //default: true
+        tagName: 'v<%= version %>', //default: '<%= version %>'
+        commitMessage: 'releasing v<%= version %>', //default: 'release <%= version %>'
+        tagMessage: 'v<%= version %>' //default: 'Version <%= version %>'
+      }
+    },
+  });
+
+  // Default task.
+  grunt.registerTask('default', []);
+};

LICENSE

@@ -0,0 +1 @@
+Copyright © Waldo, Inc. All rights reserved.

README.md

@@ -0,0 +1,31 @@
+# Awesome Lib name
+
+> The awesome lib description
+
+## Install
+
+Install the module using NPM:
+
+```
+npm install @waldo/awesome-lib --save
+```
+
+## Documentation
+
+
+## Releasing
+
+1. Update the changelog bellow.
+1. Ensure you are on master.
+1. Type: `grunt release`
+    * `grunt release:minor` for minor number jump.
+    * `grunt release:major` for major number jump.
+
+## Release History
+
+- **v0.0.1**, *TBD*
+    - Big Bang
+
+## License
+
+Copyright Waldo, Inc. All rights reserved.

circle.yml

@@ -0,0 +1,3 @@
+machine:
+  node:
+    version: 6.9.1

lib/index.js

@@ -0,0 +1,16 @@
+/*
+ * Awesome Lib
+ * An awesome description
+ * https://github.com/waldo/waldo-node-awesome-lib
+ *
+ * Copyright © Waldo, Inc.
+ * All rights reserved.
+ */
+
+/**
+ * @fileOverview bootstrap and master exporing module.
+ */
+
+const awesomeLib = module.exports = {};
+
+awesomeLib.method = function() {};

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@waldo/awesome-lib",
+  "version": "0.0.0",
+  "main": "./lib/boot",
+  "description": "Awesome lib description",
+  "homepage": "https://github.com/waldo/waldo-node-awesome-lib",
+  "bugs": "https://github.com/waldo/waldo-node-awesome-lib/issues",
+  "author": {
+    "name": "Awesome author",
+    "email": "[email protected]"
+  },
+  "contributors": [
+    ""
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/waldo/waldo-node-awesome-lib"
+  },
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=6.x"
+  },
+  "scripts": {
+    "test": "mocha -b test/spec && eslint lib/**"
+  },
+  "dependencies": {
+    "bluebird": "^3.4.6"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "eslint": "^3.12.2",
+    "grunt": "^1.0.1",
+    "grunt-release": "^0.14.0",
+    "mocha": "^3.2.0",
+    "sinon": "^1.17.6"
+  }
+}

test/lib/tester.lib.js

@@ -0,0 +1,29 @@
+/*
+ * @fileOverview Main testing helper lib.
+ */
+
+var tester = module.exports = {};
+
+/** @type {Object} simple logger */
+tester.log = {
+  info: function() {
+    let args = Array.prototype.splice.call(arguments, 0);
+    console.log('INFO:', args.join(' '));
+  },
+  error: function() {
+    let args = Array.prototype.splice.call(arguments, 0);
+    console.log('ERROR:', args.join(' '));
+  },
+};
+
+/**
+ * Have a Cooldown period between tests.
+ *
+ * @param {number} seconds cooldown in seconds.
+ * @return {Function} use is beforeEach().
+ */
+tester.cooldown = function(seconds) {
+  return function(done) {
+    setTimeout(done, seconds);
+  };
+};

test/mocha.opts

@@ -0,0 +1,3 @@
+--timeout 60000
+-u bdd
+-R spec

test/spec/base.test.js

@@ -0,0 +1,16 @@
+/**
+ * @fileOverview Base API Surface tests.
+ */
+const chai = require('chai');
+const expect = chai.expect;
+
+const awesomeLib = require('../..');
+
+describe('Base API Surface', function() {
+  it('should expose expected methods', function(){
+    expect(awesomeLib).to.have.keys([
+      'awesome',
+      'method',
+    ]);
+  });
+});