Skip to content

Commit b3c856e

Browse files
cAttteGerrit0
authored andcommitted
feat: create 'pretty' option
1 parent 2103f34 commit b3c856e

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

src/lib/utils/options/declaration.ts

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ export interface TypeDocOptionMap {
5555

5656
out: string;
5757
json: string;
58+
pretty: boolean;
5859

5960
theme: string;
6061
name: string;

src/lib/utils/options/sources/typedoc.ts

+11-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
1414
options.addDeclaration({
1515
name: "tsconfig",
1616
help:
17-
"Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.",
17+
"Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.",
1818
hint: ParameterHint.File,
1919
defaultValue: process.cwd(),
2020
});
@@ -53,7 +53,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
5353
options.addDeclaration({
5454
name: "excludeInternal",
5555
help:
56-
"Prevent symbols that marked with @internal from being documented.",
56+
"Prevent symbols that are marked with @internal from being documented.",
5757
type: ParameterType.Boolean,
5858
});
5959
options.addDeclaration({
@@ -110,14 +110,21 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
110110
options.addDeclaration({
111111
name: "json",
112112
help:
113-
"Specifies the location and file name a json file describing the project is written to.",
113+
"Specifies the location and filename a JSON file describing the project is written to.",
114114
hint: ParameterHint.File,
115115
});
116+
options.addDeclaration({
117+
name: "pretty",
118+
help:
119+
"Specifies whether the output JSON should be formatted with tabs.",
120+
type: ParameterType.Boolean,
121+
defaultValue: true,
122+
});
116123

117124
options.addDeclaration({
118125
name: "theme",
119126
help:
120-
"Specify the path to the theme that should be used or 'default' or 'minimal' to use built-in themes.",
127+
"Specify the path to the theme that should be used, or 'default' or 'minimal' to use built-in themes.",
121128
type: ParameterType.String,
122129
defaultValue: "default",
123130
});

0 commit comments

Comments
 (0)