refactor(docgen): Read docgen config from package.json

Author: christopherthielen

docgen/Dockerfile

@@ -10,6 +10,5 @@ RUN sed -i'' -e 's/Globals/{{name}}/' node_modules/typedoc-default-themes/bin/de
 COPY clone.sh /home/node/work
 COPY docgen.sh /home/node/work
 COPY prep_docgen.js /home/node/work
-COPY findSemverPackage.js /home/node/work
 
 ENTRYPOINT ["/home/node/work/docgen.sh"]

docgen/docgen.sh

@@ -15,12 +15,13 @@ PROJECT=${WORK}/project
 }
 
 pushd $WORK
-cp $WORK/project/docgen.json .
-cp $WORK/project/typedoc.json .
+[[ -e typedoc.json ]] && rm typedoc.json
+ln -s $WORK/project/typedoc.json .
 README=$(jq -r .readme < typedoc.json)
 cp $WORK/project/$README .
 
 ./prep_docgen.js
 bash ./clone_repos.sh
-npx typedoc
+cd project
+../node_modules/.bin/typedoc --tsconfig tsconfig.docgen.json
 rm -rf project/src/includes

docgen/findSemverPackage.js

@@ -1,9 +1,7 @@
 {
   "dependencies": {
-    "lodash": "^4.17.19",
-    "find-parent-dir": "^0.3.0",
     "typedoc": "0.17.8",
     "typescript": "3.9.7",
-    "typedoc-plugin-ui-router": "3.0.2"
+    "typedoc-plugin-ui-router": "4.0.0"
   }
 }

docgen/package.json

@@ -1,35 +1,26 @@
 #!/usr/bin/env node
 const fs = require('fs');
 const childProcess = require('child_process');
-const _ = require('lodash');
 
 const WORKDIR = process.cwd();
 const PACKAGE_DIR = `${WORKDIR}/project`;
 const SRC_DIR = `${PACKAGE_DIR}/src`;
-const DOCGENCONFIG_PATH = `${PACKAGE_DIR}/docgen.json`;
-const TSCONFIG_PATH = `${PACKAGE_DIR}/tsconfig.json`;
 const PACKAGEJSON_PATH = `${PACKAGE_DIR}/package.json`;
 
 if (!fs.existsSync(SRC_DIR)) { throw new Error(`${SRC_DIR} does not exist`) }
-if (!fs.existsSync(DOCGENCONFIG_PATH)) { throw new Error(`${DOCGENCONFIG_PATH} does not exist`); }
+if (!fs.existsSync(PACKAGEJSON_PATH)) { throw new Error(`${PACKAGEJSON_PATH} does not exist`); }
 
 const PACKAGEJSON = JSON.parse(fs.readFileSync(PACKAGEJSON_PATH));
-const DOCGENCONFIG = getDocgenConfig();
-const TSCONFIG_COPY = JSON.parse(fs.readFileSync(TSCONFIG_PATH).toString());
+const DOCGENCONFIG = getDocgenConfig(PACKAGEJSON);
 
-// Merge tsconfig block from docgen.json into tsconfig.json
-_.merge(TSCONFIG_COPY, DOCGENCONFIG.tsconfig);
-fs.writeFileSync(`${WORKDIR}/tsconfig.json`, JSON.stringify(TSCONFIG_COPY, null, 2));
-
-function getDocgenConfig() {
-  const config = JSON.parse(fs.readFileSync(DOCGENCONFIG_PATH));
-  const requiredKeys = ['navigation', 'tsconfig'];
-  const missing = requiredKeys.find((key) => !_.has(config, key));
+function getDocgenConfig(packageJson) {
+  const requiredKeys = ['docgen', 'docgen.navigation', 'docgen.publishDir'];
+  const missing = requiredKeys.find((key) => key.split(".").reduce((acc, k) => acc && acc[k], packageJson) === undefined);
   if (missing) {
-    console.error(`${DOCGENCONFIG_PATH} does not contain configuration key: '${missing}'`);
+    console.error(`${PACKAGEJSON_PATH} does not contain configuration key: '${missing}'`);
     process.exit(1);
   }
-  return config;
+  return packageJson.docgen;
 }
 
 // Fetch all included packages (i.e., core module)

docgen/prep_docgen.js

@@ -10,14 +10,14 @@ const _exec = util._exec;
 const sh = require('shelljs');
 const readlineSync = require('readline-sync');
 
-const CONFIG = JSON.parse(fs.readFileSync('./docgen.json'));
 const TYPEDOC_CONFIG = JSON.parse(fs.readFileSync('./typedoc.json'));
-const pkg = JSON.parse(fs.readFileSync('./package.json'));
-const version = pkg.version;
+const PKGJSON = JSON.parse(fs.readFileSync('./package.json'));
+const DOCGEN_CONFIG = PKGJSON.docgen || {};
+const version = PKGJSON.version;
 
 const GIT_URL = "[email protected]:ui-router/ui-router.github.io.git";
 const installTargetDir = path.join(".downstream_cache", "ui-router.gihub.io");
-const PAGES_DIR = path.join(installTargetDir, CONFIG.publishDir);
+const PAGES_DIR = path.join(installTargetDir, DOCGEN_CONFIG.publishDir);
 
 sh.rm('-rf', installTargetDir);
 _exec(`git clone ${GIT_URL} ${installTargetDir}`);