@skyux/docs-tools 9.0.0-alpha.0 → 9.0.0-alpha.2

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 (8) hide show
  1. package/esm2022/modules/type-definitions/type-definitions-format.service.mjs +2 -4
  2. package/esm2022/modules/type-definitions/type-definitions.service.mjs +9 -8
  3. package/esm2022/modules/type-definitions/typedoc-adapter.service.mjs +73 -34
  4. package/esm2022/modules/type-definitions/typedoc-types.mjs +34 -2
  5. package/fesm2022/skyux-docs-tools.mjs +113 -43
  6. package/fesm2022/skyux-docs-tools.mjs.map +1 -1
  7. package/modules/type-definitions/typedoc-types.d.ts +49 -12
  8. package/package.json +2 -2
package/modules/type-definitions/typedoc-types.d.ts CHANGED
@@ -1,18 +1,23 @@
1
1
  export interface TypeDocComment {
2
- shortText?: string;
3
- tags?: {
4
- param?: string;
5
- tag: 'default' | 'defaultValue' | 'deprecated' | 'example' | 'param' | 'required';
2
+ summary?: {
3
+ kind: string;
6
4
  text: string;
7
5
  }[];
8
- text?: string;
6
+ blockTags?: {
7
+ param?: string;
8
+ content?: {
9
+ kind: string;
10
+ text: string;
11
+ }[];
12
+ tag: '@default' | '@defaultValue' | '@deprecated' | '@example' | '@param' | '@required';
13
+ }[];
9
14
  }
10
15
  export interface TypeDocSource {
11
16
  fileName: string;
12
17
  }
13
18
  export interface TypeDocSignature {
14
19
  comment?: TypeDocComment;
15
- kindString?: 'Call signature' | 'Constructor signature' | 'Index signature';
20
+ kind?: TypeDocKind.CallSignature | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature;
16
21
  name: string;
17
22
  parameters?: TypeDocParameter[];
18
23
  returnType?: TypeDocType;
@@ -21,7 +26,7 @@ export interface TypeDocSignature {
21
26
  }
22
27
  export interface TypeDocTypeParameter {
23
28
  name: string;
24
- kindString: 'Type parameter';
29
+ kind: TypeDocKind.TypeParameter;
25
30
  type?: TypeDocType;
26
31
  }
27
32
  export interface TypeDocType {
@@ -48,7 +53,7 @@ export interface TypeDocType {
48
53
  export interface TypeDocParameter {
49
54
  comment?: TypeDocComment;
50
55
  defaultValue?: string;
51
- kindString: 'Parameter';
56
+ kind: TypeDocKind.Parameter;
52
57
  name: string;
53
58
  type: TypeDocType;
54
59
  flags?: {
@@ -69,19 +74,19 @@ export interface TypeDocEntryChild {
69
74
  isOptional?: boolean;
70
75
  isStatic?: boolean;
71
76
  };
72
- kindString?: 'Accessor' | 'Call signature' | 'Constructor' | 'Constructor signature' | 'Index signature' | 'Enumeration member' | 'Parameter' | 'Property' | 'Method';
77
+ kind?: TypeDocKind.Accessor | TypeDocKind.CallSignature | TypeDocKind.Constructor | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature | TypeDocKind.EnumMember | TypeDocKind.Parameter | TypeDocKind.Property | TypeDocKind.Method;
73
78
  getSignature?: {
74
79
  comment: TypeDocComment;
75
80
  name: string;
76
81
  type: TypeDocType;
77
- }[];
82
+ };
78
83
  name?: string;
79
84
  setSignature?: {
80
85
  comment: TypeDocComment;
81
86
  name: string;
82
87
  parameters?: TypeDocParameter[];
83
88
  type: TypeDocType;
84
- }[];
89
+ };
85
90
  signatures?: TypeDocSignature[];
86
91
  sources?: TypeDocSource[];
87
92
  type?: TypeDocType;
@@ -97,10 +102,42 @@ export interface TypeDocEntry {
97
102
  name: 'Component' | 'Directive' | 'Injectable' | 'NgModule' | 'Pipe';
98
103
  type: TypeDocType;
99
104
  }[];
100
- kindString?: 'Class' | 'Enumeration' | 'Interface' | 'Type alias';
105
+ kind?: TypeDocKind.Class | TypeDocKind.Enum | TypeDocKind.Interface | TypeDocKind.TypeAlias;
101
106
  indexSignature?: TypeDocSignature;
102
107
  name?: string;
103
108
  sources?: TypeDocSource[];
104
109
  type?: TypeDocType;
105
110
  typeParameter?: TypeDocTypeParameter[];
106
111
  }
112
+ /**
113
+ * This enum comes from:
114
+ * https://github.com/TypeStrong/typedoc/blob/v0.24.8/src/lib/models/reflections/kind.ts
115
+ * The enum is up to date as of version `0.24.8`.
116
+ */
117
+ export declare enum TypeDocKind {
118
+ Project = 1,
119
+ Module = 2,
120
+ Namespace = 4,
121
+ Enum = 8,
122
+ EnumMember = 16,
123
+ Variable = 32,
124
+ Function = 64,
125
+ Class = 128,
126
+ Interface = 256,
127
+ Constructor = 512,
128
+ Property = 1024,
129
+ Method = 2048,
130
+ CallSignature = 4096,
131
+ IndexSignature = 8192,
132
+ ConstructorSignature = 16384,
133
+ Parameter = 32768,
134
+ TypeLiteral = 65536,
135
+ TypeParameter = 131072,
136
+ Accessor = 262144,
137
+ GetSignature = 524288,
138
+ SetSignature = 1048576,
139
+ /** @deprecated will be removed in v0.25, not used */
140
+ ObjectLiteral = 2097152,
141
+ TypeAlias = 4194304,
142
+ Reference = 8388608
143
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/docs-tools",
3
- "version": "9.0.0-alpha.0",
3
+ "version": "9.0.0-alpha.2",
4
4
  "peerDependencies": {
5
5
  "@angular/common": "^16.1.8",
6
6
  "@angular/core": "^16.1.8",
@@ -25,7 +25,7 @@
25
25
  "@stackblitz/sdk": "1.8.0",
26
26
  "lodash.orderby": "4.6.0",
27
27
  "marked": "4.1.0",
28
- "tslib": "^2.6.1"
28
+ "tslib": "^2.6.2"
29
29
  },
30
30
  "module": "fesm2022/skyux-docs-tools.mjs",
31
31
  "typings": "index.d.ts",