|
| 1 | +const jsdoc2md = require("jsdoc-to-markdown"); |
| 2 | +const fs = require("fs"); |
| 3 | +const path = require("path"); |
| 4 | +const prettier = require("prettier"); |
| 5 | +const publicFiles = [ |
| 6 | + "amplitude-client.js", |
| 7 | + "amplitude.js", |
| 8 | + "identify.js", |
| 9 | + "revenue.js", |
| 10 | +]; |
| 11 | +const srcDir = path.join(__dirname, "../", "src"); |
| 12 | +const outputDir = path.join(__dirname, "docs"); |
| 13 | +function generateMarkdown(inputFile) { |
| 14 | + const inputFilePath = path.join(srcDir, inputFile); |
| 15 | + const data = jsdoc2md.getTemplateDataSync({ files: inputFilePath }); |
| 16 | + const className = data.find((e) => e.kind === "class").name; |
| 17 | + const filteredData = data.filter( |
| 18 | + (e) => |
| 19 | + e.kind === "constructor" || |
| 20 | + (e.access === "public" && (e.kind === "function" || e.kind === "member")) |
| 21 | + ); |
| 22 | + const outputFilePath = path.join(outputDir, `${className}.md`); |
| 23 | + |
| 24 | + const markdownOutput = filteredData |
| 25 | + .map((item) => documentItem(item)) |
| 26 | + .join("\n"); |
| 27 | + fs.writeFileSync( |
| 28 | + path.join(outputDir, `${className}.md`), |
| 29 | + prettier.format(markdownOutput, { parser: "markdown" }) |
| 30 | + ); |
| 31 | +} |
| 32 | + |
| 33 | +function documentItem(data) { |
| 34 | + return `## \`${data.id}\` |
| 35 | +
|
| 36 | +${data.examples ? documentExamples(data) : ""} |
| 37 | +
|
| 38 | +${data.description || ""} |
| 39 | +
|
| 40 | +${data.params ? documentParams(data) : ""} |
| 41 | +
|
| 42 | +${data.returns ? documentReturn(data) : ""} |
| 43 | +`; |
| 44 | +} |
| 45 | + |
| 46 | +function documentExamples(data) { |
| 47 | + return `\`\`\` |
| 48 | +${data.examples} |
| 49 | +\`\`\` |
| 50 | +`; |
| 51 | +} |
| 52 | + |
| 53 | +function documentParams(data) { |
| 54 | + const params = data.params.map( |
| 55 | + (param) => `- \`${param.name}\` (\`${param.type.names[0]}\`) |
| 56 | +${param.description} |
| 57 | +` |
| 58 | + ); |
| 59 | + return `### Parameters |
| 60 | +${params.join("\n")} |
| 61 | +`; |
| 62 | +} |
| 63 | + |
| 64 | +function documentReturn(data) { |
| 65 | + return `### Return Value |
| 66 | +- (\`${data.returns[0].type.names[0]}\`) |
| 67 | +${data.returns[0].description} |
| 68 | +`; |
| 69 | +} |
| 70 | + |
| 71 | +if (!fs.existsSync(outputDir)) { |
| 72 | + fs.mkdirSync(outputDir); |
| 73 | +} |
| 74 | + |
| 75 | +for (const file of publicFiles) { |
| 76 | + generateMarkdown(file); |
| 77 | +} |
0 commit comments