feat(core): export config subtypes (#2380)

web-infra-dev · May 18, 2024 · fa57fcc · fa57fcc
1 parent 8aa7d5f
commit fa57fcc
Show file tree

Hide file tree

Showing 29 changed files with 132 additions and 114 deletions.
diff --git a/e2e/cases/css/css-modules-dom/index.test.ts b/e2e/cases/css/css-modules-dom/index.test.ts
@@ -7,7 +7,7 @@ import { fse } from '@rsbuild/shared';
 
 const fixtures = resolve(__dirname);
 
-test('enableCssModuleTSDeclaration', async () => {
+test('plugin-typed-css-modules', async () => {
   fse.removeSync(join(fixtures, 'src/App.module.less.d.ts'));
   fse.removeSync(join(fixtures, 'src/App.module.scss.d.ts'));
 

diff --git a/packages/compat/plugin-swc/src/plugin.ts b/packages/compat/plugin-swc/src/plugin.ts
@@ -1,7 +1,7 @@
 import path from 'node:path';
+import type { RsbuildPlugin } from '@rsbuild/core';
 import {
   DEFAULT_BROWSERSLIST,
-  type RsbuildPlugin,
   SCRIPT_REGEX,
   applyScriptCondition,
 } from '@rsbuild/shared';

diff --git a/packages/compat/plugin-swc/src/utils.ts b/packages/compat/plugin-swc/src/utils.ts
@@ -1,9 +1,8 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { __internalHelper } from '@rsbuild/core';
+import type { ModifyChainUtils, NormalizedConfig } from '@rsbuild/core';
 import {
-  type ModifyChainUtils,
-  type NormalizedConfig,
   getBrowserslistWithDefault,
   getCoreJsVersion,
   isUsingHMR,

diff --git a/packages/compat/plugin-swc/tests/plugin.test.ts b/packages/compat/plugin-swc/tests/plugin.test.ts
@@ -1,5 +1,4 @@
-import type { NormalizedConfig } from '@rsbuild/core';
-import type { ModifyWebpackChainUtils } from '@rsbuild/shared';
+import type { ModifyChainUtils, NormalizedConfig } from '@rsbuild/core';
 import { webpackProvider } from '@rsbuild/webpack';
 import { createStubRsbuild } from '@scripts/test-helper';
 import { pluginSwc } from '../src';
@@ -15,7 +14,7 @@ const TEST_BUILDER_CONFIG = {
   },
 } as unknown as NormalizedConfig;
 
-const UTILS = { target: 'web', isProd: true } as ModifyWebpackChainUtils;
+const UTILS = { target: 'web', isProd: true } as ModifyChainUtils;
 
 describe('plugin-swc', () => {
   it('should set swc-loader', async () => {

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -69,6 +69,38 @@ export type {
   RsbuildInstance,
   CreateRsbuildOptions,
   InspectConfigOptions,
+  // Subtypes of Config
+  Minify,
+  Polyfill,
+  PrintUrls,
+  PublicDir,
+  Decorators,
+  RspackRule,
+  WatchFiles,
+  CSSModules,
+  CrossOrigin,
+  ConsoleType,
+  SplitChunks,
+  BundlerChain,
+  ClientConfig,
+  ScriptInject,
+  ChainedConfig,
+  PostCSSPlugin,
+  ScriptLoading,
+  LegalComments,
+  AliasStrategy,
+  FilenameConfig,
+  DistPathConfig,
+  OutputStructure,
+  ChainIdentifier,
+  PreconnectOption,
+  CSSLoaderOptions,
+  ModifyChainUtils,
+  StyleLoaderOptions,
+  PostCSSLoaderOptions,
+  ChainedConfigWithUtils,
+  ModifyRspackConfigUtils,
+  CSSModulesLocalsConvention,
   // Hook Callback Types
   OnExitFn,
   OnAfterBuildFn,

diff --git a/packages/core/src/plugins/css.ts b/packages/core/src/plugins/css.ts
@@ -29,7 +29,7 @@ export const isUseCssExtract = (
 ) =>
   !config.output.injectStyles && target !== 'node' && target !== 'web-worker';
 
-const getCssModuleLocalIdentName = (
+const getCSSModulesLocalIdentName = (
   config: NormalizedConfig,
   isProd: boolean,
 ) =>
@@ -200,7 +200,7 @@ const getPostcssLoaderOptions = async ({
   return mergedConfig;
 };
 
-const getCssLoaderOptions = ({
+const getCSSLoaderOptions = ({
   config,
   importLoaders,
   target,
@@ -261,9 +261,9 @@ export async function applyCSSRule({
   const enableExtractCSS = isUseCssExtract(config, target);
 
   // 2. Prepare loader options
-  const localIdentName = getCssModuleLocalIdentName(config, isProd);
+  const localIdentName = getCSSModulesLocalIdentName(config, isProd);
 
-  const cssLoaderOptions = getCssLoaderOptions({
+  const cssLoaderOptions = getCSSLoaderOptions({
     config,
     importLoaders,
     target,

diff --git a/packages/plugin-assets-retry/src/runtime/initialChunkRetry.ts b/packages/plugin-assets-retry/src/runtime/initialChunkRetry.ts
@@ -1,5 +1,5 @@
 // rsbuild/runtime/initial-chunk-retry
-import type { CrossOrigin } from '@rsbuild/shared';
+import type { CrossOrigin } from '@rsbuild/core';
 import type { AssetsRetryHookContext, RuntimeRetryOptions } from '../types';
 
 interface ScriptElementAttributes {

diff --git a/packages/plugin-assets-retry/src/types.ts b/packages/plugin-assets-retry/src/types.ts
@@ -1,4 +1,4 @@
-import type { CrossOrigin } from '@rsbuild/shared';
+import type { CrossOrigin } from '@rsbuild/core';
 
 export type PluginAssetsRetryOptions = {
   /**

diff --git a/packages/plugin-babel/src/helper.ts b/packages/plugin-babel/src/helper.ts
@@ -1,12 +1,11 @@
 import { isAbsolute, normalize, sep } from 'node:path';
 import type { PluginOptions as BabelPluginOptions } from '@babel/core';
-import {
-  type BundlerChain,
-  type ChainIdentifier,
-  type NormalizedConfig,
-  castArray,
-  mergeChainedOptions,
-} from '@rsbuild/shared';
+import type {
+  BundlerChain,
+  ChainIdentifier,
+  NormalizedConfig,
+} from '@rsbuild/core';
+import { castArray, mergeChainedOptions } from '@rsbuild/shared';
 import upath from 'upath';
 import type {
   BabelConfigUtils,

diff --git a/packages/plugin-babel/src/types.ts b/packages/plugin-babel/src/types.ts
@@ -2,7 +2,7 @@ import type {
   PluginItem as BabelPlugin,
   TransformOptions as BabelTransformOptions,
 } from '@babel/core';
-import type { ChainedConfigWithUtils } from '@rsbuild/shared';
+import type { ChainedConfigWithUtils } from '@rsbuild/core';
 
 export type { BabelPlugin, BabelTransformOptions };
 

diff --git a/packages/plugin-check-syntax/src/index.ts b/packages/plugin-check-syntax/src/index.ts
@@ -1,9 +1,9 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-import {
-  type NormalizedConfig,
-  type RsbuildTarget,
-  getBrowserslistWithDefault,
-} from '@rsbuild/shared';
+import type {
+  NormalizedConfig,
+  RsbuildPlugin,
+  RsbuildTarget,
+} from '@rsbuild/core';
+import { getBrowserslistWithDefault } from '@rsbuild/shared';
 import type { CheckSyntaxOptions } from './types';
 
 export type PluginCheckSyntaxOptions = CheckSyntaxOptions;

diff --git a/packages/plugin-css-minimizer/src/index.ts b/packages/plugin-css-minimizer/src/index.ts
@@ -1,10 +1,10 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-import {
-  type BundlerChain,
-  type ChainIdentifier,
-  type ChainedConfig,
-  mergeChainedOptions,
-} from '@rsbuild/shared';
+import type {
+  BundlerChain,
+  ChainIdentifier,
+  ChainedConfig,
+  RsbuildPlugin,
+} from '@rsbuild/core';
+import { mergeChainedOptions } from '@rsbuild/shared';
 import CssMinimizerWebpackPlugin from 'css-minimizer-webpack-plugin';
 import type CssMinimizerPlugin from 'css-minimizer-webpack-plugin';
 

diff --git a/packages/plugin-lightningcss/tests/index.test.ts b/packages/plugin-lightningcss/tests/index.test.ts
@@ -4,7 +4,7 @@ import { createStubRsbuild } from '@scripts/test-helper';
 import { describe, expect, it } from 'vitest';
 import { lightningcss, pluginLightningcss } from '../src';
 
-const getCssRules = (rspackConfig: Rspack.Configuration) => {
+const getCSSRules = (rspackConfig: Rspack.Configuration) => {
   const CSS_RULES = ['css', 'scss', 'sass', 'less', 'stylus'];
 
   return (
@@ -28,7 +28,7 @@ describe('plugins/lightningcss', () => {
     });
 
     const bundlerConfigs = await rsbuild.initConfigs();
-    const cssRules = getCssRules(bundlerConfigs[0]);
+    const cssRules = getCSSRules(bundlerConfigs[0]);
     expect(cssRules).toMatchSnapshot();
     expect(cssRules).not.contain('postcss-loader');
   });
@@ -134,7 +134,7 @@ describe('plugins/lightningcss', () => {
     });
 
     const bundlerConfigs = await rsbuild.initConfigs();
-    const cssRules = getCssRules(bundlerConfigs[0]);
+    const cssRules = getCSSRules(bundlerConfigs[0]);
     expect(cssRules).toMatchSnapshot();
     expect(cssRules).not.contain('postcss-loader');
 
@@ -157,7 +157,7 @@ describe('plugins/lightningcss', () => {
     });
 
     const bundlerConfigs = await rsbuild.initConfigs();
-    const cssRules = getCssRules(bundlerConfigs[0]);
+    const cssRules = getCSSRules(bundlerConfigs[0]);
     expect(cssRules).toMatchSnapshot();
     expect(cssRules).not.contain('postcss-loader');
 

diff --git a/packages/plugin-react/src/react.ts b/packages/plugin-react/src/react.ts
@@ -1,12 +1,12 @@
 import path from 'node:path';
-import type { RsbuildConfig, RsbuildPluginAPI, Rspack } from '@rsbuild/core';
-import {
-  type BundlerChain,
-  type ChainIdentifier,
-  SCRIPT_REGEX,
-  deepmerge,
-  isUsingHMR,
-} from '@rsbuild/shared';
+import type {
+  BundlerChain,
+  ChainIdentifier,
+  RsbuildConfig,
+  RsbuildPluginAPI,
+  Rspack,
+} from '@rsbuild/core';
+import { SCRIPT_REGEX, deepmerge, isUsingHMR } from '@rsbuild/shared';
 import type { PluginReactOptions } from '.';
 
 const modifySwcLoaderOptions = ({

diff --git a/packages/plugin-react/src/splitChunks.ts b/packages/plugin-react/src/splitChunks.ts
@@ -1,10 +1,5 @@
-import type { RsbuildPluginAPI } from '@rsbuild/core';
-import {
-  type SplitChunks,
-  createCacheGroups,
-  isPlainObject,
-  isProd,
-} from '@rsbuild/shared';
+import type { RsbuildPluginAPI, SplitChunks } from '@rsbuild/core';
+import { createCacheGroups, isPlainObject, isProd } from '@rsbuild/shared';
 import type { SplitReactChunkOptions } from '.';
 
 export const applySplitChunksRule = (

diff --git a/packages/plugin-react/tests/features.test.ts b/packages/plugin-react/tests/features.test.ts
@@ -1,4 +1,3 @@
-import { SCRIPT_REGEX } from '@rsbuild/shared';
 import { createStubRsbuild } from '@scripts/test-helper';
 import { describe, expect, it, vi } from 'vitest';
 import { pluginReact } from '../src';

diff --git a/packages/plugin-rem/src/AutoSetRootFontSizePlugin.ts b/packages/plugin-rem/src/AutoSetRootFontSizePlugin.ts
@@ -1,7 +1,6 @@
 import path from 'node:path';
-import { type Rspack, logger } from '@rsbuild/core';
+import { type Rspack, type ScriptLoading, logger } from '@rsbuild/core';
 import {
-  type ScriptLoading,
   generateScriptTag,
   getPublicPathFromCompiler,
   isProd,

diff --git a/packages/plugin-rem/src/index.ts b/packages/plugin-rem/src/index.ts
@@ -1,5 +1,5 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-import { type PostCSSPlugin, getDistPath } from '@rsbuild/shared';
+import type { PostCSSPlugin, RsbuildPlugin } from '@rsbuild/core';
+import { getDistPath } from '@rsbuild/shared';
 import { cloneDeep } from '@rsbuild/shared';
 import type { PluginRemOptions, PxToRemOptions } from './types';
 

diff --git a/packages/plugin-styled-components/src/index.ts b/packages/plugin-styled-components/src/index.ts
@@ -1,6 +1,9 @@
-import type { RsbuildConfig, RsbuildPlugin } from '@rsbuild/core';
+import type {
+  ChainedConfig,
+  RsbuildConfig,
+  RsbuildPlugin,
+} from '@rsbuild/core';
 import {
-  type ChainedConfig,
   getNodeEnv,
   isServerTarget,
   mergeChainedOptions,

diff --git a/packages/plugin-type-check/src/index.ts b/packages/plugin-type-check/src/index.ts
@@ -1,7 +1,6 @@
-import { type RsbuildPlugin, logger } from '@rsbuild/core';
+import { type ChainedConfig, type RsbuildPlugin, logger } from '@rsbuild/core';
 import {
   CHAIN_ID,
-  type ChainedConfig,
   NODE_MODULES_REGEX,
   deepmerge,
   fse,

diff --git a/packages/plugin-typed-css-modules/src/index.ts b/packages/plugin-typed-css-modules/src/index.ts
@@ -1,6 +1,5 @@
 import path from 'node:path';
-import type { RsbuildPlugin } from '@rsbuild/core';
-import type { CSSLoaderOptions } from '@rsbuild/shared';
+import type { CSSLoaderOptions, RsbuildPlugin } from '@rsbuild/core';
 
 const PLUGIN_NAME = 'rsbuild:typed-css-modules';
 

diff --git a/packages/plugin-typed-css-modules/src/loader.ts b/packages/plugin-typed-css-modules/src/loader.ts
@@ -38,7 +38,7 @@ const getNoDeclarationFileError = ({ filename }: { filename: string }) =>
     `Generated type declaration does not exist. Run webpack and commit the type declaration for '${filename}'`,
   );
 
-export const isCssModules = (filename: string, modules: CssLoaderModules) => {
+export const isCSSModules = (filename: string, modules: CssLoaderModules) => {
   if (typeof modules === 'boolean') {
     return modules;
   }
@@ -93,8 +93,8 @@ export function wrapQuotes(key: string) {
   return `'${key}'`;
 }
 
-const cssModuleToInterface = (cssModuleKeys: string[]) => {
-  const interfaceFields = cssModuleKeys
+const cssModuleToInterface = (cssModulesKeys: string[]) => {
+  const interfaceFields = cssModulesKeys
     .sort()
     .map((key) => `  ${wrapQuotes(key)}: string;`)
     .join('\n');
@@ -146,30 +146,30 @@ const extractLocalExports = (content: string) => {
   return localExports;
 };
 
-const getCssModuleKeys = (content: string) => {
+const getCSSModulesKeys = (content: string) => {
   const keyRegex = /"([^\\"]+)":/g;
-  const cssModuleKeys = [];
+  const cssModulesKeys = [];
 
   const localExports = extractLocalExports(content);
 
   let match = keyRegex.exec(localExports);
 
   while (match !== null) {
-    if (cssModuleKeys.indexOf(match[1]) < 0) {
-      cssModuleKeys.push(match[1]);
+    if (cssModulesKeys.indexOf(match[1]) < 0) {
+      cssModulesKeys.push(match[1]);
     }
     match = keyRegex.exec(localExports);
   }
 
-  return cssModuleKeys;
+  return cssModulesKeys;
 };
 
 export default function (
   this: Rspack.LoaderContext<{
     mode: string;
     modules: CssLoaderModules;
   }> & {
-    cssModuleKeys?: string[];
+    cssModulesKeys?: string[];
   },
   content: string,
   ...rest: any[]
@@ -183,16 +183,16 @@ export default function (
     return failed(new Error(`Invalid mode option: ${mode}`));
   }
 
-  if (!isCssModules(filename, modules) || isInNodeModules(filename)) {
+  if (!isCSSModules(filename, modules) || isInNodeModules(filename)) {
     return success();
   }
 
   const cssModuleInterfaceFilename = filenameToTypingsFilename(filename);
   const { read, write } = makeFileHandlers(cssModuleInterfaceFilename);
 
-  const cssModuleKeys = this.cssModuleKeys || getCssModuleKeys(content);
+  const cssModulesKeys = this.cssModulesKeys || getCSSModulesKeys(content);
   const cssModuleDefinition = `${bannerMessage}\n${cssModuleToInterface(
-    cssModuleKeys,
+    cssModulesKeys,
   )}\n${cssModuleExport}`;
 
   if (mode === 'verify') {