Merge fd3719a into 32d739d

.travis.yml

@@ -1,10 +1,13 @@
 language: node_js
 cache: yarn
 node_js:
+  - "6"
+  - "7"
   - "8"
   - "9"
   - "10"
 install:
+    - yarn install --ignore-engines
     - yarn add --dev codecov snyk coveralls
 script:
   - yarn cover

package.json

@@ -15,25 +15,30 @@
     "files": [
         "*"
     ],
+    "engines": {
+        "node": ">=6.0.0 <7.0.0 || >=8.0.0"
+    },
     "repository": "github:zakkudo/translation-static-analyzer",
     "license": "BSD-3-Clause",
     "devDependencies": {
         "@babel/cli": "^7.0.0-beta.56",
         "@babel/core": "^7.0.0-beta.56",
+        "@babel/plugin-transform-runtime": "^7.0.0",
         "@babel/preset-env": "^7.0.0-beta.56",
         "babel-core": "^7.0.0-0",
         "babel-jest": "^23.4.2",
+        "babel-plugin-transform-undefined-to-void": "^6.9.4",
         "eslint": "^4.19.1",
         "eslint-plugin-jasmine": "^2.10.1",
         "eslint-plugin-jest": "^21.21.0",
         "eslint-plugin-node": "^7.0.1",
         "jest": "^23.4.2",
         "jest-cli": "^23.4.2",
         "jsdoc": "^3.5.5",
-        "jsdoc-to-markdown": "^4.0.1",
-        "regenerator-runtime": "^0.12.1"
+        "jsdoc-to-markdown": "^4.0.1"
     },
     "dependencies": {
+        "@babel/runtime-corejs2": "^7.0.0",
         "deep-equal": "^1.0.1",
         "fs-extra": "^7.0.0",
         "glob": "^7.1.2",
@@ -49,8 +54,5 @@
         "lint": "scripts/lint.sh",
         "deploy": "scripts/deploy.sh",
         "test": "scripts/test.sh"
-    },
-    "engines": {
-        "node": ">=8.0.0"
     }
 }

scripts/build.sh

@@ -2,4 +2,25 @@
 
 set -e
 
-./node_modules/.bin/babel src --out-dir build --source-maps inline --ignore "src/*.test.js" --ignore "src/test.js"
+export NODE_ENV="build"
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./scripts/document.sh
+
+mkdir build
+
+cp package.json build/package.json
+cp README.md build/README.md
+
+./node_modules/.bin/babel src \
+    --out-dir build \
+    --source-maps inline \
+    --ignore "src/test.js" \
+    --ignore "src/*.test.js" \
+    --verbose \
+    "$@"

scripts/clean.sh

@@ -2,15 +2,13 @@
 
 set -e
 
+CURRENT_DIR=$(pwd)
 PROJECT_DIR=$(git rev-parse --show-toplevel)
-BIN_DIR=$(npm bin)
-JSDOC="$BIN_DIR/jsdoc"
 
-rm -rf $PROJECT_DIR/build
-rm -rf $PROJECT_DIR/coverage
-rm -rf $PROJECT_DIR/documentation
-rm -rf $PROJECT_DIR/demo
-rm -f $PROJECT_DIR/.karma-test-results.json
-rm -f $PROJECT_DIR/.jest-test-results.json
-rm -f $PROJECT_DIR/jsdoc.*.conf.tmp
-rm -f $PROJECT_DIR/yarn-error.log
+cd $PROJECT_DIR
+
+rm -rf build
+rm -rf coverage
+rm -rf documentation
+rm -f jsdoc.*.conf.tmp
+rm -f yarn-error.log

scripts/cover.sh

@@ -1,3 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 
-./node_modules/.bin/jest --coverage --config jest.config.js
+set -e
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./scripts/test.sh --coverage --coveragePathIgnorePatterns '.*TestHelper.js' "$@"

scripts/deploy.sh

@@ -2,11 +2,17 @@
 
 set -e
 
