Skip to content
This repository was archived by the owner on Aug 26, 2021. It is now read-only.

Commit 5f243f9

Browse files
author
Adam A. Zerella
committed
Updated script to minify and remove comments for transpiling
1 parent 5c2935f commit 5f243f9

File tree

2 files changed

+33
-35
lines changed

2 files changed

+33
-35
lines changed

scripts/generate-readme/src/index.js

+21-31
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,22 @@ const { GetMonoDepTree, PrintTreeTrim } = require( 'pkg-dep-tree' );
88
// Local Dependencies
99
const { GetFolders } = require( './helper' );
1010
const Config = require( './config' );
11-
const { Render, RenderExample } = require( './renderer' );
11+
const { RenderHTML } = require( './renderer' );
1212

1313

1414
/**
1515
*
16-
* @param {filePath} reactSource
16+
* @param {object} reactSource - Object of file paths
1717
*/
18-
const RenderReactDocs = async ( reactSource ) => {
18+
const GenerateReactProps = async ( reactSource ) => {
1919
let templateData = await JSDoc.getTemplateData( reactSource );
20-
21-
return templateData
20+
21+
templateData = templateData
2222
.map( item => {
23-
return { name } = item;
23+
return { 'name': item.name, 'description': item.description };
2424
})
2525

26-
27-
// console.log( templateData );
28-
// console.log( await JSDoc.getJsdocData( reactSource ) );
29-
// return await JSDoc.getTemplateData( reactSource );
30-
}
31-
32-
const GenerateReactProps = async( reactSourceFile ) => {
33-
return await RenderReactDocs( { files: reactSourceFile } );
34-
}
35-
36-
const GenerateDocPage = async () => {
37-
let components = await GetFolders( Config.workspace );
38-
39-
let markdown = ''
40-
41-
// Append React component comments to OVERVIEW.md file
42-
markdown += await RenderReactDocs( { files: `${components[ 0 ]}/src/react/react.js` }, 'utf-8' );
43-
44-
// let html = Render( markdown );
45-
// html += `<style>${ Config.prismTheme }</style>`
46-
47-
// console.log( html );
48-
return markdown
49-
// Fsp.writeFile( `index.html`, html );
26+
return JSON.stringify( templateData, null, 4 );
5027
}
5128

5229

@@ -58,6 +35,8 @@ const GenerateDocPage = async () => {
5835
let packageNamePlain = packageMeta.name.split('/')[1]
5936

6037
let sourceFiles = { "files": `${ components[ 0 ] }/src/react/react.js` }
38+
let sourceFileContent = await Fsp.readFile( sourceFiles.files, `utf-8` );
39+
6140
let readme = `${packageMeta.name}
6241
6342
---
@@ -73,9 +52,20 @@ npm i ${packageMeta.name}
7352
\`\`\`
7453
7554
## Usage
55+
### HTML
56+
\`\`\`html
57+
${ RenderHTML( sourceFileContent ) }
58+
\`\`\`
59+
60+
### React
61+
\`\`\`jsx
62+
todo
63+
\`\`\`
7664
7765
## Props
78-
${ await RenderReactDocs( sourceFiles ) }
66+
\`\`\`json
67+
${ await GenerateReactProps( sourceFiles ) }
68+
\`\`\`
7969
8070
## Dependency Graph
8171
\`\`\`bash

scripts/generate-readme/src/renderer.js

+12-4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ const PrismLanguage = require( 'prismjs/components/');
1414
const TransformCode = ( code ) => {
1515
return Babel.transform( code, {
1616
presets: [ '@babel/preset-react', '@babel/preset-env' ],
17+
minified: true,
18+
comments: false
1719
}).code;
1820
}
1921

@@ -38,15 +40,19 @@ const FormatHTML = ( html, react ) => {
3840

3941
/**
4042
*
41-
* @param {string} react
43+
* @param {string} react - The react source file contents
4244
*/
4345
const RenderHTML = ( react ) => {
4446
// Parse React code to commonJS
4547
let commonJS = TransformCode( react );
48+
4649
// Extract HTML from common react code
4750
let html = ReactDOMServer.renderToStaticMarkup( eval( commonJS ) );
51+
52+
return html;
53+
4854
// Add styling and escaping to HTML
49-
return FormatHTML( html, react );
55+
// return FormatHTML( html, react );
5056
}
5157

5258
/**
@@ -94,5 +100,7 @@ const RenderMarkdownCode = ( markdown ) => {
94100
return Marked( markdown, { renderer: MarkdownRenderer, breaks: true } );
95101
}
96102

97-
module.exports.Render = RenderMarkdownCode;
98-
module.exports.RenderExample = RenderExample;
103+
// module.exports.Render = RenderMarkdownCode;
104+
// module.exports.RenderExample = RenderExample;
105+
module.exports.RenderHTML = RenderHTML;
106+
// module.exports.RenderJSX = RenderJSX;

0 commit comments

Comments
 (0)