Refactor to accept version option

Author: Planeshifter

lib/node_modules/@stdlib/_tools/docs/www/readme-database/README.md

@@ -52,6 +52,7 @@ The function accepts the following `options`:
 -   **dir**: root directory from which to search for package READMEs. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
 -   **pattern**: glob pattern used to find packages. Default: `'**/package.json'` (note: pattern **must** end with `package.json`).
 -   **ignore**: list of glob patterns used to exclude matches.
+-   **version**: semantic versioning number or branch name.
 
 To search from an alternative directory, set the `dir` option.
 
@@ -110,6 +111,26 @@ function done( error, db ) {
 }
 ```
 
+To have internal URLs of the READMEs link to the correct version of the documentation, set the `version` option. 
+
+<!-- run-disable -->
+
+
+```javascript
+var opts = {
+    'version': '0.0.87'
+};
+
+create( opts, done );
+
+function done( error, db ) {
+    if ( error ) {
+        throw error;
+    }
+    console.log( JSON.stringify( db ) );
+}
+```
+
 </section>
 
 <!-- /.usage -->
@@ -182,6 +203,7 @@ Options:
   -V,    --version             Print the package version.
          --pattern pattern     Inclusion glob pattern.
          --ignore pattern      Exclusion glob pattern.
+         --semver version      Semantic versioning number or branch name.
 ```
 
 </section>

lib/node_modules/@stdlib/_tools/docs/www/readme-database/bin/cli

@@ -72,6 +72,9 @@ function main() {
 			opts.ignore = flags.ignore;
 		}
 	}
+	if ( flags.semver ) {
+		opts.version = flags.semver;
+	}
 	if ( args[ 0 ] ) {
 		opts.dir = args[ 0 ];
 	}

lib/node_modules/@stdlib/_tools/docs/www/readme-database/docs/usage.txt

@@ -7,4 +7,5 @@ Options:
   -V,    --version             Print the package version.
          --pattern pattern     Inclusion glob pattern.
          --ignore pattern      Exclusion glob pattern.
+         --semver version      Semantic versioning number or branch name.
 

lib/node_modules/@stdlib/_tools/docs/www/readme-database/etc/cli_opts.json

@@ -1,7 +1,8 @@
 {
 	"string": [
 		"pattern",
-		"ignore"
+		"ignore",
+		"semver"
 	],
 	"boolean": [
 		"help",

lib/node_modules/@stdlib/_tools/docs/www/readme-database/lib/defaults.json

@@ -1,4 +1,5 @@
 {
 	"pattern": "**/package.json",
-	"ignore": []
+	"ignore": [],
+	"version": "develop"
 }

lib/node_modules/@stdlib/_tools/docs/www/readme-database/lib/main.js

@@ -46,6 +46,7 @@ var debug = logger( 'readme-database:async' );
 * @param {string} [options.dir] - root directory from which to search for package READMEs
 * @param {string} [options.pattern='**\/package.json'] - glob pattern
 * @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
+* @param {string} [options.version='develop'] - semantic versioning number or branch name
 * @param {Function} clbk - callback
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
@@ -130,7 +131,7 @@ function create( options, clbk ) {
 		debug( 'Finished reading files.' );
 
 		debug( 'Rendering file contents...' );
-		render( files, done );
+		render( files, opts.version, done );
 	}
 
 	/**

lib/node_modules/@stdlib/_tools/docs/www/readme-database/lib/render.js

@@ -43,10 +43,11 @@ var RE_HEADER = headerRegExp( 'Apache-2.0', 'markdown' );
 *
 * @private
 * @param {ObjectArray} files - Markdown files
+* @param {string} version - semantic versioning number or branch name
 * @param {Callback} clbk - callback to invoke upon completion
 * @returns {void}
 */
-function render( files, clbk ) {
+function render( files, version, clbk ) {
 	var total;
 	var i;
 
@@ -67,7 +68,7 @@ function render( files, clbk ) {
 
 		debug( 'Rendering file %d of %d: %s', i+1, total, files[ i ].file );
 		str = removeHeader( files[ i ].data, RE_HEADER );
-		toHTML( str, onRender );
+		toHTML( str, version, onRender );
 
 		/**
 		* Callback invoked after rendering a file.

lib/node_modules/@stdlib/_tools/docs/www/readme-database/lib/validate.js

@@ -42,6 +42,7 @@ var RE = /package\.json$/;
 * @param {string} [options.dir] - root directory from which to search for package READMEs
 * @param {string} [options.pattern] - glob pattern
 * @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
+* @param {string} [options.version] - semantic versioning number or branch name
 * @returns {(Error|null)} error object or null
 *
 * @example
@@ -81,6 +82,12 @@ function validate( opts, options ) {
 			return new TypeError( 'invalid option. `ignore` option must be a string array. Option: `' + opts.ignore + '`.' );
 		}
 	}
+	if ( hasOwnProp( options, 'version' ) ) {
+		opts.version = options.version;
+		if ( !isString( opts.version ) ) {
+			return new TypeError( 'invalid option. `version` option must be a primitive string. Option: `' + opts.dir + '`.' );
+		}
+	}
 	return null;
 }
 

lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/README.md

@@ -52,6 +52,7 @@ The function accepts the following `options`:
 -   **dir**: root directory from which to search for package READMEs. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
 -   **pattern**: glob pattern used to find packages. Default: `'**/package.json'` (note: pattern **must** end with `package.json`).
 -   **ignore**: list of glob patterns used to exclude matches.
+-   **version**:  semantic versioning number or branch name.
 
 To search from an alternative directory, set the `dir` option.
 
@@ -110,6 +111,26 @@ function done( error ) {
 }
 ```
 
+To have internal URLs of the READMEs link to the correct version of the documentation, set the `version` option. 
+
+<!-- run-disable -->
+
+
+```javascript
+var opts = {
+    'version': '0.0.87'
+};
+
+build( './build', opts, done );
+
+function done( error ) {
+    if ( error ) {
+        throw error;
+    }
+    console.log( 'Finished' );
+}
+```
+
 </section>
 
 <!-- /.usage -->

lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/bin/cli

@@ -73,6 +73,9 @@ function main() {
 			opts.ignore = flags.ignore;
 		}
 	}
+	if ( flags.version ) {
+		opts.version = flags.version;
+	}
 	if ( !flags.out ) {
 		err = new Error( 'insufficient arguments. Must provide an output directory.' );
 		return cli.error( err, 1 );