typedoc 0.28.6 → 0.28.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/dist/index.d.ts +1 -1
  2. package/dist/lib/converter/comments/blockLexer.d.ts +2 -1
  3. package/dist/lib/converter/comments/blockLexer.js +6 -5
  4. package/dist/lib/converter/comments/discovery.js +7 -1
  5. package/dist/lib/converter/comments/index.d.ts +20 -5
  6. package/dist/lib/converter/comments/index.js +26 -23
  7. package/dist/lib/converter/comments/lineLexer.js +1 -1
  8. package/dist/lib/converter/comments/linkResolver.d.ts +2 -2
  9. package/dist/lib/converter/comments/linkResolver.js +53 -10
  10. package/dist/lib/converter/comments/parser.d.ts +2 -2
  11. package/dist/lib/converter/comments/parser.js +6 -6
  12. package/dist/lib/converter/comments/rawLexer.js +1 -1
  13. package/dist/lib/converter/comments/textParser.js +93 -19
  14. package/dist/lib/converter/context.d.ts +10 -0
  15. package/dist/lib/converter/context.js +30 -10
  16. package/dist/lib/converter/converter.d.ts +3 -1
  17. package/dist/lib/converter/converter.js +6 -3
  18. package/dist/lib/converter/factories/signature.js +1 -2
  19. package/dist/lib/converter/factories/symbol-id.d.ts +1 -1
  20. package/dist/lib/converter/factories/symbol-id.js +2 -1
  21. package/dist/lib/converter/jsdoc.js +1 -2
  22. package/dist/lib/converter/plugins/CategoryPlugin.d.ts +3 -2
  23. package/dist/lib/converter/plugins/CategoryPlugin.js +15 -3
  24. package/dist/lib/converter/plugins/GroupPlugin.d.ts +2 -1
  25. package/dist/lib/converter/plugins/GroupPlugin.js +23 -9
  26. package/dist/lib/converter/plugins/ImplementsPlugin.js +49 -11
  27. package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +1 -2
  28. package/dist/lib/converter/plugins/LinkResolverPlugin.js +1 -55
  29. package/dist/lib/converter/types.js +2 -3
  30. package/dist/lib/converter/utils/repository.js +1 -1
  31. package/dist/lib/internationalization/internationalization.js +1 -1
  32. package/dist/lib/internationalization/locales/en.cjs +4 -1
  33. package/dist/lib/internationalization/locales/en.d.cts +4 -1
  34. package/dist/lib/models/Comment.js +1 -1
  35. package/dist/lib/models/ContainerReflection.d.ts +1 -0
  36. package/dist/lib/models/ContainerReflection.js +3 -0
  37. package/dist/lib/models/Reflection.d.ts +2 -0
  38. package/dist/lib/models/Reflection.js +3 -0
  39. package/dist/lib/output/themes/default/partials/moduleReflection.js +1 -1
  40. package/dist/lib/output/themes/default/partials/navigation.js +1 -1
  41. package/dist/lib/output/themes/default/templates/hierarchy.js +1 -1
  42. package/dist/lib/serialization/schema.d.ts +1 -1
  43. package/dist/lib/utils/options/declaration.d.ts +17 -9
  44. package/dist/lib/utils/options/declaration.js +52 -31
  45. package/dist/lib/utils/options/readers/arguments.js +2 -0
  46. package/dist/lib/utils/options/sources/typedoc.js +2 -5
  47. package/dist/lib/utils/options/tsdoc-defaults.d.ts +1 -1
  48. package/dist/lib/utils/options/tsdoc-defaults.js +1 -0
  49. package/dist/lib/utils/plugins.d.ts +2 -1
  50. package/dist/lib/utils/plugins.js +26 -17
  51. package/dist/lib/utils/sort.d.ts +2 -1
  52. package/dist/lib/utils/sort.js +4 -2
  53. package/dist/lib/utils-common/array.d.ts +1 -2
  54. package/dist/lib/utils-common/array.js +0 -7
  55. package/dist/lib/utils-common/jsx.elements.d.ts +1 -1
  56. package/dist/lib/utils-common/jsx.js +7 -6
  57. package/dist/lib/utils-common/map.d.ts +1 -1
  58. package/dist/lib/utils-common/path.d.ts +6 -0
  59. package/dist/lib/utils-common/validation.js +1 -1
  60. package/dist/lib/validation/links.js +0 -3
  61. package/package.json +12 -12
  62. package/static/style.css +2 -9
  63. package/tsdoc.json +4 -0
