From 04401bd4ce308c263c28a8435444a3a8a0334e43 Mon Sep 17 00:00:00 2001 From: Jonathan Lui Date: Fri, 25 Jan 2019 15:26:55 -0800 Subject: [PATCH] build: check broken links in generated docs (#213) * build: check dead links on Kokoro * recursive crawl local links * fix dead timestamp links --- packages/google-privacy-dlp/.jsdoc.js | 2 +- packages/google-privacy-dlp/package.json | 2 +- .../src/v2/doc/google/protobuf/doc_timestamp.js | 6 ++---- packages/google-privacy-dlp/synth.py | 10 ++++++++++ 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/packages/google-privacy-dlp/.jsdoc.js b/packages/google-privacy-dlp/.jsdoc.js index 46aa99c4021..e52046582f5 100644 --- a/packages/google-privacy-dlp/.jsdoc.js +++ b/packages/google-privacy-dlp/.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/packages/google-privacy-dlp/package.json b/packages/google-privacy-dlp/package.json index 5cb5de95612..e42ef2293c0 100644 --- a/packages/google-privacy-dlp/package.json +++ b/packages/google-privacy-dlp/package.json @@ -51,7 +51,7 @@ "eslint-config-prettier": "^3.0.0", "eslint-plugin-node": "^8.0.0", "eslint-plugin-prettier": "^3.0.0", - "ink-docstrap": "^1.3.0", + "jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git", "intelli-espower-loader": "^1.0.1", "jsdoc": "^3.5.5", "mocha": "^5.0.0", diff --git a/packages/google-privacy-dlp/src/v2/doc/google/protobuf/doc_timestamp.js b/packages/google-privacy-dlp/src/v2/doc/google/protobuf/doc_timestamp.js index 1ebe2e6e1a5..1cc64cbed80 100644 --- a/packages/google-privacy-dlp/src/v2/doc/google/protobuf/doc_timestamp.js +++ b/packages/google-privacy-dlp/src/v2/doc/google/protobuf/doc_timestamp.js @@ -87,13 +87,11 @@ * 01:30 UTC on January 15, 2017. * * In JavaScript, one can convert a Date object to this format using the - * standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString] + * standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) * method. In Python, a standard `datetime.datetime` object can be converted * to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) * with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one - * can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://cloud.google.com - * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime-- - * ) to obtain a formatter capable of generating timestamps in this format. + * can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--) to obtain a formatter capable of generating timestamps in this format. * * @property {number} seconds * Represents seconds of UTC time since Unix epoch diff --git a/packages/google-privacy-dlp/synth.py b/packages/google-privacy-dlp/synth.py index 5a49e2a3007..555853e0969 100644 --- a/packages/google-privacy-dlp/synth.py +++ b/packages/google-privacy-dlp/synth.py @@ -30,6 +30,16 @@ templates = common_templates.node_library() s.copy(templates) +# [START fix-dead-link] +s.replace('**/doc/google/protobuf/doc_timestamp.js', + 'https:\/\/cloud\.google\.com[\s\*]*http:\/\/(.*)[\s\*]*\)', + r"https://\1)") + +s.replace('**/doc/google/protobuf/doc_timestamp.js', + 'toISOString\]', + 'toISOString)') +# [END fix-dead-link] + # Node.js specific cleanup subprocess.run(['npm', 'install']) subprocess.run(['npm', 'run', 'fix'])