Skip to content

Commit 96c7fc1

Browse files
committed
Replace tsd-jsdoc with TypeScript compiler for type generation
1 parent 8c51fb6 commit 96c7fc1

File tree

9 files changed

+644
-328
lines changed

9 files changed

+644
-328
lines changed

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,10 @@ package-lock.json
2626
yarn.lock
2727
/.vs
2828
typings/types.d.ts
29-
typings/promiseBasedTypes.d.ts
29+
typings/promiseBasedTypes.d.ts
30+
# Ignore generated .d.ts files (but keep hand-written ones)
31+
typings/docs/
32+
typings/lib/
33+
typings/translations/*.d.ts
34+
!typings/translations/index.d.ts
35+
!typings/translations/utils.d.ts

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,6 @@
182182
"ts-morph": "27.0.2",
183183
"ts-node": "10.9.2",
184184
"tsd": "^0.33.0",
185-
"tsd-jsdoc": "2.5.0",
186185
"tsx": "^4.19.2",
187186
"typedoc": "0.28.13",
188187
"typedoc-plugin-markdown": "4.9.0",

runok.cjs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,10 @@ module.exports = {
3535
},
3636

3737
async defTypings() {
38-
console.log('Generate TypeScript definition')
39-
// Generate definitions for promised-based helper methods
40-
await npx('jsdoc -c typings/jsdocPromiseBased.conf.json')
41-
fs.renameSync('typings/types.d.ts', 'typings/promiseBasedTypes.d.ts')
42-
// Generate all other regular definitions
43-
await npx('jsdoc -c typings/jsdoc.conf.json')
38+
console.log('Generate TypeScript definitions using TypeScript compiler')
39+
// Generate type definitions using TypeScript compiler (replaces tsd-jsdoc)
40+
// The script generates .d.ts files from JSDoc comments in JavaScript files
41+
await npx('node typings/generate-dts.mjs tsconfig.typings.json')
4442
},
4543

4644
async docsPlugins() {

0 commit comments

Comments
 (0)