Skip to content

Commit 4fe784e

Browse files
octogonzoctogonz
committed
Remove "./" from paths other than "extends", and use a trailing "/" to indicate folder paths
1 parent 3edcd88 commit 4fe784e

3 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎apps/api-extractor/src/schemas/api-extractor-defaults.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@
99
"apiReport": {
1010
// ("enabled" is required)
1111
"reportFileName": "<unscopedPackageName>.api.md",
12-
"reportFolder": "./etc",
13-
"tempFolder": "./temp"
12+
"reportFolder": "etc/",
13+
"tempFolder": "temp/"
1414
},
1515

1616
"docModel": {
1717
// ("enabled" is required)
18-
"apiJsonFilePath": "./temp/<unscopedPackageName>.api.json"
18+
"apiJsonFilePath": "temp/<unscopedPackageName>.api.json"
1919
},
2020

2121
"dtsRollup": {
2222
// ("enabled" is required)
2323

24-
"untrimmedFilePath": "./dist/<unscopedPackageName>.d.ts",
24+
"untrimmedFilePath": "dist/<unscopedPackageName>.d.ts",
2525
"betaTrimmedFilePath": "",
2626
"publicTrimmedFilePath": ""
2727
},

‎apps/api-extractor/src/schemas/api-extractor-template.json‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* Optionally specifies another JSON config file that this file extends from. This provides a way for
99
* standard settings to be shared across multiple projects.
1010
*
11-
* If the path starts with "." or "..", the path is resolved relative to the folder of the file with
11+
* If the path starts with "./" or "../", the path is resolved relative to the folder of the file with
1212
* the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be
1313
* resolved using NodeJS require().
1414
*
@@ -24,7 +24,7 @@
2424
* The file extension must be ".d.ts" and not ".ts".
2525
* The path is resolved relative to the "rootFolder" location described below.
2626
*/
27-
"mainEntryPointFile": "./lib/index.d.ts",
27+
"mainEntryPointFile": "lib/index.d.ts",
2828

2929
/**
3030
* Determines how the TypeScript compiler engine will be invoked by API Extractor.
@@ -98,9 +98,9 @@
9898
*
9999
* The path is resolved relative to the "rootFolder" location.
100100
*
101-
* DEFAULT VALUE: "./etc"
101+
* DEFAULT VALUE: "etc/"
102102
*/
103-
// "reportFolder": "./etc",
103+
// "reportFolder": "etc/",
104104

105105
/**
106106
* Specifies the folder where the temporary report file is written. The file name portion is determined by
@@ -111,9 +111,9 @@
111111
*
112112
* The path is resolved relative to the "rootFolder" location.
113113
*
114-
* DEFAULT VALUE: "./temp"
114+
* DEFAULT VALUE: "temp/"
115115
*/
116-
// "tempFolder": "./temp"
116+
// "tempFolder": "temp/"
117117
},
118118

119119
/**
@@ -130,9 +130,9 @@
130130
*
131131
* The path is resolved relative to the "rootFolder" location.
132132
*
133-
* DEFAULT VALUE: "./temp/<unscopedPackageName>.api.json"
133+
* DEFAULT VALUE: "temp/<unscopedPackageName>.api.json"
134134
*/
135-
// "apiJsonFilePath": "./temp/<unscopedPackageName>.api.json"
135+
// "apiJsonFilePath": "temp/<unscopedPackageName>.api.json"
136136
},
137137

138138
/**
@@ -152,9 +152,9 @@
152152
*
153153
* The path is resolved relative to the "rootFolder" location.
154154
*
155-
* DEFAULT VALUE: "./dist/<unscopedPackageName>.d.ts"
155+
* DEFAULT VALUE: "dist/<unscopedPackageName>.d.ts"
156156
*/
157-
// "untrimmedFilePath": "./dist/<unscopedPackageName>.d.ts",
157+
// "untrimmedFilePath": "dist/<unscopedPackageName>.d.ts",
158158

159159
/**
160160
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
@@ -166,7 +166,7 @@
166166
*
167167
* DEFAULT VALUE: ""
168168
*/
169-
// "betaTrimmedFilePath": "./dist/<unscopedPackageName>-beta.d.ts",
169+
// "betaTrimmedFilePath": "dist/<unscopedPackageName>-beta.d.ts",
170170

171171

172172
/**
@@ -179,7 +179,7 @@
179179
*
180180
* DEFAULT VALUE: ""
181181
*/
182-
// "publicTrimmedFilePath": "./dist/<unscopedPackageName>-public.d.ts",
182+
// "publicTrimmedFilePath": "dist/<unscopedPackageName>-public.d.ts",
183183
},
184184

185185
/**
@@ -198,11 +198,11 @@
198198
*
199199
* The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
200200
* "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup
201-
* falls back to "./tsdoc-metadata.json".
201+
* falls back to "tsdoc-metadata.json" in the package folder.
202202
*
203203
* DEFAULT VALUE: "<lookup>"
204204
*/
205-
// "tsdocMetadataFilePath": "./dist/tsdoc-metadata.json"
205+
// "tsdocMetadataFilePath": "dist/tsdoc-metadata.json"
206206
},
207207

208208
/**

‎apps/api-extractor/src/schemas/api-extractor.schema.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
"type": "boolean"
119119
},
120120
"tsdocMetadataFilePath": {
121-
"description": "Specifies where the TSDoc metadata file should be written. The default value is \"<lookup>\", which causes the path to be automatically inferred from the \"tsdocMetadata\", \"typings\" or \"main\" fields of the project's package.json. If none of these fields are set, the lookup falls back to \"./tsdoc-metadata.json\".",
121+
"description": "Specifies where the TSDoc metadata file should be written. The default value is \"<lookup>\", which causes the path to be automatically inferred from the \"tsdocMetadata\", \"typings\" or \"main\" fields of the project's package.json. If none of these fields are set, the lookup falls back to \"tsdoc-metadata.json\" in the package folder.",
122122
"type": "string"
123123
},
124124
},

0 commit comments

Comments
 (0)