Skip to content
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.

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

typedoc doesn't recognize package.json, only typedoc.json #2112

Closed
diogobaltazar opened this issue Dec 8, 2022 · 1 comment · Fixed by #2129
Closed

typedoc doesn't recognize package.json, only typedoc.json #2112

diogobaltazar opened this issue Dec 8, 2022 · 1 comment · Fixed by #2129
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Milestone

Comments

@diogobaltazar
Copy link

Search terms

Running npm run docs for an npm script docs: typedoc src/index.ts does not read properties from package.json:

{
  // ...
  "typedocOptions": {
    "entryPoints": ["src/index.ts"],
    "out": "docs/typedocs",
    "includeVersion": true
  }
}

Only from typedoc.json:

{
   "entryPoints": ["src/index.ts"],
   "out": "docs/typedocs",
   "includeVersion": true
}

Expected Behavior

read from package.json

Actual Behavior

reads only from typedoc.json

Steps to reproduce the bug

Run typedoc src/index.ts with the typedoc specs only in package.json.

Environment

  • Typedoc version: 0.23.21
  • TypeScript version: 4.9.3
  • Node.js version: v19.2.0
  • OS: Ubuntu 20.04.5 LTS (Focal Fossa)
@diogobaltazar diogobaltazar added the bug Functionality does not match expectation label Dec 8, 2022
@Gerrit0 Gerrit0 changed the title typedoc doesn't recognize tsconfig.json, only typedoc.json typedoc doesn't recognize package.json, only typedoc.json Dec 8, 2022
@Gerrit0 Gerrit0 added good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged enhancement Improved functionality and removed bug Functionality does not match expectation labels Dec 8, 2022
Gerrit0 added a commit that referenced this issue Mar 11, 2023
Also rework package.json discovery to be consistent with PackagePlugin
@Gerrit0 Gerrit0 added this to the v0.24 milestone Mar 11, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 8, 2023

Released in v0.24.0

@Gerrit0 Gerrit0 closed this as completed Apr 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants