Skip to content

Commit a6e6544

Browse files
committed
Reorder option declarations to match docs
1 parent 7a696ae commit a6e6544

File tree

1 file changed

+39
-35
lines changed

1 file changed

+39
-35
lines changed

src/lib/utils/options/declaration.ts

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,15 @@ export type TypeDocOptionValues = {
8787
* ```
8888
*/
8989
export interface TypeDocOptionMap {
90+
// Configuration
9091
options: string;
9192
tsconfig: string;
9293
compilerOptions: unknown;
94+
plugin: string[];
9395

96+
// Input
9497
entryPoints: string[];
9598
entryPointStrategy: typeof EntryPointStrategy;
96-
9799
exclude: string[];
98100
externalPattern: string[];
99101
excludeExternals: boolean;
@@ -103,80 +105,82 @@ export interface TypeDocOptionMap {
103105
excludePrivate: boolean;
104106
excludeProtected: boolean;
105107
excludeReferences: boolean;
106-
externalSymbolLinkMappings: ManuallyValidatedOption<
107-
Record<string, Record<string, string>>
108-
>;
109-
media: string;
110-
includes: string;
108+
name: string;
109+
includeVersion: boolean;
110+
disableSources: boolean;
111+
sourceLinkTemplate: string;
112+
gitRevision: string;
113+
gitRemote: string;
114+
readme: string;
111115

116+
// Output
112117
out: string;
113118
json: string;
114119
pretty: boolean;
115120
emit: typeof EmitStrategy;
116121
theme: string;
117-
118122
lightHighlightTheme: ShikiTheme;
119123
darkHighlightTheme: ShikiTheme;
120124
customCss: string;
121125
markedOptions: unknown;
122-
name: string;
123-
includeVersion: boolean;
124-
disableSources: boolean;
125126
basePath: string;
126-
excludeTags: `@${string}`[];
127-
readme: string;
128127
cname: string;
129-
sourceLinkTemplate: string;
130-
gitRevision: string;
131-
gitRemote: string;
132128
htmlLang: string;
133129
githubPages: boolean;
130+
cacheBust: boolean;
134131
gaID: string;
135132
hideGenerator: boolean;
136-
cacheBust: boolean;
137133
searchInComments: boolean;
138134
cleanOutputDir: boolean;
139135
titleLink: string;
140136
navigationLinks: ManuallyValidatedOption<Record<string, string>>;
141137
sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
138+
visibilityFilters: ManuallyValidatedOption<{
139+
protected?: boolean;
140+
private?: boolean;
141+
inherited?: boolean;
142+
external?: boolean;
143+
[tag: `@${string}`]: boolean;
144+
}>;
145+
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
146+
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
142147

143-
jsDocCompatibility: JsDocCompatibility;
148+
// Comment
144149
commentStyle: typeof CommentStyle;
145150
useTsLinkResolution: boolean;
151+
jsDocCompatibility: JsDocCompatibility;
146152
blockTags: `@${string}`[];
147153
inlineTags: `@${string}`[];
148154
modifierTags: `@${string}`[];
155+
excludeTags: `@${string}`[];
156+
externalSymbolLinkMappings: ManuallyValidatedOption<
157+
Record<string, Record<string, string>>
158+
>;
159+
media: string;
160+
includes: string;
149161

162+
// Organization
150163
categorizeByGroup: boolean;
151164
defaultCategory: string;
152165
categoryOrder: string[];
153166
sort: SortStrategy[];
154167
kindSortOrder: ReflectionKind.KindString[];
155-
visibilityFilters: ManuallyValidatedOption<{
156-
protected?: boolean;
157-
private?: boolean;
158-
inherited?: boolean;
159-
external?: boolean;
160-
[tag: `@${string}`]: boolean;
161-
}>;
162-
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
163-
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
164-
165-
watch: boolean;
166-
preserveWatchOutput: boolean;
167-
skipErrorChecking: boolean;
168-
help: boolean;
169-
version: boolean;
170-
showConfig: boolean;
171-
plugin: string[];
172-
logLevel: typeof LogLevel;
173168

174169
// Validation
175170
treatWarningsAsErrors: boolean;
176171
treatValidationWarningsAsErrors: boolean;
177172
intentionallyNotExported: string[];
178173
validation: ValidationOptions;
179174
requiredToBeDocumented: ReflectionKind.KindString[];
175+
176+
// Other
177+
watch: boolean;
178+
preserveWatchOutput: boolean;
179+
help: boolean;
180+
version: boolean;
181+
showConfig: boolean;
182+
logLevel: typeof LogLevel;
183+
skipErrorChecking: boolean;
180184
}
181185

182186
/**

0 commit comments

Comments
 (0)