build: check broken links in generated docs (#612)

jkwlui · JustinBeckwith · commit 4735b209e86e · 2019-01-14T23:28:42.000-08:00
diff --git a/.compodocrc b/.compodocrc
@@ -0,0 +1,10 @@
+---
+tsconfig: ./tsconfig.json
+output: ./docs
+theme: material
+hideGenerator: true
+disablePrivate: true
+disableProtected: true
+disableInternal: true
+disableCoverage: true
+disableGraph: true
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ google-cloud-debug-agent-*.tgz
 package-lock.json
 .nyc_output
 key.json
+docs/
diff --git a/.jsdoc.js b/.jsdoc.js
@@ -20,7 +20,7 @@ module.exports = {
   opts: {
     readme: './README.md',
     package: './package.json',
-    template: './node_modules/ink-docstrap/template',
+    template: './node_modules/jsdoc-baseline',
     recurse: true,
     verbose: true,
     destination: './docs/'
diff --git a/.kokoro/docs.sh b/.kokoro/docs.sh
@@ -23,3 +23,11 @@ cd $(dirname $0)/..
 npm install
 
 npm run docs
+
+# Check broken links
+BIN=./node_modules/.bin
+
+npm install broken-link-checker
+npm install http-server
+$BIN/http-server -p 8080 docs/ &
+$BIN/blc -r http://localhost:8080
diff --git a/README.md b/README.md
@@ -1,8 +1,7 @@
 # Stackdriver Debugger agent for Node.js
 
 [![NPM Version][npm-image]][npm-url]
-[![Build Status][travis-image]][travis-url]
-[![Test Coverage][coveralls-image]][coveralls-url]
+[![codecov](https://codecov.io/gh/googleapis/cloud-debug-nodejs/branch/master/graph/badge.svg)](https://codecov.io/gh/googleapis/cloud-debug-nodejs)
 [![Dependency Status][david-image]][david-url]
 [![devDependency Status][david-dev-image]][david-dev-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
@@ -214,10 +213,6 @@ exports.myFunc = (event) => {
 [debugger-roles]: https://cloud.google.com/debugger/docs/iam#roles
 [npm-image]: https://img.shields.io/npm/v/@google-cloud/debug-agent.svg
 [npm-url]: https://npmjs.org/package/@google-cloud/debug-agent
-[travis-image]: https://travis-ci.org/googleapis/cloud-debug-nodejs.svg?branch=master
-[travis-url]: https://travis-ci.org/googleapis/cloud-debug-nodejs
-[coveralls-image]: https://img.shields.io/coveralls/googleapis/cloud-debug-nodejs/master.svg
-[coveralls-url]: https://coveralls.io/r/googleapis/cloud-debug-nodejs?branch=master
 [david-image]: https://david-dm.org/googleapis/cloud-debug-nodejs.svg
 [david-url]: https://david-dm.org/googleapis/cloud-debug-nodejs
 [david-dev-image]: https://david-dm.org/googleapis/cloud-debug-nodejs/dev-status.svg
@@ -226,4 +221,3 @@ exports.myFunc = (event) => {
 [snyk-image]: https://snyk.io/test/github/googleapis/cloud-debug-nodejs/badge.svg
 [snyk-url]: https://snyk.io/test/github/googleapis/cloud-debug-nodejs
 [config-ts]: https://github.com/googleapis/cloud-debug-nodejs/blob/master/src/agent/config.ts
-[configuration-object]: https://googleapis.github.io/google-cloud-node/#/docs/google-cloud/0.45.0/google-cloud
diff --git a/package.json b/package.json
@@ -22,6 +22,7 @@
     "node": ">=6"
   },
   "devDependencies": {
+    "@compodoc/compodoc": "^1.1.7",
     "@types/acorn": "^4.0.2",
     "@types/console-log-level": "^1.4.0",
     "@types/estree": "0.0.39",
@@ -91,7 +92,7 @@
     "prepack": "npm run compile",
     "license-check": "jsgl --local .",
     "lint": "npm run check",
-    "docs": "echo no docs available 👻",
+    "docs": "compodoc src/",
     "samples-test": "mocha samples/system-test"
   },
   "files": [
