feat(docs): Add generate_docs script to generate typedoc documentation

Author: christopherthielen

generate_docs.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const publishYalcPackage = require('./publish_yalc_package');
+const util = require('./util');
+util.packageDir();
+
+const fs = require('fs');
+const path = require('path');
+const _exec = util._exec;
+
+const pkg = JSON.parse(fs.readFileSync('./package.json'));
+const CONFIG = JSON.parse(fs.readFileSync('./typedoc.json'));
+
+const has =  require('lodash').has;
+
+const requiredKeys = ['typedoc', 'typedoc.generateOptions', 'files'];
+const missing = requiredKeys.find(key => !has(CONFIG, key));
+if (missing) {
+  console.error(`typedoc.json does not contain configuration key: "${missing}"`);
+  process.exit(1);
+}
+
+const includes = CONFIG.typedoc.include || [];
+includes.forEach(include => {
+  const { package, repo } = include;
+  const flags = { noBuild: true, noPublish: true, noInstall: true };
+  const versionline = _exec(`yarn list --pattern ${package}`).stdout.split(/[\r\n]+/).find(line => line.includes(package));
+  const version = /.*\@([^@]*)/.exec(versionline)[1];
+
+  if (version) {
+    flags.branch = version;
+  }
+
+  publishYalcPackage(path.join('.downstream_cache', package), repo, flags);
+});
+
+const typedocOptions = CONFIG.typedoc.generateOptions || {};
+const cmdLineOpts = Object.keys(typedocOptions)
+    .map(key => `--${key} ${typedocOptions[key]}`)
+    .join(" ");
+
+const files = CONFIG.files.concat(includes.map(x => path.join('.downstream_cache', x.package, x.entry))).join(" ");
+
+util.packageDir();
+_exec(`./node_modules/.bin/typedoc ${cmdLineOpts} ${files}`);
+

package.json

@@ -19,18 +19,21 @@
   "bin": {
     "artifact_tagging": "./artifact_tagging.js",
     "ensure_clean_master": "./ensure_clean_master.js",
+    "generate_docs": "./generate_docs.js",
     "modify_sourcemap_paths": "./modify_sourcemap_paths.js",
+    "publish_docs": "./publish_docs.js",
+    "publish_yalc_package": "./publish_yalc_package.js",
     "release": "./release.js",
     "show_changelog": "./show_changelog.js",
     "test_downstream_projects": "./test_downstream_projects.js",
-    "publish_yalc_package": "./publish_yalc_package.js",
     "util": "./util.js"
   },
   "dependencies": {
     "conventional-changelog": "^1.1.4",
     "conventional-changelog-ui-router-core": "^1.4.2",
     "find-parent-dir": "^0.3.0",
     "git-semver-tags": "^1.2.1",
+    "lodash": "^4.17.5",
     "npm-run-all": "^4.1.1",
     "open": "^0.0.5",
     "readline-sync": "^1.4.7",

publish_yalc_package.js

@@ -17,6 +17,8 @@ const ORIG_DIR = process.cwd();
 
 function publishYalcPackage(installTargetDir, installSource, flags) {
   flags = flags || {};
+  const branch = flags.branch || 'origin/master';
+
   if (!installTargetDir || !installSource) {
     throw new Error('Usage: publish_yalc_package [INSTALL_DIR] [GITHUB_URL|LOCAL_DIR]');
   }
@@ -29,7 +31,7 @@ function publishYalcPackage(installTargetDir, installSource, flags) {
   // Create directory and clone git repo
   if (!fs.existsSync(path.join(installTargetDir, '.git'))) {
     if (isRemoteSource) {
-      util._exec(`git clone --depth 3 ${installSource} ${installTargetDir}`);
+      util._exec(`git clone ${installSource} ${installTargetDir}`);
     } else {
       shelljs.rm('-rf', installTargetDir);
       shelljs.cp('-r', installSourceDir, installTargetDir);
@@ -43,7 +45,7 @@ function publishYalcPackage(installTargetDir, installSource, flags) {
   if (isRemoteSource) {
     process.chdir(installTargetDir);
     util._exec('git fetch origin');
-    util._exec('git reset --hard origin/master');
+    util._exec(`git reset --hard ${branch}`);
     util._exec('git clean --force -d');
   } else {
     // Create a tmp dir with a copy of the current package contents
@@ -70,7 +72,9 @@ function publishYalcPackage(installTargetDir, installSource, flags) {
   }
 
   // Update dependencies
-  util._exec('yarn install --check-files');
+  if (!flags.noInstall) {
+    util._exec('yarn install --check-files');
+  }
 
   const TEMP = tmp.dirSync();
   const TEMP_DIR = TEMP.name;

yarn.lock

@@ -704,6 +704,10 @@ lodash@^4.0.0, lodash@^4.2.1:
   version "4.17.4"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"
 
+lodash@^4.17.5:
+  version "4.17.5"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
+
 longest@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/longest/-/longest-1.0.1.tgz#30a0b2da38f73770e8294a0d22e6625ed77d0097"