Skip to content

Commit eb5dc5f

Browse files
committed
update type doc
1 parent 3f627ca commit eb5dc5f

2 files changed

Lines changed: 10 additions & 12 deletions

File tree

scripts/get-metadata.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
'use strict';
33

44
import { execSync } from 'child_process';
5-
import packageInfo from '../package.json' with { type: 'json' };
5+
import { createRequire } from 'module';
6+
const require = createRequire(import.meta.url);
7+
const packageInfo = require('../package.json');
68
let commitHash = 'unknown';
79
try {
810
commitHash = execSync('git rev-parse HEAD').toString().trim();

scripts/typedoc.js

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ const require = createRequire(import.meta.url);
88
const fs = require('fs')
99
const TypeDoc = require('typedoc')
1010
const typescript = require('typescript')
11-
const ora = require('ora')
1211
const libJsPackage = require('../package.json')
1312

1413
const { description, version } = libJsPackage
@@ -21,20 +20,17 @@ const files = ['./src/index.ts']
2120
const config = typescript.findConfigFile('./tsconfig.js', typescript.sys.fileExists)
2221

2322
const generateJson = async () => {
24-
const spinnerTypedoc = ora('Generating TypeDoc json...').start()
23+
process.stdout.write('Generating TypeDoc json...\n')
2524

26-
// Setup our TypeDoc app
27-
const app = new TypeDoc.Application()
28-
app.options.addReader(new TypeDoc.TSConfigReader())
29-
app.options.addReader(new TypeDoc.TypeDocReader())
30-
31-
app.bootstrap({
25+
const app = await TypeDoc.Application.bootstrap({
3226
tsconfig: config,
3327
entryPoints: files
3428
})
3529

36-
const src = app.getEntryPoints()
37-
const project = app.converter.convert(src)
30+
const project = await app.convert()
31+
if (!project) {
32+
throw new Error('TypeDoc conversion failed.')
33+
}
3834

3935
// Generate the JSON file
4036
await app.generateJson(project, outPath)
@@ -54,7 +50,7 @@ const generateJson = async () => {
5450

5551
fs.writeFileSync(outPath, JSON.stringify(jsonFinal, null, 2))
5652

57-
spinnerTypedoc.succeed('Generated TypeDoc json.')
53+
process.stdout.write('Generated TypeDoc json.\n')
5854
}
5955

6056
generateJson().catch(console.error)

0 commit comments

Comments
 (0)