-yarn build
-yarn document
-yarn cover
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
 
-cp README.md build/README.md
-cp package.json build/package.json
+cd $PROJECT_DIR
+
+./scripts/cover.sh
+./scripts/document.sh
+./scripts/build.sh
+
+yarn version
+
+./scripts/build.sh
 
 yarn publish --access public --cwd build --no-git-tag-version

scripts/document.sh

@@ -2,10 +2,23 @@
 
 set -e
 
+export NODE_ENV="document"
+
+CURRENT_DIR=$(pwd)
 PROJECT_DIR=$(git rev-parse --show-toplevel)
 BIN_DIR=$(npm bin)
 JSDOC="$BIN_DIR/jsdoc"
+OPTIONS="--module-index-format none --global-index-format none --example-lang js --heading-depth 3"
+
+cd $PROJECT_DIR
+
+$JSDOC -c jsdoc.config.json "$@"
+cat src/README.md > README.md
+
+echo "" >> README.md
+echo "## API" >> README.md
+echo "" >> README.md
+
+./node_modules/.bin/jsdoc2md src/index.js $OPTIONS >> README.md
 
-$JSDOC -c $PROJECT_DIR/jsdoc.config.json "$@"
-./node_modules/.bin/jsdoc2md src/*.js > README.md
-sed -i '' 's/\\\//\//g' README.md
+./scripts/postProcessReadme.js README.md

scripts/lint.sh

@@ -1,3 +1,12 @@
-#!/bin/sh
+#!/bin/bash
 
-./node_modules/.bin/eslint src
+set -e
+
+export NODE_ENV="lint"
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./node_modules/.bin/eslint src "$@"

scripts/postProcessReadme.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+
+const arguments = process.argv.slice(2);;
+const filename = arguments[0];
+const contents = String(fs.readFileSync(filename));
+const lines = contents.split('\n');
+
+let isIndex = false;
+let isApiSection = false;
+
+const newContents = lines.filter((l) => {
+    if (l.startsWith('* [@')) {
+        isIndex = true;
+    } else if (l === '') {
+        isIndex = false;
+    }
+
+    return !isIndex;
+}).filter((l) => {
+     return !l.startsWith('### @');
+}).map((l, index, lines) => {
+    const innerClassOfPrefix = '**Kind**: inner class of';
+    const innerMethodOfPrefix = '**Kind**: inner method of';
+
+    if (l.startsWith('#### @')) {
+        return l + ' ⏏';
+    }
+
+    if (l.startsWith(innerClassOfPrefix)) {
+        return '\n**Kind**: Exported class\n';
+    }
+
+    if (l.startsWith(innerMethodOfPrefix)) {
+        return '\n**Kind**: Exported function\n';
+    }
+
+    return l;
+}).map((l, index, lines) => {
+    if (l === '## API') {
+        isApiSection = true;
+        return l;
+    }
+
+    if (isApiSection && l.startsWith('##')) {
+        return l.slice(1);
+    }
+
+    return l;
+}).join('\n').replace(/\n\n+/gm, '\n\n').replace('@', '@').replace('/', '/');
+
+fs.writeFileSync(filename, newContents);
+

scripts/test.sh

@@ -1,3 +1,13 @@
-#!/bin/sh
+#!/bin/bash
 
-./node_modules/.bin/jest --runInBand
+set -e
+
+export NODE_ENV="test"
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./node_modules/.bin/jest --runInBand "$@"

src/.babelrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+    "presets": [
+        [
+            "@babel/env", {
+                "debug": process.env.NODE_ENV === 'build',
+                "targets": {"browsers": [
+                    "last 1 version",
+                    "> 1%",
+                    "not dead"
+                ], "node": "6"}
+            }
+        ]
+    ],
+    "plugins": [
+        ["@babel/transform-runtime", {"corejs": 2}],
+        "transform-undefined-to-void"
+    ],
+    minified: true,
+    comments: false
+}