Playing around with scrips and generating README.md

Author: Adam A. Zerella

components/accordion/src/js/react.js components/accordion/src/react/react.js

@@ -350,7 +350,7 @@ class AUaccordion extends React.PureComponent {
 	/**
 	 * Toggle an accordion on click
 	 *
-	 * @param  {event object} event - The event object of the click
+	 * @param  {object} event - The event object of the click
 	 */
 	toggle( event ) {
 		event.preventDefault();

scripts/generate-readme/package-lock.json

@@ -13,6 +13,7 @@
     "@babel/preset-env": "^7.3.1",
     "@babel/preset-react": "^7.0.0",
     "jsdoc-to-markdown": "^4.0.1",
+    "pkg-dep-tree": "^0.2.1",
     "prismjs": "^1.15.0",
     "react": "^16.8.1",
     "react-dom": "^16.8.1"

scripts/generate-readme/package.json

@@ -3,6 +3,6 @@ const Path = require( 'path' );
 const Fs = require( 'fs' );
 
 module.exports = {
-    "componentPath": Path.join( __dirname, `/../../../components` ),
+    "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

@@ -3,6 +3,7 @@ const Fs = require( 'fs' );
 const Fsp = Fs.promises;
 const Path = require( 'path' );
 const JSDoc = require( 'jsdoc-to-markdown' );
+const { GetMonoDepTree, PrintTreeTrim } = require( 'pkg-dep-tree' );
 
 // Local Dependencies
 const { GetFolders } = require( './helper' );
@@ -15,34 +16,48 @@ const { Render, RenderExample } = require( './renderer' );
  * @param {filePath} reactSource 
  */
 const RenderReactDocs = async ( reactSource ) => {
-	return await JSDoc.render( reactSource );
+	let templateData = await JSDoc.getTemplateData( reactSource );
+
+	return templateData
+		.map( item => {
+			return { name } = item;
+		})
+	
+
+	// console.log( templateData );
+	// console.log( await JSDoc.getJsdocData( reactSource ) );
+	// return await JSDoc.getTemplateData( reactSource );
 }
 
+const GenerateReactProps = async( reactSourceFile ) => {
+	return await RenderReactDocs( { files: reactSourceFile } );
+}
 
 const GenerateDocPage = async () => {
-	let components = await GetFolders( Config.componentPath );
+	let components = await GetFolders( Config.workspace );
 
-	let markdown = await Fsp.readFile( `${components[ 0 ]}/doc/OVERVIEW.md`, 'utf-8' );
+	let markdown = ''
 
 	// Append React component comments to OVERVIEW.md file
-	markdown += await RenderReactDocs( { files: `${components[ 0 ]}/src/react/button.js` }, 'utf-8' );
-
-	let html = Render( markdown );
-	html +=	`<style>${ Config.prismTheme }</style>`
+	markdown += await RenderReactDocs( { files: `${components[ 0 ]}/src/react/react.js` }, 'utf-8' );
 
-	Fsp.writeFile( `index.html`, html );
+	// let html = Render( markdown );
+	// html +=	`<style>${ Config.prismTheme }</style>`
+	
+	// console.log( html );
+	return markdown
+	// Fsp.writeFile( `index.html`, html );
 }
 
 
 // Start thing
-( async () => {
-	// await GenerateDocPage();
-	
-	let components = await GetFolders( Config.componentPath );
+( async () => {	
+	let components = await GetFolders( Config.workspace );
 
 	let packageMeta = JSON.parse( await Fsp.readFile( `${components[ 0 ]}/package.json` ) );
 	let packageNamePlain = packageMeta.name.split('/')[1]
 
+	let sourceFiles = { "files": `${ components[ 0 ] }/src/react/react.js` }
 	let readme = `${packageMeta.name}
 	
 ---
@@ -58,16 +73,14 @@ npm i ${packageMeta.name}
 \`\`\`
 
 ## Usage
-\`\`\`jsx
-
-\`\`\`
 
 ## Props
-todo
+${ await RenderReactDocs( sourceFiles ) }
 
 ## Dependency Graph
 \`\`\`bash
-
+${ packageNamePlain }
+${ await( PrintTreeTrim( await GetMonoDepTree( Config.workspace, packageNamePlain, '@gov.au') ) ) }
 \`\`\`
 
 ## Test