Skip to content

Fix JSDoc 4.x peer dependency conflict using .npmrc #5316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Fix JSDoc 4.x peer dependency conflict using .npmrc #5316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c51fb6
Initial plan
Copilot Nov 18, 2025
96c7fc1
Replace tsd-jsdoc with TypeScript compiler for type generation
Copilot Nov 18, 2025
1719306
Changes before error encountered
Copilot Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,10 @@ package-lock.json
yarn.lock
/.vs
typings/types.d.ts
typings/promiseBasedTypes.d.ts
typings/promiseBasedTypes.d.ts
# Ignore generated .d.ts files (but keep hand-written ones)
typings/docs/
typings/lib/
typings/translations/*.d.ts
!typings/translations/index.d.ts
!typings/translations/utils.d.ts
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,6 @@
"ts-morph": "27.0.2",
"ts-node": "10.9.2",
"tsd": "^0.33.0",
"tsd-jsdoc": "2.5.0",
"tsx": "^4.19.2",
"typedoc": "0.28.13",
"typedoc-plugin-markdown": "4.9.0",
Expand Down
11 changes: 5 additions & 6 deletions runok.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,11 @@ module.exports = {
},

async defTypings() {
console.log('Generate TypeScript definition')
// Generate definitions for promised-based helper methods
await npx('jsdoc -c typings/jsdocPromiseBased.conf.json')
fs.renameSync('typings/types.d.ts', 'typings/promiseBasedTypes.d.ts')
// Generate all other regular definitions
await npx('jsdoc -c typings/jsdoc.conf.json')
console.log('Generate TypeScript definitions using TypeScript compiler')
// Generate type definitions using TypeScript compiler (replaces tsd-jsdoc)
// First generate promise-based helper types, then regular types
await npx('node typings/generate-dts.mjs tsconfig.typings.json --promise-based')
await npx('node typings/generate-dts.mjs tsconfig.typings.json')
},

async docsPlugins() {
Expand Down
Loading