From ddff4692fd365b5125068004667ffc6acb8cb85a Mon Sep 17 00:00:00 2001 From: Nate Fischer Date: Mon, 25 Jan 2016 00:04:53 -0800 Subject: [PATCH] fix(gen-docs): fix issue where docs are generated wrong This fixes an issue where the gen-docs script's sed() command would improperly update the docs. Travis now checks that docs are generated properly. --- .travis.yml | 2 ++ scripts/generate-docs.js | 10 +++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 0f72d8d..19bb9c6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -21,3 +21,5 @@ os: - osx script: - npm test + - node scripts/generate-docs.js + - git diff --quiet # make sure no files have changed diff --git a/scripts/generate-docs.js b/scripts/generate-docs.js index f68bd3b..3a31a91 100755 --- a/scripts/generate-docs.js +++ b/scripts/generate-docs.js @@ -1,5 +1,5 @@ #!/usr/bin/env node -/* globals cd, echo, grep, sed */ +/* globals cat, cd, echo, grep, sed */ require('../global'); echo('Appending docs to README.md'); @@ -16,7 +16,11 @@ docs = docs.replace(/\/\/\@include (.+)/g, function(match, path) { // Remove '//@' docs = docs.replace(/\/\/\@ ?/g, ''); -// Append docs to README -sed('-i', /## Command reference(.|\n)*/, '## Command reference\n\n' + docs, 'README.md'); + +// Wipe out the old docs +cat('README.md').replace(/## Command reference(.|\n)*/, '## Command reference').to('README.md'); + +// Append new docs to README +sed('-i', /## Command reference/, '## Command reference\n\n' + docs, 'README.md'); echo('All done.');