Reduced scope of generate-readme script to JUST generate README.md

Removed unused deps

Made code neater

Author: Adam A. Zerella

scripts/generate-readme/package-lock.json

@@ -3,19 +3,14 @@
   "version": "0.1.0",
   "description": "",
   "main": "src/index.js",
-  "scripts": {
-    "test": ""
-  },
   "author": "",
   "license": "MIT",
   "dependencies": {
     "@babel/core": "^7.2.2",
     "@babel/preset-env": "^7.3.1",
     "@babel/preset-react": "^7.0.0",
     "jsdoc-to-markdown": "^4.0.1",
-    "marked": "^0.6.0",
     "pkg-dep-tree": "^0.2.1",
-    "prismjs": "^1.15.0",
     "react": "^16.8.2",
     "react-docgen": "^3.0.0",
     "react-dom": "^16.8.2"

scripts/generate-readme/package.json

@@ -1,8 +1,5 @@
-// Dependencies
 const Path = require( 'path' );
-const Fs = require( 'fs' );
 
 module.exports = {
     "workspace": Path.join( __dirname, `/../../../components` ),
-    "prismTheme": Fs.readFileSync( Path.join( __dirname, '/../node_modules/prismjs/themes/prism-dark.css' ), 'utf-8' )
 }

scripts/generate-readme/src/config.js

@@ -1,27 +1,43 @@
-// Dependencies
 const Fs = require( 'fs' );
 const Fsp = Fs.promises;
 
+
 /**
- * IsDirectory - Check if a location is a file or a directory
+ * IsDirectory - Check if a path location is a directory.
  *
  * @param {string} source - The location of the file
  */
 const IsDirectory = ( source ) => {
-	return Fs.lstatSync( source ).isDirectory();
+	try {
+		return Fs.lstatSync( source ).isDirectory();
+	}
+	catch( error ) {
+		console.error( error );
+	}
+	return false;
 }
 
+
 /**
- * GetFolder - Gets all the folders inside a location
+ * GetFolder - Gets all the folders inside a path location.
  *
- * @param {*} folderLocation - The location of the folder to get folders from
+ * @param {string} folderLocation - The path location of the root folder.
  */
-const GetFolders = async ( folderLocation ) => {	
-	// Get the contents inside the folder
-	const folderContents = await Fsp.readdir( folderLocation, { withFileTypes: true } );
-	
-	// Filter the contents and return only directories
-	return folderContents.map( source => `${ folderLocation }/${ source.name }` ).filter( IsDirectory );
+const GetFolders = async ( folderLocation ) => {
+	try{ 
+		// Get the contents inside the folder
+		const folderContents = await Fsp.readdir( folderLocation, { withFileTypes: true } );
+
+		// Filter the contents and return only directories
+		return folderContents
+			.map( source => `${ folderLocation }/${ source.name }` )
+			.filter( IsDirectory );
+	}
+	catch( error ) {
+		console.error( error );
+	}
+
+	return [];
 }
 
 
@@ -35,12 +51,11 @@ const FileExists = async ( fileLocation ) => {
 		return ( await Fsp.stat( fileLocation ) ).isFile()
 	}
 	catch( error ) {
-		console.error( error );
+		console.error( `❌  Bollocks! It looks like: ${ fileLocation } doesn't exist!` );
 	}
 	return false;
 }
 
 
-
 module.exports.GetFolders = GetFolders;
-module.exports.FileExists = FileExists;
+module.exports.FileExists = FileExists;

scripts/generate-readme/src/helper.js

@@ -5,23 +5,34 @@ const Path = require( 'path' );
 const JSDoc = require( 'jsdoc-to-markdown' );
 const { GetMonoDepTree, PrintTreeTrim } = require( 'pkg-dep-tree' );
 
+
 // Local Dependencies
-const { GetFolders } = require( './helper' );
+const { GetFolders, FileExists } = require( './helper' );
 const Config = require( './config' );
 const { RenderHTML, RenderReactPropsMarkdownTable } = require( './render' );
 
 
-// Start thing
-( async () => {	
+// Start da fing
+( async () => {
 	let components = await GetFolders( Config.workspace );
-	
-	let packageMeta = JSON.parse( await Fsp.readFile( `${components[ 0 ]}/package.json` ) );
-	let packageNamePlain = packageMeta.name.split('/')[1]
+	// @todo - Test with a single component...
+	let component = components[ 0 ]; 
 
-	let sourceFiles = { "files": `${ components[ 0 ] }/src/js/react.js` }
-	let sourceFileContent = await Fsp.readFile( sourceFiles.files, `utf-8` );
+	let hasJS = await FileExists( `${ component }/src/js/module.js` );
+	let hasReact = await FileExists( `${ component }/src/js/react.js` );
+	let hasJquery = await FileExists( `${ component }/src/js/jquery.js` );
 
-	// console.log( ReactDocs.parse( sourceFileContent ) );
+	let packageMeta = JSON.parse( await Fsp.readFile( `${ component }/package.json` ) );
+	let packageNamePlain = packageMeta.name.split('/')[1]
+	
+	let sourceFiles;
+	let sourceFileContent;
+
+	if ( hasReact ){
+		sourceFiles = { "files": `${ component }/src/js/react.js` }
+		sourceFileContent = await Fsp.readFile( sourceFiles.files, `utf-8` );
+	}
+	
 	let readme = `${packageMeta.name}
 ---
 ${packageMeta.description}
@@ -36,27 +47,41 @@ npm i ${packageMeta.name}
 \`\`\`
 
 ## Usage
-### HTML
+${ hasReact
+? `### HTML
 \`\`\`html
-${ RenderHTML( sourceFileContent ) }
+${ RenderHTML( sourceFileContent ) }todo
 \`\`\`
-
 ### React
 \`\`\`jsx
 todo
-\`\`\`
+\`\`\``
+: ``}
+
+${ hasJquery
+? `### jQuery
+\`\`\`jsx
+todo
+\`\`\``
+: ``}
 
 ## Props
 ${ await RenderReactPropsMarkdownTable( sourceFileContent ) }
 
-## Dependency Graph
+## Dependency graph
 \`\`\`bash
 ${ packageNamePlain }
 ${ await( PrintTreeTrim( await GetMonoDepTree( Config.workspace, packageNamePlain, '@gov.au') ) ) }
 \`\`\`
 
-## Test
-https://auds.service.gov.au/packages/${packageNamePlain}/tests/site/
+## Latest updates
+For the latest release notes, check out the [CHANGELOG.md](https://github.com/govau/design-system-components/blob/master/packages/${ packageNamePlain }/CHANGELOG.md) file.
+
+## Test preview
+https://auds.service.gov.au/packages/${ packageNamePlain }/tests/site/
+
+## License
+Copyright (c) Commonwealth of Australia. Licensed under [MIT](https://raw.githubusercontent.com/govau/design-system-components/packages/core/master/LICENSE).
 `
-	await Fsp.writeFile( `${components[ 0 ]}/README-GEN.md`, readme )
+	await Fsp.writeFile( `${ component }/README-GEN.md`, readme ) // @todo - Update output filename.
 })();