just-scripts 1.5.8 → 1.6.0
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.
- package/CHANGELOG.json +16 -1
- package/CHANGELOG.md +10 -2
- package/lib/tasks/apiExtractorTask.d.ts +5 -0
- package/lib/tasks/apiExtractorTask.d.ts.map +1 -1
- package/lib/tasks/apiExtractorTask.js +11 -1
- package/lib/tasks/apiExtractorTask.js.map +1 -1
- package/package.json +1 -1
- package/src/tasks/apiExtractorTask.ts +16 -1
package/CHANGELOG.json
CHANGED
|
@@ -2,7 +2,22 @@
|
|
|
2
2
|
"name": "just-scripts",
|
|
3
3
|
"entries": [
|
|
4
4
|
{
|
|
5
|
-
"date": "
|
|
5
|
+
"date": "Mon, 13 Dec 2021 23:44:44 GMT",
|
|
6
|
+
"tag": "just-scripts_v1.6.0",
|
|
7
|
+
"version": "1.6.0",
|
|
8
|
+
"comments": {
|
|
9
|
+
"minor": [
|
|
10
|
+
{
|
|
11
|
+
"author": "elcraig@microsoft.com",
|
|
12
|
+
"package": "just-scripts",
|
|
13
|
+
"comment": "Add option to modify API Extractor config before executing",
|
|
14
|
+
"commit": "9516c2f691ace70bfc1f12c863238295764a63e8"
|
|
15
|
+
}
|
|
16
|
+
]
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"date": "Fri, 10 Sep 2021 23:58:46 GMT",
|
|
6
21
|
"tag": "just-scripts_v1.5.8",
|
|
7
22
|
"version": "1.5.8",
|
|
8
23
|
"comments": {
|
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
# Change Log - just-scripts
|
|
2
2
|
|
|
3
|
-
This log was last generated on
|
|
3
|
+
This log was last generated on Mon, 13 Dec 2021 23:44:44 GMT and should not be manually modified.
|
|
4
4
|
|
|
5
5
|
<!-- Start content -->
|
|
6
6
|
|
|
7
|
+
## 1.6.0
|
|
8
|
+
|
|
9
|
+
Mon, 13 Dec 2021 23:44:44 GMT
|
|
10
|
+
|
|
11
|
+
### Minor changes
|
|
12
|
+
|
|
13
|
+
- Add option to modify API Extractor config before executing (elcraig@microsoft.com)
|
|
14
|
+
|
|
7
15
|
## 1.5.8
|
|
8
16
|
|
|
9
|
-
Fri, 10 Sep 2021 23:58:
|
|
17
|
+
Fri, 10 Sep 2021 23:58:46 GMT
|
|
10
18
|
|
|
11
19
|
### Patches
|
|
12
20
|
|
|
@@ -18,6 +18,11 @@ export interface ApiExtractorOptions extends ApiExtractorTypes.IExtractorInvokeO
|
|
|
18
18
|
* @param extractorOptions - Options with which api-extractor was invoked. Actual type is `IExtractorInvokeOptions`.
|
|
19
19
|
*/
|
|
20
20
|
onResult?: (result: any, extractorOptions: any) => void;
|
|
21
|
+
/**
|
|
22
|
+
* Callback after the config file is loaded.
|
|
23
|
+
* Provides the opportunity to modify the config before running API Extractor.
|
|
24
|
+
*/
|
|
25
|
+
onConfigLoaded?: (config: ApiExtractorTypes.IConfigFile) => void;
|
|
21
26
|
}
|
|
22
27
|
declare type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
|
|
23
28
|
export declare function apiExtractorVerifyTask(options: ApiExtractorOptions): TaskFunction;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apiExtractorTask.d.ts","sourceRoot":"","sources":["../../src/tasks/apiExtractorTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,WAAW,CAAC;AAIjD,OAAO,KAAK,iBAAiB,MAAM,qBAAqB,CAAC;AAIzD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB,CAAC,uBAAuB;IACpF,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,GAAG,KAAK,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"apiExtractorTask.d.ts","sourceRoot":"","sources":["../../src/tasks/apiExtractorTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,WAAW,CAAC;AAIjD,OAAO,KAAK,iBAAiB,MAAM,qBAAqB,CAAC;AAIzD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB,CAAC,uBAAuB;IACpF,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,GAAG,KAAK,IAAI,CAAC;IAExD;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC,WAAW,KAAK,IAAI,CAAC;CAClE;AAaD,aAAK,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEjE,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAAC;AACnF,2CAA2C;AAC3C,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,MAAM,EAC1B,gBAAgB,EAAE,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,GAChE,YAAY,CAAC;AAsBhB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAAC;AACnF,2CAA2C;AAC3C,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,MAAM,EAC1B,gBAAgB,EAAE,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,GAChE,YAAY,CAAC;AAiGhB;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE;IAAE,cAAc,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAc3H"}
|
|
@@ -64,6 +64,7 @@ exports.apiExtractorUpdateTask = apiExtractorUpdateTask;
|
|
|
64
64
|
* Returns undefined if api-extractor or the config file couldn't be found.
|
|
65
65
|
*/
|
|
66
66
|
function initApiExtractor(options) {
|
|
67
|
+
var _a;
|
|
67
68
|
const apiExtractorModule = tryRequire_1.tryRequire('@microsoft/api-extractor');
|
|
68
69
|
if (!apiExtractorModule) {
|
|
69
70
|
just_task_1.logger.warn('@microsoft/api-extractor package not detected. This task will have no effect.');
|
|
@@ -80,7 +81,16 @@ function initApiExtractor(options) {
|
|
|
80
81
|
just_task_1.logger.warn(`Config file not found for api-extractor! Please copy ${defaultConfig} to project root folder to try again`);
|
|
81
82
|
return;
|
|
82
83
|
}
|
|
83
|
-
const
|
|
84
|
+
const rawConfig = ExtractorConfig.loadFile(configJsonFilePath);
|
|
85
|
+
// Allow modification of the config
|
|
86
|
+
(_a = options.onConfigLoaded) === null || _a === void 0 ? void 0 : _a.call(options, rawConfig);
|
|
87
|
+
// This follows the logic from ExtractorConfig.loadFileAndPrepare
|
|
88
|
+
// https://github.com/microsoft/rushstack/blob/1eb3d8ccf2a87b90a1038bf464b0b73fb3c7fd78/apps/api-extractor/src/api/ExtractorConfig.ts#L455
|
|
89
|
+
const config = ExtractorConfig.prepare({
|
|
90
|
+
configObject: rawConfig,
|
|
91
|
+
configObjectFullPath: path.resolve(configJsonFilePath),
|
|
92
|
+
packageJsonFullPath: path.resolve('package.json'),
|
|
93
|
+
});
|
|
84
94
|
return { apiExtractorModule, config, extractorOptions, options };
|
|
85
95
|
}
|
|
86
96
|
function apiExtractorWrapper({ apiExtractorModule, config, extractorOptions, options, }) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apiExtractorTask.js","sourceRoot":"","sources":["../../src/tasks/apiExtractorTask.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,yCAAiD;AACjD,+BAA+B;AAC/B,6BAA6B;AAC7B,8CAA2C;
|
|
1
|
+
{"version":3,"file":"apiExtractorTask.js","sourceRoot":"","sources":["../../src/tasks/apiExtractorTask.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,yCAAiD;AACjD,+BAA+B;AAC/B,6BAA6B;AAC7B,8CAA2C;AAqD3C,SAAgB,sBAAsB,CACpC,6BAA2D,EAAE,EAC7D,mBAAoE,EAAE;IAEtE,MAAM,OAAO,GACX,OAAO,0BAA0B,KAAK,QAAQ;QAC5C,CAAC,iCAAM,gBAAgB,KAAE,kBAAkB,EAAE,0BAA0B,IACvE,CAAC,mBAAM,0BAA0B,CAAE,CAAC;IAExC,OAAO,SAAS,kBAAkB;QAChC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,OAAO,EAAE;YACX,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAExD,IAAI,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;aACrH;SACF;IACH,CAAC,CAAC;AACJ,CAAC;AAnBD,wDAmBC;AA4BD,SAAgB,sBAAsB,CACpC,6BAA2D,EAAE,EAC7D,mBAAoE,EAAE;IAEtE,MAAM,OAAO,GACX,OAAO,0BAA0B,KAAK,QAAQ;QAC5C,CAAC,iCAAM,gBAAgB,KAAE,kBAAkB,EAAE,0BAA0B,IACvE,CAAC,mBAAM,0BAA0B,CAAE,CAAC;IAExC,OAAO,SAAS,kBAAkB;QAChC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,OAAO,EAAE;YACX,IAAI,kBAAkB,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAEtD,IAAI,kBAAkB,EAAE;gBACtB,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE;oBACjC,kBAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;oBAClE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,4BAA4B;oBACxF,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;oBAElF,kBAAM,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;oBAErF,kBAAkB,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBAClD,IAAI,CAAC,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE;wBACxD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;qBAChE;yBAAM;wBACL,kBAAM,CAAC,IAAI,CAAC,8FAA8F,CAAC,CAAC;qBAC7G;iBACF;qBAAM;oBACL,kBAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;iBAChF;aACF;SACF;IACH,CAAC,CAAC;AACJ,CAAC;AAlCD,wDAkCC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,OAA4B;;IACpD,MAAM,kBAAkB,GAA6B,uBAAU,CAAC,0BAA0B,CAAC,CAAC;IAE5F,IAAI,CAAC,kBAAkB,EAAE;QACvB,kBAAM,CAAC,IAAI,CAAC,+EAA+E,CAAC,CAAC;QAC7F,OAAO;KACR;IAED,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,MAAM,EAAE;QACxC,kBAAM,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAC;QACnG,OAAO;KACR;IAED,MAAM,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAC/C,MAAM,EAAE,kBAAkB,GAAG,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,KAA0B,OAAO,EAA5B,gBAAgB,UAAK,OAAO,EAAvG,iDAA6F,CAAU,CAAC;IAE9G,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;QAC9F,kBAAM,CAAC,IAAI,CAAC,wDAAwD,aAAa,sCAAsC,CAAC,CAAC;QACzH,OAAO;KACR;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC/D,mCAAmC;IACnC,MAAA,OAAO,CAAC,cAAc,+CAAtB,OAAO,EAAkB,SAAS,EAAE;IACpC,iEAAiE;IACjE,0IAA0I;IAC1I,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;QACrC,YAAY,EAAE,SAAS;QACvB,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QACtD,mBAAmB,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;KAClD,CAAC,CAAC;IAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,CAAC;AACnE,CAAC;AAED,SAAS,mBAAmB,CAAC,EAC3B,kBAAkB,EAClB,MAAM,EACN,gBAAgB,EAChB,OAAO,GACa;IACpB,MAAM,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC;IAEzC,kBAAM,CAAC,IAAI,CAAC,uCAAuC,MAAM,CAAC,sBAAsB,GAAG,CAAC,CAAC;IACrF,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC1D,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;KAC5C;IAED,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,cAAc,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;KACxI;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,WAAmB,EAAE,cAA6D;IACnH,IAAI,OAAe,CAAC;IACpB,IAAI,cAAc,CAAC,OAAO,EAAE;QAC1B,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KAClC;SAAM,IAAI,cAAc,CAAC,cAAc,EAAE;QACxC,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC7E,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAE,CAAC,CAAC,CAAC,CAAC;KACzC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;KACxH;IACD,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzD,2FAA2F;IAC3F,0BAA0B;IAC1B,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AACzF,CAAC;AAdD,gDAcC"}
|
package/package.json
CHANGED
|
@@ -27,6 +27,12 @@ export interface ApiExtractorOptions extends ApiExtractorTypes.IExtractorInvokeO
|
|
|
27
27
|
* @param extractorOptions - Options with which api-extractor was invoked. Actual type is `IExtractorInvokeOptions`.
|
|
28
28
|
*/
|
|
29
29
|
onResult?: (result: any, extractorOptions: any) => void;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Callback after the config file is loaded.
|
|
33
|
+
* Provides the opportunity to modify the config before running API Extractor.
|
|
34
|
+
*/
|
|
35
|
+
onConfigLoaded?: (config: ApiExtractorTypes.IConfigFile) => void;
|
|
30
36
|
}
|
|
31
37
|
|
|
32
38
|
interface ApiExtractorContext {
|
|
@@ -157,7 +163,16 @@ function initApiExtractor(options: ApiExtractorOptions): ApiExtractorContext | u
|
|
|
157
163
|
return;
|
|
158
164
|
}
|
|
159
165
|
|
|
160
|
-
const
|
|
166
|
+
const rawConfig = ExtractorConfig.loadFile(configJsonFilePath);
|
|
167
|
+
// Allow modification of the config
|
|
168
|
+
options.onConfigLoaded?.(rawConfig);
|
|
169
|
+
// This follows the logic from ExtractorConfig.loadFileAndPrepare
|
|
170
|
+
// https://github.com/microsoft/rushstack/blob/1eb3d8ccf2a87b90a1038bf464b0b73fb3c7fd78/apps/api-extractor/src/api/ExtractorConfig.ts#L455
|
|
171
|
+
const config = ExtractorConfig.prepare({
|
|
172
|
+
configObject: rawConfig,
|
|
173
|
+
configObjectFullPath: path.resolve(configJsonFilePath),
|
|
174
|
+
packageJsonFullPath: path.resolve('package.json'),
|
|
175
|
+
});
|
|
161
176
|
|
|
162
177
|
return { apiExtractorModule, config, extractorOptions, options };
|
|
163
178
|
}
|