Skip to content

Commit 9e5a265

Browse files
authored
chore(api-extractor): exclude warning and add forgotten exports to report (#6352)
chore: exclude warning and add forgotten exports to report
1 parent 8ea3432 commit 9e5a265

File tree

4 files changed

+7694
-757
lines changed

4 files changed

+7694
-757
lines changed

api-extractor.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@
182182
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
183183
* DEFAULT VALUE: "<projectFolder>/temp/"
184184
*/
185-
"reportTempFolder": "<projectFolder>/temp/"
185+
"reportTempFolder": "<projectFolder>/temp/",
186186

187187
/**
188188
* Whether "forgotten exports" should be included in the API report file. Forgotten exports are declarations
@@ -191,7 +191,7 @@
191191
*
192192
* DEFAULT VALUE: "false"
193193
*/
194-
// "includeForgottenExports": false
194+
"includeForgottenExports": true
195195
},
196196

197197
/**
@@ -402,6 +402,10 @@
402402
},
403403
"ae-missing-release-tag": {
404404
"logLevel": "none"
405+
},
406+
"ae-forgotten-export": {
407+
"logLevel": "none",
408+
"addToApiReportFile": false
405409
}
406410

407411
// "ae-extra-release-tag": {

packages/rspack-dev-server/etc/api.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,54 @@ import WebpackDevServer from 'webpack-dev-server';
1616

1717
export { Configuration }
1818

19+
// @public (undocumented)
20+
interface ResolvedDevServer extends Configuration {
21+
// (undocumented)
22+
allowedHosts: "auto" | string[] | "all";
23+
// (undocumented)
24+
bonjour: false | Record<string, never> | WebpackDevServer.BonjourOptions;
25+
// (undocumented)
26+
client: WebpackDevServer.ClientConfiguration;
27+
// (undocumented)
28+
compress: boolean;
29+
// (undocumented)
30+
devMiddleware: Configuration["devMiddleware"];
31+
// (undocumented)
32+
historyApiFallback: false | WebpackDevServer.ConnectHistoryApiFallbackOptions;
33+
// (undocumented)
34+
host?: string;
35+
// (undocumented)
36+
hot: boolean | "only";
37+
// (undocumented)
38+
ipc: string | undefined;
39+
// (undocumented)
40+
liveReload: boolean;
41+
// (undocumented)
42+
magicHtml: boolean;
43+
// (undocumented)
44+
open: WebpackDevServer.Open[];
45+
// (undocumented)
46+
port: number | string;
47+
// (undocumented)
48+
proxy: WebpackDevServer.ProxyConfigArray;
49+
// (undocumented)
50+
server: WebpackDevServer.ServerConfiguration;
51+
// (undocumented)
52+
setupExitSignals: boolean;
53+
// (undocumented)
54+
static: false | Array<WebpackDevServer.NormalizedStatic>;
55+
// (undocumented)
56+
watchFiles: WebpackDevServer.WatchFiles[];
57+
// (undocumented)
58+
webSocketServer: false | WebpackDevServer.WebSocketServerConfiguration;
59+
}
60+
1961
// @public (undocumented)
2062
export class RspackDevServer extends WebpackDevServer {
2163
constructor(options: Configuration, compiler: Compiler | MultiCompiler);
2264
compiler: Compiler | MultiCompiler;
2365
// (undocumented)
2466
initialize(): Promise<void>;
25-
// Warning: (ae-forgotten-export) The symbol "ResolvedDevServer" needs to be exported by the entry point index.d.ts
2667
options: ResolvedDevServer;
2768
// (undocumented)
2869
server: Server;

packages/rspack-test-tools/etc/api.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,6 @@ export class HookTaskProcessor extends SnapshotProcessor<ECompilerType.Rspack> {
229229
constructor(hookOptions: IHookProcessorOptions<ECompilerType.Rspack>);
230230
// (undocumented)
231231
config(context: ITestContext): Promise<void>;
232-
// Warning: (ae-forgotten-export) The symbol "IHookProcessorOptions" needs to be exported by the entry point index.d.ts
233-
//
234232
// (undocumented)
235233
protected hookOptions: IHookProcessorOptions<ECompilerType.Rspack>;
236234
}
@@ -405,6 +403,12 @@ export interface IFormatCodeOptions {
405403
replacements?: Record<string, string>;
406404
}
407405

406+
// @public (undocumented)
407+
interface IHookProcessorOptions<T extends ECompilerType> extends ISnapshotProcessorOptions<T> {
408+
// (undocumented)
409+
options?: (context: ITestContext) => TCompilerOptions<T>;
410+
}
411+
408412
// @public (undocumented)
409413
export interface IMultiTaskProcessorOptions<T extends ECompilerType = ECompilerType.Rspack> {
410414
// (undocumented)
@@ -473,14 +477,10 @@ export interface IRspackStatsProcessorOptions<T extends ECompilerType.Rspack> {
473477

474478
// @public (undocumented)
475479
export interface IRspackWatchProcessorOptions {
476-
// Warning: (ae-forgotten-export) The symbol "TRspackExperiments" needs to be exported by the entry point index.d.ts
477-
//
478480
// (undocumented)
479481
experiments?: TRspackExperiments;
480482
// (undocumented)
481483
name: string;
482-
// Warning: (ae-forgotten-export) The symbol "TRspackOptimization" needs to be exported by the entry point index.d.ts
483-
//
484484
// (undocumented)
485485
optimization?: TRspackOptimization;
486486
// (undocumented)
@@ -1106,6 +1106,12 @@ export type TModuleObject = {
11061106
// @public (undocumented)
11071107
export type TModuleTypeId = "normal" | "runtime";
11081108

1109+
// @public (undocumented)
1110+
type TRspackExperiments = TCompilerOptions<ECompilerType.Rspack>["experiments"];
1111+
1112+
// @public (undocumented)
1113+
type TRspackOptimization = TCompilerOptions<ECompilerType.Rspack>["optimization"];
1114+
11091115
// @public (undocumented)
11101116
export interface TRunnerFactory<T extends ECompilerType> {
11111117
// (undocumented)

0 commit comments

Comments
 (0)