Skip to content

Commit 5dafcdc

Browse files
authored
feat(core): reexport "@rslib/core/types" from "@rsbuild/core/types" (#739)
1 parent befb09a commit 5dafcdc

File tree

9 files changed

+27
-37
lines changed

9 files changed

+27
-37
lines changed
Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
declare module '*.module.scss' {
2-
const classes: { [key: string]: string };
3-
export default classes;
4-
}
5-
6-
declare module '*.svg' {
7-
const url: string;
8-
export default url;
9-
}
1+
/// <reference types="@rslib/core/types" />
Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
declare module '*.module.scss' {
2-
const classes: { [key: string]: string };
3-
export default classes;
4-
}
5-
6-
declare module '*.svg' {
7-
const url: string;
8-
export default url;
9-
}
1+
/// <reference types="@rslib/core/types" />
Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
declare module '*.module.scss' {
2-
const classes: { [key: string]: string };
3-
export default classes;
4-
}
5-
6-
declare module '*.svg' {
7-
const url: string;
8-
export default url;
9-
}
1+
/// <reference types="@rslib/core/types" />
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
declare module '*.module.scss' {
2-
const classes: { [key: string]: string };
3-
export default classes;
4-
}
1+
/// <reference types="@rslib/core/types" />

packages/core/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
"types": "./dist-types/index.d.ts",
1919
"default": "./dist/index.js"
2020
},
21+
"./types": {
22+
"types": "./types.d.ts"
23+
},
2124
"./package.json": "./package.json"
2225
},
2326
"main": "./dist/index.js",
@@ -29,7 +32,8 @@
2932
"bin",
3033
"dist",
3134
"dist-types",
32-
"compiled"
35+
"compiled",
36+
"types.d.ts"
3337
],
3438
"scripts": {
3539
"build": "rslib build",

packages/core/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"rslog": ["./compiled/rslog"]
1818
}
1919
},
20-
"include": ["src"],
20+
"include": ["src", "types.d.ts"],
2121
"exclude": ["**/node_modules"],
2222
"references": [
2323
{

packages/core/types.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="@rsbuild/core/types" />

website/docs/en/guide/migration/modernjs-module.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,15 +146,21 @@ In addition, you have to install the `@rsbuild/plugin-sass` package as `devDepen
146146

147147
<PackageManagerTabs command="add @rsbuild/plugin-sass -D" />
148148

149-
If you run Typescript together with Sass, you might run into DTS generation errors. This can be resolved by adding a `global.d.ts` file in your `/src` directory.
149+
If you run Typescript together with Sass, you might run into DTS generation errors. This can be resolved by adding a `env.d.ts` file in your `/src` directory.
150150

151-
```ts title="global.d.ts"
151+
```ts title="src/env.d.ts"
152152
declare module '*.scss' {
153153
const content: { [className: string]: string };
154154
export default content;
155155
}
156156
```
157157

158+
or
159+
160+
```ts title="src/env.d.ts"
161+
/// <reference types="@rslib/core/types" />
162+
```
163+
158164
## CSS Modules
159165

160166
If you use CSS Modules in your `Modern.js Module`, add the following changes:

website/docs/zh/guide/migration/modernjs-module.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,15 +146,21 @@ export default defineConfig({
146146

147147
<PackageManagerTabs command="add @rsbuild/plugin-sass -D" />
148148

149-
如果你在运行 Typescript 和 Sass,你可能会遇到 DTS 生成错误。这可以通过在 `/src` 目录中添加一个 `global.d.ts` 文件来解决。
149+
如果你在运行 Typescript 和 Sass,你可能会遇到 DTS 生成错误。这可以通过在 `/src` 目录中添加一个 `env.d.ts` 文件来解决。
150150

151-
```ts title="global.d.ts"
151+
```ts title="src/env.d.ts"
152152
declare module '*.scss' {
153153
const content: { [className: string]: string };
154154
export default content;
155155
}
156156
```
157157

158+
或者
159+
160+
```ts title="src/env.d.ts"
161+
/// <reference types="@rslib/core/types" />
162+
```
163+
158164
## CSS Modules
159165

160166
如果你在 `Modern.js Module` 中使用 CSS Modules,请添加以下更改:

0 commit comments

Comments
 (0)