Skip to content

Commit

Permalink
Reorder option declarations to match docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Apr 8, 2023
1 parent 7a696ae commit a6e6544
Showing 1 changed file with 39 additions and 35 deletions.
74 changes: 39 additions & 35 deletions src/lib/utils/options/declaration.ts
Expand Up @@ -87,13 +87,15 @@ export type TypeDocOptionValues = {
* ```
*/
export interface TypeDocOptionMap {
// Configuration
options: string;
tsconfig: string;
compilerOptions: unknown;
plugin: string[];

// Input
entryPoints: string[];
entryPointStrategy: typeof EntryPointStrategy;

exclude: string[];
externalPattern: string[];
excludeExternals: boolean;
Expand All @@ -103,80 +105,82 @@ export interface TypeDocOptionMap {
excludePrivate: boolean;
excludeProtected: boolean;
excludeReferences: boolean;
externalSymbolLinkMappings: ManuallyValidatedOption<
Record<string, Record<string, string>>
>;
media: string;
includes: string;
name: string;
includeVersion: boolean;
disableSources: boolean;
sourceLinkTemplate: string;
gitRevision: string;
gitRemote: string;
readme: string;

// Output
out: string;
json: string;
pretty: boolean;
emit: typeof EmitStrategy;
theme: string;

lightHighlightTheme: ShikiTheme;
darkHighlightTheme: ShikiTheme;
customCss: string;
markedOptions: unknown;
name: string;
includeVersion: boolean;
disableSources: boolean;
basePath: string;
excludeTags: `@${string}`[];
readme: string;
cname: string;
sourceLinkTemplate: string;
gitRevision: string;
gitRemote: string;
htmlLang: string;
githubPages: boolean;
cacheBust: boolean;
gaID: string;
hideGenerator: boolean;
cacheBust: boolean;
searchInComments: boolean;
cleanOutputDir: boolean;
titleLink: string;
navigationLinks: ManuallyValidatedOption<Record<string, string>>;
sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
visibilityFilters: ManuallyValidatedOption<{
protected?: boolean;
private?: boolean;
inherited?: boolean;
external?: boolean;
[tag: `@${string}`]: boolean;
}>;
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;

jsDocCompatibility: JsDocCompatibility;
// Comment
commentStyle: typeof CommentStyle;
useTsLinkResolution: boolean;
jsDocCompatibility: JsDocCompatibility;
blockTags: `@${string}`[];
inlineTags: `@${string}`[];
modifierTags: `@${string}`[];
excludeTags: `@${string}`[];
externalSymbolLinkMappings: ManuallyValidatedOption<
Record<string, Record<string, string>>
>;
media: string;
includes: string;

// Organization
categorizeByGroup: boolean;
defaultCategory: string;
categoryOrder: string[];
sort: SortStrategy[];
kindSortOrder: ReflectionKind.KindString[];
visibilityFilters: ManuallyValidatedOption<{
protected?: boolean;
private?: boolean;
inherited?: boolean;
external?: boolean;
[tag: `@${string}`]: boolean;
}>;
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;

watch: boolean;
preserveWatchOutput: boolean;
skipErrorChecking: boolean;
help: boolean;
version: boolean;
showConfig: boolean;
plugin: string[];
logLevel: typeof LogLevel;

// Validation
treatWarningsAsErrors: boolean;
treatValidationWarningsAsErrors: boolean;
intentionallyNotExported: string[];
validation: ValidationOptions;
requiredToBeDocumented: ReflectionKind.KindString[];

// Other
watch: boolean;
preserveWatchOutput: boolean;
help: boolean;
version: boolean;
showConfig: boolean;
logLevel: typeof LogLevel;
skipErrorChecking: boolean;
}

/**
Expand Down

0 comments on commit a6e6544

Please sign in to comment.