@@ -1,3 +1,4 @@
1
+ import type { Application } from "../application.js";
1
2
  /**
2
3
  * Represents a normalized path with path separators being `/`
3
4
  * On Windows, drives are represented like `C:/Users` for consistency
@@ -15,6 +16,11 @@ export type NormalizedPath = "" | "/" | string & {
15
16
  export type NormalizedPathOrModule = NormalizedPath | string & {
16
17
  readonly __normPathOrModule: unique symbol;
17
18
  };
19
+ /**
20
+ * Represents either a {@link NormalizedPath} or a Node module name
21
+ * (e.g. `typedoc-plugin-mdn-links` or `@gerrit0/typedoc-plugin`)
22
+ */
23
+ export type NormalizedPathOrModuleOrFunction = NormalizedPathOrModule | ((app: Application) => Promise<void> | void);
18
24
  /**
19
25
  * Represents a glob path configured by a user.
20
26
  */
@@ -46,5 +46,5 @@ export function optional(x) {
46
46
  return { [opt]: x };
47
47
  }
48
48
  export function isTagString(x) {
49
- return typeof x === "string" && /^@[a-zA-Z][a-zA-Z0-9]*$/.test(x);
49
+ return typeof x === "string" && /^@[a-z][a-z0-9-]*$/i.test(x);
50
50
  }
@@ -25,9 +25,6 @@ export function validateLinks(project, logger) {
25
25
  for (const id in project.reflections) {
26
26
  checkReflection(project.reflections[id], logger);
27
27
  }
28
- if (!(project.id in project.reflections)) {
29
- checkReflection(project, logger);
30
- }
31
28
  }
32
29
  function checkReflection(reflection, logger) {
33
30
  if (reflection.isProject() || reflection.isDeclaration()) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "typedoc",
3
3
  "description": "Create api documentation for TypeScript projects.",
4
- "version": "0.28.6",
4
+ "version": "0.28.8",
5
5
  "homepage": "https://typedoc.org",
6
6
  "type": "module",
7
7
  "exports": {
@@ -31,32 +31,32 @@
31
31
  "pnpm": ">= 10"
32
32
  },
33
33
  "dependencies": {
34
- "@gerrit0/mini-shiki": "^3.2.2",
34
+ "@gerrit0/mini-shiki": "^3.7.0",
35
35
  "lunr": "^2.3.9",
36
36
  "markdown-it": "^14.1.0",
37
37
  "minimatch": "^9.0.5",
38
- "yaml": "^2.7.1"
38
+ "yaml": "^2.8.0"
39
39
  },
40
40
  "peerDependencies": {
41
41
  "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x"
42
42
  },
43
43
  "devDependencies": {
44
- "@eslint/js": "^9.24.0",
44
+ "@eslint/js": "^9.30.0",
45
45
  "@types/lunr": "^2.3.7",
46
46
  "@types/markdown-it": "^14.1.2",
47
47
  "@types/mocha": "^10.0.10",
48
48
  "@types/node": "18",
49
49
  "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
50
50
  "c8": "^10.1.3",
51
- "dprint": "^0.49.1",
52
- "esbuild": "^0.25.2",
53
- "eslint": "^9.24.0",
54
- "mocha": "^11.1.0",
55
- "puppeteer": "^24.6.0",
56
- "semver": "^7.7.1",
57
- "tsx": "^4.19.3",
51
+ "dprint": "^0.50.0",
52
+ "esbuild": "^0.25.5",
53
+ "eslint": "^9.30.0",
54
+ "mocha": "^11.7.1",
55
+ "puppeteer": "^24.11.1",
56
+ "semver": "^7.7.2",
57
+ "tsx": "^4.20.3",
58
58
  "typescript": "5.8.3",
59
- "typescript-eslint": "^8.29.0"
59
+ "typescript-eslint": "^8.35.0"
60
60
  },
61
61
  "files": [
62
62
  "/bin",
package/static/style.css CHANGED
@@ -504,15 +504,8 @@
504
504
  body {
505
505
  background: var(--color-background);
506
506
  font-family:
507
- -apple-system,
508
- BlinkMacSystemFont,
509
- "Segoe UI",
510
- "Noto Sans",
511
- Helvetica,
512
- Arial,
513
- sans-serif,
514
- "Apple Color Emoji",
515
- "Segoe UI Emoji";
507
+ -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
508
+ Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
516
509
  font-size: 16px;
517
510
  color: var(--color-text);
518
511
  margin: 0;
package/tsdoc.json CHANGED
@@ -237,6 +237,10 @@
237
237
  {
238
238
  "tagName": "@useDeclaredType",
239
239
  "syntaxKind": "modifier"
240
+ },
241
+ {
242
+ "tagName": "@sortStrategy",
243
+ "syntaxKind": "block"
240
244
  }
241
245
  ]
242
246
  }