Skip to content

Commit

Permalink
fix!: remove the builtin Sass and Less plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan committed Mar 11, 2025
1 parent 8e62083 commit f1ed6f5
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 30 deletions.
2 changes: 0 additions & 2 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@
"@mdx-js/mdx": "2.3.0",
"@mdx-js/react": "2.3.0",
"@rsbuild/core": "1.2.16",
"@rsbuild/plugin-less": "~1.1.1",
"@rsbuild/plugin-react": "~1.1.1",
"@rsbuild/plugin-sass": "~1.2.2",
"@rspress/mdx-rs": "0.6.6",
"@rspress/plugin-auto-nav-sidebar": "workspace:*",
"@rspress/plugin-container-syntax": "workspace:*",
Expand Down
4 changes: 0 additions & 4 deletions packages/core/src/node/initRsbuild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ import type {
RsbuildInstance,
RsbuildPlugin,
} from '@rsbuild/core';
import { PLUGIN_LESS_NAME, pluginLess } from '@rsbuild/plugin-less';
import { PLUGIN_REACT_NAME, pluginReact } from '@rsbuild/plugin-react';
import { PLUGIN_SASS_NAME, pluginSass } from '@rsbuild/plugin-sass';
import {
MDX_OR_MD_REGEXP,
RSPRESS_TEMP_DIR,
Expand Down Expand Up @@ -100,8 +98,6 @@ async function createInternalBuildConfig(
return {
plugins: [
...(isPluginIncluded(config, PLUGIN_REACT_NAME) ? [] : [pluginReact()]),
...(isPluginIncluded(config, PLUGIN_SASS_NAME) ? [] : [pluginSass()]),
...(isPluginIncluded(config, PLUGIN_LESS_NAME) ? [] : [pluginLess()]),
rsbuildPluginDocVM({
userDocRoot,
config,
Expand Down
14 changes: 5 additions & 9 deletions packages/document/docs/en/api/config/config-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,18 @@ export default defineConfig({
});
```

You can also override the built-in plugins [@rsbuild/plugin-react](https://rsbuild.dev/plugins/list/plugin-react), [@rsbuild/plugin-sass](https://rsbuild.dev/plugins/list/plugin-sass) and [@rsbuild/plugin-less](https://rsbuild.dev/plugins/list/plugin-less), and customize relevant plugin options.
You can also override the built-in plugin [@rsbuild/plugin-react](https://rsbuild.dev/plugins/list/plugin-react) and customize the plugin options.

- Example: Modify related options of built-in [@rsbuild/plugin-less](https://rsbuild.dev/plugins/list/plugin-less) plugin.
For example:

```ts title="rspress.config.ts"
import { defineConfig } from 'rspress/config';
import { pluginLess } from '@rsbuild/plugin-less';
import { pluginReact } from '@rsbuild/plugin-react';

export default defineConfig({
builderPlugins: [
pluginLess({
lessLoaderOptions: {
lessOptions: {
math: 'always',
},
},
pluginReact({
// ...options
}),
],
});
Expand Down
14 changes: 5 additions & 9 deletions packages/document/docs/zh/api/config/config-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,18 @@ export default defineConfig({
});
```

你也可以覆盖内置的 [@rsbuild/plugin-react](https://rsbuild.dev/zh/plugins/list/plugin-react)[@rsbuild/plugin-sass](https://rsbuild.dev/zh/plugins/list/plugin-sass)[@rsbuild/plugin-less](https://rsbuild.dev/zh/plugins/list/plugin-less) 插件,并传入相关插件选项
你也可以覆盖内置的 [@rsbuild/plugin-react](https://rsbuild.dev/zh/plugins/list/plugin-react) 并自定义插件的选项

- 示例:修改内置的 [@rsbuild/plugin-less](https://rsbuild.dev/zh/plugins/list/plugin-less) 插件的相关选项
比如:

```ts title="rspress.config.ts"
import { defineConfig } from 'rspress/config';
import { pluginLess } from '@rsbuild/plugin-less';
import { pluginReact } from '@rsbuild/plugin-react';

export default defineConfig({
builderPlugins: [
pluginLess({
lessLoaderOptions: {
lessOptions: {
math: 'always',
},
},
pluginReact({
// ...options
}),
],
});
Expand Down
1 change: 1 addition & 0 deletions packages/document/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"preview": "rspress preview"
},
"devDependencies": {
"@rsbuild/plugin-sass": "~1.2.2",
"@rspress/plugin-algolia": "workspace:*",
"@rstack-dev/doc-ui": "1.6.0",
"@types/react": "^18.3.18",
Expand Down
2 changes: 2 additions & 0 deletions packages/document/rspress.config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { pluginSass } from '@rsbuild/plugin-sass';
import { pluginAlgolia } from '@rspress/plugin-algolia';
import { pluginGoogleAnalytics } from 'rsbuild-plugin-google-analytics';
import { pluginOpenGraph } from 'rsbuild-plugin-open-graph';
Expand Down Expand Up @@ -33,6 +34,7 @@ export default defineConfig({
lazyCompilation: true,
},
plugins: [
pluginSass(),
pluginGoogleAnalytics({ id: 'G-66B2Z6KG0J' }),
pluginOpenGraph({
title: 'Rspress',
Expand Down
9 changes: 3 additions & 6 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f1ed6f5

Please sign in to comment.