daenamnu/discordeno
1
0
Fork 0
mirror of https://github.com/discordeno/discordeno.git synced 2026-05-21 02:40:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: cleanup docs more

Browse Source
This commit is contained in:
Skillz
2023-02-24 23:54:01 -06:00
parent bd3a9d60c1
commit 63a0b381bc
12 changed files with 86 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
scripts/finalizeTypedocs.js Normal file
View File

@@ -0,0 +1,40 @@
import fs from 'node:fs'
import path from 'node:path'
// these two paths may vary depending on where you place this script, and your project structure including where typedoc generates its output files.
const typedocOutPath = await import('../typedoc.json', {
assert: { type: 'json' },
}).then((module) => module.default.out)
async function* walk(dir) {
for await (const d of await fs.promises.opendir(dir)) {
const entry = path.join(dir, d.name)
if (d.isDirectory()) yield* walk(entry)
else if (d.isFile()) yield entry
}
}
for await (let filepath of walk(typedocOutPath)) {
let file = fs.readFileSync(filepath, 'utf-8')
// add all the words we need to replace here for invalid jsx errors
const words = ['internal']
for (const word of words) {
file = file.replace(new RegExp(`<${word}>`, 'gi'), word)
}
// Converts ugly names to clean names for example discordeno_types.ActionRow becomes ActionRow
const cleanForms = [{ ugly: 'discordeno_types.' }, { ugly: "discordeno_utils."}]
for (const form of cleanForms) {
// Clean the file of the ugly forms
file = file.replace(new RegExp(form.ugly, 'gi'), form.clean || '')
const lastIndex = filepath.lastIndexOf("/")
// Clean the file name of the ugly forms
filepath = filepath.replace(new RegExp(form.ugly, 'gi'), form.clean || '')
}
fs.writeFileSync(filepath, file, function (err, result) {
if (err) throw err
})
}

28
scripts/stripInternalInTypedocs.js
View File

@@ -1,28 +0,0 @@
import fs from 'node:fs'
import path from 'node:path'
// these two paths may vary depending on where you place this script, and your project structure including where typedoc generates its output files.
const typedocOutPath = await import('../typedoc.json', {
assert: { type: 'json' },
}).then((module) => module.default.out)
async function* walk(dir) {
for await (const d of await fs.promises.opendir(dir)) {
const entry = path.join(dir, d.name);
if (d.isDirectory()) yield* walk(entry);
else if (d.isFile()) yield entry;
}
}
for await (const filepath of walk(typedocOutPath)) {
let file = fs.readFileSync(filepath, 'utf-8')
// add all the words we need to replace here for invalid jsx errors
const words = ["internal"];
for (const word of words) {
file = file.replace(new RegExp(`<${word}>`, 'gi'), word);
}
fs.writeFileSync(filepath, file, function (err, result) { if (err) throw err });
}