Use a js file for local docs generation

Author: sivakumar-kailasam

README.md

@@ -32,7 +32,7 @@ The script pulls yuidoc build output from all Ember versions from Amazon S3, con
 
 ## To Generate docs for a specific project and/or version for development
 
-You can do this by passing `--project ember/ember-data --version 2.11.1` as an argument to the index script. e.g., `yarn start -- --project ember --version 2.11.0`.
+You can do this by passing `--project ember/ember-data --version 2.11.1` as an argument to the index script. e.g., `yarn start --project ember --version 2.11.0`.
 You need an additional flag `AWS_SHOULD_PUBLISH=true` for publishing the docs.
 
 ## To override a specific version of a doc with a different yuidoc from your machine (For core contributors)
@@ -56,8 +56,7 @@ app with documentation pulled from a local copy of ember.js.
     - [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
     - [ember-api-docs](https://github.com/ember-learn/ember-api-docs)
 1.  Set up the project according to the instructions above in `Running the app`.
-1.  From the `ember-jsonapi-docs` directory, run `./generate-local.sh yui ember 2.18.0`. This command runs the Ember documentation build, generates jsonapi output, and copies it to the `ember-api-docs` directory. To build ember data documentation, run `./generate-local.sh yui ember-data 2.17.2`.
-    - If your `rev-index/ember-X.X.X.json` file fails to generate, make sure you have all dependencies installed for the ember.js repo
+1.  From the `ember-jsonapi-docs` directory, run `yarn gen --project ember --version 2.18.0`. This command runs the Ember documentation build, generates jsonapi output, copies it to the `ember-api-docs` directory & runs this app. To build ember data documentation, run `yarn gen --project ember-data --version 2.18.0`.
     - If you are debugging failed builds, periodically clear out the contents of the `tmp` directory, and run the script again. Past failed runs can cause subsequent runs to fail in unexpected ways.\_
 1.  Run `yarn server` in this app to serve the content locally.
-1.  Run the API app with the newly generated local data by running `API_HOST=http://localhost:5050 ember s` in the `ember-api-docs` directory.
+1.  Run the API app with the newly generated local data by running `yarn server` in this app & then run `yarn start:local` in the `ember-api-docs` directory.

generate-local.js

@@ -0,0 +1,91 @@
+import chalk from 'chalk'
+import commandExists from 'command-exists'
+import execa from 'execa'
+import { copyFileSync, existsSync, mkdirpSync, removeSync } from 'fs-extra'
+import minimist from 'minimist'
+import path from 'path'
+
+const argv = minimist(process.argv.slice(2))
+
+const { project, version } = argv
+
+const exit = function exit() {
+	console.log(...arguments)
+	process.exit(1)
+}
+
+const runCmd = async (cmd, path) => {
+	console.log(chalk.underline(`Running '${chalk.green(cmd)}'`))
+	const executedCmd = await execa.shell(cmd, { cwd: path })
+
+	if (executedCmd.failed) {
+		console.error(executedCmd.stderr)
+		process.exit(1)
+	}
+
+	console.log(executedCmd.stdout + '\n')
+}
+;(async () => {
+	if (!project || !version) {
+		exit(
+			chalk.red('Both project and version args are required.\n'),
+			chalk.yellow(' e.g., yarn gen --project ember --version 3.10.1')
+		)
+	}
+
+	if (!['ember', 'ember-data'].includes(project)) {
+		exit(chalk.red(`Project has to be either 'ember' or 'ember-data'. (was given ${project})\n`))
+	}
+
+	try {
+		await commandExists('yarn')
+	} catch (e) {
+		exit(chalk.red('We need yarn installed globally for this script to work'))
+	}
+
+	let emberProjectPath = path.join(__dirname, '../', 'ember.js')
+	let emberDataProjectPath = path.join(__dirname, '../', 'data')
+
+	let checkIfProjectDirExists = dirPath => {
+		if (!existsSync(dirPath)) {
+			exit(chalk.yellow(`Please checkout the ${project} project at ${dirPath}`))
+		}
+	}
+
+	let buildDocs = async projDirPath => {
+		checkIfProjectDirExists(projDirPath)
+		await runCmd('yarn', projDirPath)
+
+		console.log('\n\n')
+
+		await runCmd(project === 'ember' ? 'yarn docs' : 'yarn build:production', projDirPath)
+
+		const projYuiDocFile = `tmp/s3-docs/v${version}/${project}-docs.json`
+		removeSync(projYuiDocFile)
+		removeSync(`tmp/json-docs/${project}/${version}`)
+
+		mkdirpSync(`tmp/s3-docs/v${version}`)
+
+		const yuiDocFile = path.join(
+			projDirPath,
+			project === 'ember' ? 'docs/data.json' : 'packages/-ember-data/dist/docs/data.json'
+		)
+		copyFileSync(yuiDocFile, projYuiDocFile)
+	}
+
+	let dirMap = {
+		ember: emberProjectPath,
+		'ember-data': emberDataProjectPath,
+	}
+
+	await buildDocs(dirMap[project])
+
+	await execa('yarn', [
+		'start',
+		'--project',
+		project,
+		'--version',
+		version,
+		'--ignorePreviouslyIndexedDoc',
+	]).stdout.pipe(process.stdout)
+})()

generate-local.sh

@@ -19,17 +19,20 @@
 		"test": "test"
 	},
 	"scripts": {
+		"gen": "node -r esm generate-local.js",
 		"greet": "echo 'hi'",
 		"server": "http-server -p 5050 --cors tmp",
 		"start": "node index.js",
 		"test": "eslint lib/**/*.js index.js test/**.js && mocha -r esm test"
 	},
 	"dependencies": {
 		"cheerio": "^1.0.0-rc.2",
+		"command-exists": "^1.2.8",
 		"compare-versions": "^3.4.0",
 		"download": "^7.1.0",
 		"ember-rfc176-data": "^0.3.9",
 		"esm": "^3.2.25",
+		"execa": "^1.0.0",
 		"fs-extra": "^7.0.0",
 		"glob": "^7.1.3",
 		"graceful-fs": "^4.1.11",

package.json

@@ -108,6 +108,7 @@ async@^1.5.2:
 aws-sdk@~2.0.31, aws-sdk@~2.276.1:
   version "2.276.1"
   resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.276.1.tgz#4f5cd52f4d1a13a412c8a8d75b276c556ad13947"
+  integrity sha512-pxIJmDwE+JWeHyc8WAa9mTpAh/X+RQF7DHLMM4amf7Dhj6EvoucbWByKS6+rZF4MfYIA+a4E1J0GELEz/m+uJA==
   dependencies:
     buffer "4.9.1"
     events "1.1.1"
@@ -333,6 +334,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/colors/-/colors-1.0.3.tgz#0433f44d809680fdeb60ed260f1b0c262e82a40b"
   integrity sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs=
 
+command-exists@^1.2.8:
+  version "1.2.8"
+  resolved "https://registry.yarnpkg.com/command-exists/-/command-exists-1.2.8.tgz#715acefdd1223b9c9b37110a149c6392c2852291"
+  integrity sha512-PM54PkseWbiiD/mMsbvW351/u+dafwTJ0ye2qB60G1aGQP9j3xK2gmMDc+R34L3nDtx4qMCitXT75mkbkGJDLw==
+
 [email protected]:
   version "2.15.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
@@ -2479,6 +2485,7 @@ util-deprecate@~1.0.1:
 [email protected]:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.1.0.tgz#3dd3d3e790abc24d7b0d3a034ffababe28ebbc04"
+  integrity sha512-DIWtzUkw04M4k3bf1IcpS2tngXEL26YUD2M0tMDUpnUrz2hgzUBlD55a4FjdLGPvfHxS6uluGWvaVEqgBcVa+g==
 
 validate-npm-package-license@^3.0.1:
   version "3.0.4"