Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: TypeStrong/typedoc
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.23.24
Choose a base ref
...
head repository: TypeStrong/typedoc
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v0.23.25
Choose a head ref
  • 15 commits
  • 43 files changed
  • 5 contributors

Commits on Feb 4, 2023

  1. Specify all relevant config options for the example 

    Resolves #2144
    @Gerrit0
    Gerrit0 authored Feb 4, 2023

    Unverified

    This user has not yet uploaded their public signing key.
    GPG key ID: F3510FE5691629A1
    Learn about vigilant mode
    Copy the full SHA
    3fdd326 View commit details

Commits on Feb 6, 2023

  1. Update typedoc.json

    @Gerrit0
    Gerrit0 authored Feb 6, 2023

    Unverified

    This user has not yet uploaded their public signing key.
    GPG key ID: F3510FE5691629A1
    Learn about vigilant mode
    Copy the full SHA
    1db399f View commit details

Commits on Feb 8, 2023

  1. fix(fs): glob will traverse node_modules if asked to 

    If the `pattern` passed to `glob()` contains `node_modules`, then `node_modules` will be traversed.

This is _naive_ in that it does not care about the _context_ of `node_modules` in the pattern; it could be a negation, or whatever (e.g., some passes `!**/node_modules/**`).  However, `minimatch` should still do its thing, so hopefully this won't be too bad.
    @boneskull
    boneskull committed Feb 8, 2023
    Copy the full SHA
    0e2aa61 View commit details

Commits on Feb 9, 2023

  1. removing outdated comment.

    @swordensen
    swordensen authored Feb 9, 2023
    Copy the full SHA
    a9cf691 View commit details

Commits on Feb 10, 2023

  1. Merge pull request #2167 from Mikkal24/master 

    removing outdated comment.
    @Gerrit0
    Gerrit0 authored Feb 10, 2023
    Copy the full SHA
    2d02bf6 View commit details

  2. Merge pull request #2164 from boneskull/boneskull/issue2151 

    fix(fs): glob will traverse node_modules if asked to
    @Gerrit0
    Gerrit0 authored Feb 10, 2023
    Copy the full SHA
    2953f9c View commit details

  3. feat: better config file defaults (#2168) 

    * feat: better config file defaults
    @Zamiell
    Zamiell authored Feb 10, 2023
    Copy the full SHA
    d82c01b View commit details

Commits on Feb 11, 2023

  1. Add excludeNotDocumentedKinds option 

    Resolves #2162
    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    138a52b View commit details

  2. Upgrade dependencies

    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    e021751 View commit details

  3. esbuild breaking changes

    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    f6ea91e View commit details

  4. Revert bad test change

    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    f838e11 View commit details

  5. Fix excludeNotDocumented on arrow functions 

    Resolves #2156
    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    ca5d5e6 View commit details

  6. Fix type error

    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    772fd7f View commit details

  7. Bump version to 0.23.25

    @Gerrit0
    Gerrit0 committed Feb 11, 2023
    Copy the full SHA
    c189157 View commit details

  8. Update changelog for release

    @typedoc-bot
    typedoc-bot committed Feb 11, 2023
    Copy the full SHA
    c565bc6 View commit details
Showing with 617 additions and 401 deletions.
  1. +26 −0 CHANGELOG.md
  2. +1 −0 example/typedoc.json
  3. +326 −322 package-lock.json
  4. +12 −12 package.json
  5. +17 −7 scripts/build_themes.js
  6. +1 −1 src/index.ts
  7. +1 −3 src/lib/application.ts
  8. +1 −1 src/lib/converter/comments/discovery.ts
  9. +1 −1 src/lib/converter/comments/index.ts
  10. +1 −1 src/lib/converter/comments/linkResolver.ts
  11. +1 −1 src/lib/converter/context.ts
  12. +1 −1 src/lib/converter/convert-expression.ts
  13. +3 −3 src/lib/converter/converter.ts
  14. +2 −2 src/lib/converter/factories/index-signature.ts
  15. +2 −2 src/lib/converter/factories/signature.ts
  16. +1 −1 src/lib/converter/jsdoc.ts
  17. +27 −5 src/lib/converter/plugins/CommentPlugin.ts
  18. +1 −1 src/lib/converter/plugins/ImplementsPlugin.ts
  19. +1 −1 src/lib/converter/plugins/SourcePlugin.ts
  20. +2 −2 src/lib/converter/symbols.ts
  21. +2 −2 src/lib/converter/types.ts
  22. +1 −1 src/lib/converter/utils/nodes.ts
  23. +1 −1 src/lib/converter/utils/symbols.ts
  24. +1 −1 src/lib/utils/entry-point.ts
  25. +9 −3 src/lib/utils/fs.ts
  26. +1 −1 src/lib/utils/loggers.ts
  27. +1 −0 src/lib/utils/options/declaration.ts
  28. +1 −1 src/lib/utils/options/readers/tsconfig.ts
  29. +11 −3 src/lib/utils/options/readers/typedoc.ts
  30. +62 −10 src/lib/utils/options/sources/typedoc.ts
  31. +1 −1 src/lib/utils/package-manifest.ts
  32. +7 −2 src/lib/utils/paths.ts
  33. +1 −1 src/lib/validation/exports.ts
  34. +1 −1 src/test/TestLogger.ts
  35. +28 −0 src/test/behaviorTests.ts
  36. +1 −1 src/test/comments.test.ts
  37. +1 −1 src/test/converter2.test.ts
  38. +11 −0 src/test/converter2/behavior/excludeNotDocumentedKinds.ts
  39. +6 −0 src/test/converter2/issues/gh2156.ts
  40. +14 −2 src/test/issueTests.ts
  41. +1 −1 src/test/programs.ts
  42. +26 −0 src/test/utils/fs.test.ts
  43. +1 −1 tsconfig.json
26 changes: 26 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Unreleased

## v0.23.25 (2023-02-11)

### Breaking Changes

- Upgraded Shiki, if your highlight theme was set to `material-<theme>`, the value will need to be changed to
`material-theme-<theme>`, see the [Shiki release notes](https://github.com/shikijs/shiki/blob/main/CHANGELOG.md#0130--2023-01-27).

### Features

- Added new `excludeNotDocumentedKinds` variable to control which reflection types can be removed
by the `excludeNotDocumented` option, #2162.
- Added `typedoc.jsonc`, `typedoc.config.js`, `typedoc.config.cjs`, `typedoc.cjs` to the list of files
which TypeDoc will automatically use as configuration files.

### Bug Fixes

- Entry points under `node_modules` will no longer be ignored, #2151.
- Corrected behavior of `excludeNotDocumented` on arrow function-variables, #2156.
- Added `package.json` to exports declaration.

### Thanks!

- @boneskull
- @Mikkal24
- @zamiell

## v0.23.24 (2023-01-07)

### Bug Fixes
1 change: 1 addition & 0 deletions example/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "https://typedoc.org/schema.json",
"name": "TypeDoc Example",
"entryPoints": ["./src"],
"sort": ["source-order"],
"media": "media",
Loading