-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DEX-413 feat: added SDK references generation code
- Loading branch information
1 parent
eab834e
commit b97f39f
Showing
6 changed files
with
390 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
| function getModuleName(filePath) { | ||
| const parsedPath = path.parse(filePath); | ||
| let moduleName = parsedPath.name; | ||
|
|
||
| if (moduleName.endsWith('.default')) { | ||
| moduleName = moduleName.slice(0, -8); | ||
| } | ||
|
|
||
| return moduleName; | ||
| } | ||
|
|
||
| const directoryPath = path.join(__dirname, './docs/classes'); | ||
|
|
||
| fs.readdir(directoryPath, (err, files) => { | ||
| if (err) { | ||
| console.error(`Error reading directory: ${err}`); | ||
| return; | ||
| } | ||
| files.forEach(file => { | ||
| if (path.extname(file) === '.md') { | ||
| const filePath = path.join(directoryPath, file); | ||
| fs.readFile(filePath, 'utf8', (err, data) => { | ||
| if (err) { | ||
| console.error(`Error reading file: ${err}`); | ||
| return; | ||
| } | ||
| const lines = data.split('\n'); | ||
| lines[0] = `# Class: ${getModuleName(path.parse(file).name)}`; | ||
| const updatedContent = lines.join('\n'); | ||
| fs.writeFile(filePath, updatedContent, err => { | ||
| if (err) { | ||
| console.error(`Error writing file: ${err}`); | ||
| } else { | ||
| console.log(`Updated file: ${filePath}`); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| import { readdirSync, readFileSync, statSync, writeFileSync } from "fs"; | ||
| import path from "path"; | ||
|
|
||
| function removeListCharacters(markdown: string): string { | ||
| // Match list items with bullets, numbered lists, or other list-type characters | ||
| // const listRegex = /^(\s*[\*\-\+\•\▸]\s*|\s*\d+\.\s*|\s*\w\.\s*)/; | ||
| const listRegex = /^(\s*[\*\-\+\•\▸]\s|^\s*\d+\.\s|^\s*\w\.\s)/; | ||
|
|
||
| // Split the Markdown file into lines | ||
| const lines = markdown.split('\n'); | ||
|
|
||
| // Track whether a list is currently in progress | ||
| let inList = false; | ||
|
|
||
| // Iterate through each line and remove list characters if necessary | ||
| for (let i = 0; i < lines.length; i++) { | ||
| const line = lines[i]; | ||
| const match = line.match(listRegex); | ||
|
|
||
| if (match) { | ||
| // Check if the list is continuing or if it's a new list | ||
| if (!inList && !lines[i+1].match(listRegex)) { | ||
| // Remove list characters | ||
| lines[i] = line.replace(listRegex, ''); | ||
| } | ||
| inList = true; | ||
| } else { | ||
| inList = false; | ||
| } | ||
| } | ||
|
|
||
| // Join the lines back into a single string | ||
| const result = lines.join('\n'); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| function processUrls(markdown: string, itemPath: string): string { | ||
| // remove extension .md from urls | ||
| const linkRegex = /\[([^\]]+)\]\(([^)]+)\)/g; | ||
| const editedMarkdown = markdown.replace(linkRegex, (match, text, url) => { | ||
| if(url.split('.').pop().startsWith('md')) | ||
| { | ||
| const hash = url.split('.').pop().replace('md', '') | ||
| let editedUrl = (url.split('.').slice(0, -1)).join('.')+hash; | ||
| if(editedUrl.startsWith('../') && editedUrl.split('/').length > 1) | ||
| { | ||
| editedUrl = `/sdks/skyflow-node/${editedUrl.split('/').slice(1).join('/')}`; | ||
| } | ||
| else | ||
| { | ||
| editedUrl = `/sdks/skyflow-node/${itemPath.split('/')[1]}/${editedUrl}`; | ||
| } | ||
| return `[${text}](${editedUrl})`; | ||
| } | ||
| return `[${text}](${url})`; | ||
| }); | ||
| return editedMarkdown; | ||
| } | ||
|
|
||
| function createEnumerationTable(markdown) { | ||
| const enumMembersRegex = /### (.+)[\s\S]*?\*\*(.+)\*\* = `(.+)`/g; | ||
| const matches = [...markdown.matchAll(enumMembersRegex)]; | ||
| const lines = markdown.split('\n'); | ||
|
|
||
| if (matches.length === 0) { | ||
| return ''; // No enumeration members found | ||
| } | ||
|
|
||
| const index = lines.indexOf('## Enumeration Members') | ||
|
|
||
| let editedMarkdown = `${lines.slice(0, index+1). join('\n')}\n\n| Member | Value |\n| --- | --- |`; | ||
|
|
||
| for (const match of matches) { | ||
| const member = match[1]; | ||
| const value = match[3]; | ||
| editedMarkdown += `\n| ${member} | ${value} |` | ||
| } | ||
| editedMarkdown += '\n'; | ||
| return editedMarkdown; | ||
| } | ||
|
|
||
|
|
||
| function processMarkdown(markdown: string, isEnum: boolean, itemPath: string): string { | ||
| const processLists = removeListCharacters(markdown); | ||
|
|
||
| const editUrls = processUrls(processLists, itemPath); | ||
|
|
||
| let processedMarkdown = editUrls; | ||
|
|
||
| if(isEnum) | ||
| { | ||
| const processEnums = createEnumerationTable(editUrls); | ||
| processedMarkdown = processEnums; | ||
| } | ||
|
|
||
| return processedMarkdown; | ||
| } | ||
|
|
||
| // Example usage | ||
| // const markdown = `# Class: Skyflow | ||
| // ... | ||
| // ### init | ||
| // * \`Static\` **init**(\`config\`): [\`default\`](Skyflow.default.md) | ||
|
|
||
| // * \`Static\` **init**(\`config\`): [\`IGetByIdInput\`](../interfaces/utils_common.IGetByIdInput.md) | ||
|
|
||
| // * \`Static\` **init**(\`config\`): [\`IGetByIdInput\`](../interfaces/utils_common.IGetByIdInput.txt) | ||
| // * \`Static\` **init**(\`config\`): [\`IGetByIdInput\`](../interfaces/utils_common.IGetByIdInput) | ||
| // ... | ||
| // `; | ||
|
|
||
| function readFolderStructure(folderPath: string, isEnum: boolean) { | ||
| const folderContents = readdirSync(folderPath); | ||
| folderContents.forEach((item) => { | ||
| const itemPath = path.join(folderPath, item); | ||
| const isDirectory = statSync(itemPath).isDirectory(); | ||
|
|
||
| if (isDirectory) { | ||
| if(item == 'enums') { | ||
| readFolderStructure(itemPath, true); | ||
| } | ||
| else{ | ||
| readFolderStructure(itemPath, false); | ||
| } | ||
| } else { | ||
| const markdown = readFileSync(itemPath, 'utf8'); | ||
| const transformedMarkdown = processMarkdown(markdown, isEnum, itemPath); | ||
| const flaggedMarkdown = '{% env enable="nodeJsSdkRef" %}\n\n' + transformedMarkdown + '\n{% /env %}' | ||
| writeFileSync(itemPath, flaggedMarkdown, 'utf-8'); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| const folderPath = './docs/'; | ||
| readFolderStructure(folderPath, false); | ||
| // const transformedMarkdown = processMarkdown(markdown, true); | ||
| // console.log(transformedMarkdown); | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.