Adding script to autogenerate documentation in one go (#266)

* Adding script to autogenerate documentation in one go

* Cleaning code

* Renaming function

Author: munozemilio

package.json

@@ -3,13 +3,15 @@
   "version": "1.0.0",
   "scripts": {
     "build": "lerna run build && lerna bootstrap",
+    "generate-md": "npm run build && lerna run documentation && lerna run maindoc && node scripts/fixurls.js",
     "test": "lerna run test",
     "coverage": "nyc npm test",
     "coveralls": "npm run coverage",
     "upload-coveralls": "nyc report --reporter=text-lcov | coveralls"
   },
   "private": true,
   "devDependencies": {
+    "fs-extra": "^8.1.0",
     "lerna": "^3.2.1"
   }
 }

packages/chatdown/package.json

@@ -70,6 +70,7 @@
     "posttest": "tslint -p test -t stylish",
     "prepack": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.{ts,js}\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif-dev readme && git add README.md",
+    "documentation": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   }
 }

packages/cli/package.json

@@ -76,7 +76,8 @@
     "posttest": "tslint -p test -t stylish",
     "prepack": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "version": "oclif-dev readme && git add README.md",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.{ts,js}\""
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.{ts,js}\"",
+    "maindoc": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   },
   "types": "lib/index.d.ts"
 }

packages/config/package.json

@@ -54,7 +54,8 @@
     "posttest": "tslint -p test -t stylish",
     "prepack": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif-dev readme && git add README.md",
+    "documentation": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   },
   "telemetry": null
 }

packages/dialog/package.json

@@ -62,6 +62,7 @@
     "prepack": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "posttest": "tslint -p test -t stylish",
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif-dev readme && git add README.md",
+    "documentation": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   }
 }

packages/lu/package.json

@@ -62,7 +62,8 @@
     "posttest": "tslint -p test -t stylish",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.**\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif-dev readme && git add README.md",
+    "documentation": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   },
   "nyc": {
     "exclude": [

packages/qnamaker/package.json

@@ -73,6 +73,7 @@
     "posttest": "tslint -p test -t stylish",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif-dev readme && git add README.md",
+    "documentation": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme && rimraf oclif.manifest.json"
   }
 }

scripts/fixurls.js

@@ -0,0 +1,23 @@
+const path = require('path')
+const fs = require('fs-extra')
+
+const updateUrls = async () => {
+  let plugins = ['config', 'chatdown', 'dialog', 'lu', 'qnamaker', 'cli']
+  for (let i = 0; i < plugins.length; i++) {
+      await cleanUrls(plugins[i])
+  }
+}
+
+const cleanUrls = async function(plugin) {
+  let readmePath = path.join(__dirname, `./../packages/${plugin}/README.md`)
+  let fileContent = await fs.readFile(readmePath)
+  fileContent = fileContent.toString().replace(/\/blob\/v1\.0\.0/g, "")
+  await fs.writeFile(readmePath, fileContent)
+}
+
+const run = async () => {
+  await updateUrls()
+  process.exit(0)
+}
+
+run()