fix(build): package, travis, and testing updates (#22)

* build packages
* build, travis staged, lint, testing
* testing, expand setupDocs

.gitignore

@@ -20,3 +20,4 @@ api-debug*
 # misc
 .env
 .docs
+.fixtures

.travis.yml

@@ -1,13 +1,10 @@
 language: node_js
-
+node_js:
+  - "10"
 cache: yarn
-
 jobs:
   include:
-  - stage: test
-    env:
-    - NAME=yarn
-    node_js: "10"
-    before_script: yarn global add codecov
-    script: yarn test
-    after_success: codecov
+    - stage: Test
+      before_script: yarn global add codecov
+      script: yarn test
+      after_success: codecov

package.json

@@ -24,9 +24,11 @@
     "release": "standard-version",
     "start": "./bin/cli.js -w ./data",
     "start:dev": "nodemon --watch data --watch src './bin/cli.js -w ./data'",
-    "test": "CI=true; eslint ./src; jest --collectCoverage",
+    "test": "run-s -l test:lint test:ci",
+    "test:ci": "export CI=true; jest --collectCoverage",
+    "test:clearCache": "jest --clearCache",
     "test:dev": "eslint ./src; jest --watch",
-    "test:clearCache": "jest --clearCache"
+    "test:lint": "eslint ./src"
   },
   "jest": {
     "roots": [
@@ -53,25 +55,26 @@
   },
   "dependencies": {
     "apidoc": "^0.17.7",
-    "express": "^4.16.4",
-    "node-watch": "^0.6.1",
+    "express": "^4.17.1",
+    "node-watch": "^0.6.2",
     "winston": "^3.2.1",
-    "yargs": "^13.2.2"
+    "yargs": "^13.3.0"
   },
   "devDependencies": {
-    "babel-eslint": "^10.0.1",
-    "eslint": "^5.16.0",
+    "babel-eslint": "^10.0.2",
+    "eslint": "^6.1.0",
     "eslint-config-esnext": "^4.0.0",
     "eslint-config-node": "^4.0.0",
-    "eslint-config-prettier": "^4.1.0",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-plugin-babel": "^5.3.0",
-    "eslint-plugin-import": "^2.17.1",
-    "eslint-plugin-jest": "^22.4.1",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-prettier": "^3.0.1",
-    "jest": "^24.7.1",
-    "nodemon": "^1.18.11",
-    "prettier": "^1.17.0",
-    "standard-version": "^5.0.2"
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^22.14.1",
+    "eslint-plugin-node": "^9.1.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "jest": "^24.8.0",
+    "nodemon": "^1.19.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^1.18.2",
+    "standard-version": "^6.0.1"
   }
 }

src/__tests__/__snapshots__/index.test.js.snap

@@ -1,3 +1,12 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`ApiDocMock should create a predictable docs output: setupDocs 1`] = `
+Object {
+  "error": "{\\"examples\\":[{\\"title\\":\\"Error-Response:\\",\\"content\\":\\"HTTP/1.1 400 OK\\\\n{\\\\n  error: test\\\\n}\\",\\"type\\":\\"json\\"}]}",
+  "success": "{\\"examples\\":[{\\"title\\":\\"Success-Response:\\",\\"content\\":\\"HTTP/1.1 200 OK\\\\n{\\\\n  success: test\\\\n}\\",\\"type\\":\\"json\\"}]}",
+  "type": "get",
+  "url": "/hello/world/",
+}
+`;
+
 exports[`ApiDocMock should throw an error during testing: error 1`] = `[Error: Server failed to load]`;

src/__tests__/index.test.js

@@ -1,17 +1,48 @@
+const { execSync } = require('child_process');
 const { apiDocMock, setupDocs, setupResponse } = require('../');
 
 describe('ApiDocMock', () => {
+  const tempFile = contents => {
+    const dir = './.fixtures';
+    const stdout = execSync(`mkdir -p ${dir}; echo "${contents}" > ${dir}/test.js`);
+    return { dir, stdout };
+  };
+
   it('should have specific defined properties', () => {
     expect(apiDocMock).toBeDefined();
     expect(setupDocs).toBeDefined();
     expect(setupResponse).toBeDefined();
   });
 
-  it('should have support functions that fail gracefully for tests', () => {
-    expect(setupDocs()).toBe(null);
+  it('should have support functions that fail gracefully', () => {
     expect(setupResponse()).toBe(null);
   });
 
+  it('should create a predictable docs output', () => {
+    const { dir } = tempFile(`/**
+     * @api {get} /hello/world/
+     * @apiSuccessExample {json} Success-Response:
+     *     HTTP/1.1 200 OK
+     *     {
+     *       "success": "test"
+     *     }
+     * @apiErrorExample {json} Error-Response:
+     *     HTTP/1.1 400 OK
+     *     {
+     *       "error": "test"
+     *     }
+     */`);
+
+    const [helloWorld] = setupDocs(dir, './.docs');
+
+    expect({
+      type: helloWorld.type,
+      url: helloWorld.url,
+      success: JSON.stringify(helloWorld.success),
+      error: JSON.stringify(helloWorld.error)
+    }).toMatchSnapshot('setupDocs');
+  });
+
   it('should throw an error during testing', () => {
     try {
       apiDocMock({});

src/index.js

@@ -30,7 +30,8 @@ const setupDocs = (dataPath = '', docsPath = '') => {
     dest,
     parsers: {
       apimock: path.join(__dirname, './docs/configDocs.js')
-    }
+    },
+    silent: process.env.NODE_ENV === 'test'
   };
 
   const apiJsonFile = path.join(cwd, docsPath, 'api_data.json');