Skip to content

Commit c0226b9

Browse files
fix: add tsdoc for config options (#447)
Co-authored-by: Timeless0911 <[email protected]>
1 parent fe69381 commit c0226b9

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

packages/core/src/types/config/index.ts

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,59 +80,68 @@ export type Redirect = {
8080
export interface LibConfig extends RsbuildConfig {
8181
/**
8282
* The unique identifier of the library.
83-
* @default undefined
83+
* @defaultValue `undefined`
84+
* @see {@link https://lib.rsbuild.dev/config/lib/id}
8485
*/
8586
id?: string;
8687
/**
8788
* Output format for the generated JavaScript files.
88-
* @default undefined
89+
* @defaultValue `undefined`
90+
* @see {@link https://lib.rsbuild.dev/config/lib/format}
8991
*/
9092
format?: Format;
9193
/**
9294
* Whether to bundle the library.
93-
* @default true
95+
* @defaultValue `true`
96+
* @see {@link https://lib.rsbuild.dev/config/lib/bundle}
9497
*/
9598
bundle?: boolean;
9699
/**
97-
* Whether to automatically set the file extension based on the `format` option in the JavaScript output files.
98-
* @default true
100+
* Whether to automatically set the file extension based on {@link format} option in the JavaScript output files.
101+
* @defaultValue `true`
102+
* @see {@link https://lib.rsbuild.dev/config/lib/auto-extension}
99103
*/
100104
autoExtension?: boolean;
101105
/**
102106
* Whether to automatically externalize dependencies of different dependency types and do not bundle them.
103-
* @default true
107+
* @defaultValue `true`
108+
* @see {@link https://lib.rsbuild.dev/config/lib/auto-external}
104109
*/
105110
autoExternal?: AutoExternal;
106111
/**
107-
* Configure the redirect of the import paths, applicable when `bundle: false`.
108-
* @default {}
112+
* Configure the redirect of the import paths, applicable {@link bundle} is set to `false`.
113+
* @defaultValue `{}`
114+
* @see {@link https://lib.rsbuild.dev/config/lib/redirect}
109115
*/
110116
redirect?: Redirect;
111117
/**
112118
* Configure the syntax to which JavaScript and CSS will be downgraded.
113-
* Support ECMAScript version and browserslist query.
114-
* @default 'esnext'
119+
* @defaultValue `'esnext'`
120+
* @see {@link https://lib.rsbuild.dev/config/lib/syntax}
115121
*/
116122
syntax?: Syntax;
117123
/**
118124
* Whether to import SWC helper functions from `@swc/helpers` instead of inlining them.
119-
* @default false
125+
* @defaultValue `false`
126+
* @see {@link https://lib.rsbuild.dev/config/lib/external-helpers}
120127
*/
121128
externalHelpers?: boolean;
122129
/**
123130
* Inject content into the top of each JS, CSS or DTS file.
124-
* @default {}
131+
* @defaultValue `{}`
132+
* @see {@link https://lib.rsbuild.dev/config/lib/banner}
125133
*/
126134
banner?: BannerAndFooter;
127135
/**
128136
* Inject content into the bottom of each JS, CSS or DTS file.
129-
* @default {}
137+
* @defaultValue `{}`
138+
* @see {@link https://lib.rsbuild.dev/config/lib/footer}
130139
*/
131140
footer?: BannerAndFooter;
132141
/**
133142
* Configure the shims for CommonJS and ESM output.
134143
*
135-
* @default
144+
* @defaultValue
136145
* ```js
137146
* const defaultShims = {
138147
* cjs: {
@@ -145,16 +154,19 @@ export interface LibConfig extends RsbuildConfig {
145154
* },
146155
* };
147156
* ```
157+
* @see {@link https://lib.rsbuild.dev/config/lib/shims}
148158
*/
149159
shims?: Shims;
150160
/**
151161
* Configure the generation of the TypeScript declaration files.
152-
* @default false
162+
* @defaultValue `false`
163+
* @see {@link https://lib.rsbuild.dev/config/lib/dts}
153164
*/
154165
dts?: Dts;
155166
/**
156167
* The export name of the UMD bundle.
157-
* @default undefined
168+
* @defaultValue `undefined`
169+
* @see {@link https://lib.rsbuild.dev/config/lib/umd-name}
158170
*/
159171
umdName?: string;
160172
}

0 commit comments

Comments
 (0)