chore: integrate Rslint for type-aware linting (#1151)

Author: fi3ework

README.md

@@ -57,6 +57,7 @@ Rstack is a unified JavaScript toolchain built around Rspack, with high performa
 | [Rspress](https://github.com/web-infra-dev/rspress)   | Static site generator    |
 | [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | Build analyzer           |
 | [Rstest](https://github.com/web-infra-dev/rstest)     | Testing framework        |
+| [Rslint](https://github.com/web-infra-dev/rslint)     | Linter                   |
 
 ## 🔗 Links
 

README.zh-CN.md

@@ -57,6 +57,7 @@ Rstack 是一个围绕 Rspack 打造的 JavaScript 统一工具链，具有优
 | [Rspress](https://github.com/web-infra-dev/rspress)   | 静态站点生成器 |
 | [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | 构建分析工具   |
 | [Rstest](https://github.com/web-infra-dev/rstest)     | 测试框架       |
+| [Rslint](https://github.com/web-infra-dev/rslint)     | 代码检查工具   |
 
 ## 🔗 链接
 

biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.1.3/schema.json",
   "assist": {
     "actions": {
       "source": {

package.json

@@ -10,7 +10,8 @@
     "check-spell": "pnpx cspell && heading-case",
     "format": "prettier . --write && biome check --write && heading-case --write",
     "generate-release-pr": "zx scripts/generateReleasePr.mjs",
-    "lint": "biome check . --diagnostic-level=warn && prettier . --check && pnpm run check-spell",
+    "lint": "biome check . --diagnostic-level=warn && prettier . --check && pnpm run check-spell && pnpm lint:type",
+    "lint:type": "rslint",
     "prebundle": "nx run-many -t prebundle",
     "prepare": "pnpm run build && simple-git-hooks",
     "sort-package-json": "npx sort-package-json \"packages/*/package.json\"",
@@ -42,6 +43,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.1.3",
     "@changesets/cli": "^2.29.5",
+    "@rslint/core": "^0.1.5",
     "@rstest/core": "0.1.1",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.17.0",

packages/core/src/cli/prepare.ts

@@ -23,5 +23,5 @@ export function prepareCli(): void {
     console.log();
   }
 
-  logger.greet(`  ${`Rslib v${RSLIB_VERSION}`}\n`);
+  logger.greet(`  Rslib v${RSLIB_VERSION}\n`);
 }

packages/core/src/config.ts

@@ -218,7 +218,8 @@ const composeExternalsWarnConfig = (
               asyncFlag = false;
               return;
             }
-            return next();
+            next();
+            return;
           }
 
           callback(matched, shouldWarn);
@@ -227,7 +228,8 @@ const composeExternalsWarnConfig = (
         do {
           asyncFlag = true;
           if (i >= externals.length) {
-            return callback(false);
+            callback(false);
+            return;
           }
           matchUserExternals(
             externals[i++],
@@ -308,7 +310,7 @@ export const composeAutoExternalConfig = (options: {
   const { bundle, format, pkgJson, userExternals } = options;
 
   // If bundle is false, autoExternal will be disabled
-  if (bundle === false) {
+  if (!bundle) {
     return {};
   }
 
@@ -352,7 +354,7 @@ export const composeAutoExternalConfig = (options: {
   )
     .reduce<string[]>((prev, type) => {
       if (externalOptions[type]) {
-        return pkgJson[type] ? prev.concat(Object.keys(pkgJson[type]!)) : prev;
+        return pkgJson[type] ? prev.concat(Object.keys(pkgJson[type])) : prev;
       }
       return prev;
     }, [])
@@ -654,7 +656,7 @@ const composeFormatConfig = ({
         },
       };
     case 'umd': {
-      if (bundle === false) {
+      if (!bundle) {
         throw new Error(
           'When using "umd" format, "bundle" must be set to "true". Since the default value for "bundle" is "true", so you can either explicitly set it to "true" or remove the field entirely.',
         );
@@ -692,7 +694,7 @@ const composeFormatConfig = ({
       return config;
     }
     case 'iife': {
-      if (bundle === false) {
+      if (!bundle) {
         throw new Error(
           'When using "iife" format, "bundle" must be set to "true". Since the default value for "bundle" is "true", so you can either explicitly set it to "true" or remove the field entirely.',
         );
@@ -735,7 +737,7 @@ const composeFormatConfig = ({
       return config;
     }
     case 'mf':
-      if (bundle === false) {
+      if (!bundle) {
         throw new Error(
           'When using "mf" format, "bundle" must be set to "true". Since the default value for "bundle" is "true", so you can either explicitly set it to "true" or remove the field entirely.',
         );
@@ -749,7 +751,7 @@ const composeFormatConfig = ({
           rspack: (config, { env }) => {
             config.output = {
               ...config.output,
-              uniqueName: pkgJson.name as string,
+              uniqueName: pkgJson.name,
             };
 
             config.optimization = {
@@ -1092,7 +1094,7 @@ const composeEntryConfig = async (
         } else {
           // Non-existed file.
           entryErrorReasons.push(
-            `Can't resolve the entry ${color.cyan(`"${entry}"`)} at the location ${color.cyan(`${entryAbsPath}`)}. Please ensure that the file exists.`,
+            `Can't resolve the entry ${color.cyan(`"${entry}"`)} at the location ${color.cyan(entryAbsPath)}. Please ensure that the file exists.`,
           );
         }
       }
@@ -1259,12 +1261,13 @@ const composeBundlelessExternalConfig = (
           async (data, callback) => {
             const { request, getResolve, context, contextInfo } = data;
             if (!request || !getResolve || !context || !contextInfo) {
-              return callback();
+              callback();
+              return;
             }
             const { issuer } = contextInfo;
 
             if (!resolver) {
-              resolver = (await getResolve()) as RspackResolver;
+              resolver = getResolve() as RspackResolver;
             }
 
             async function redirectPath(
@@ -1333,7 +1336,8 @@ const composeBundlelessExternalConfig = (
               }
 
               if (redirectedPath === undefined) {
-                return callback(undefined, request);
+                callback(undefined, request);
+                return;
               }
 
               if (jsRedirectPath) {
@@ -1380,7 +1384,8 @@ const composeBundlelessExternalConfig = (
                 }
               }
 
-              return callback(undefined, resolvedRequest);
+              callback(undefined, resolvedRequest);
+              return;
             }
 
             callback();

packages/core/src/css/cssConfig.ts

@@ -26,7 +26,8 @@ export async function cssExternalHandler(
   // cssExtract: do not external @rsbuild/core/compiled/css-loader/noSourceMaps.js, sourceMaps.js, api.mjs etc.
   // cssExtract would execute the result handled by css-loader with importModule, so we cannot external the "helper import" from css-loader
   if (/compiled\/css-loader\//.test(request)) {
-    return callback();
+    callback();
+    return;
   }
 
   let resolvedRequest = request;
@@ -41,7 +42,8 @@ export async function cssExternalHandler(
   if (!isCssFile(resolvedRequest)) {
     // cssExtract: do not external assets module import
     if (isCssFile(issuer)) {
-      return callback();
+      callback();
+      return;
     }
     return false;
   }
@@ -51,15 +53,14 @@ export async function cssExternalHandler(
   if (styleRedirectExtension) {
     const isCssModulesRequest = isCssModulesFile(resolvedRequest, auto);
     if (isCssModulesRequest) {
-      return callback(
-        undefined,
-        resolvedRequest.replace(/\.[^.]+$/, jsExtension),
-      );
+      callback(undefined, resolvedRequest.replace(/\.[^.]+$/, jsExtension));
+      return;
     }
-    return callback(undefined, resolvedRequest.replace(/\.[^.]+$/, '.css'));
+    callback(undefined, resolvedRequest.replace(/\.[^.]+$/, '.css'));
+    return;
   }
 
-  return callback(undefined, resolvedRequest);
+  callback(undefined, resolvedRequest);
 }
 
 const PLUGIN_NAME = 'rsbuild:lib-css';

packages/core/src/css/libCssExtractLoader.ts

@@ -95,7 +95,7 @@ export const pitch: Rspack.LoaderDefinition['pitch'] = function (
   const banner = options.banner;
   const footer = options.footer;
 
-  let { publicPath } = this._compilation!.outputOptions;
+  let { publicPath } = this._compilation.outputOptions;
 
   if (typeof options.publicPath === 'string') {
     // eslint-disable-next-line prefer-destructuring
@@ -212,8 +212,7 @@ export const pitch: Rspack.LoaderDefinition['pitch'] = function (
 
           const localsString = identifiers
             .map(
-              ([id, key]) =>
-                `\nvar ${id} = ${stringifyLocal(locals![key as string])};`,
+              ([id, key]) => `\nvar ${id} = ${stringifyLocal(locals[key!])};`,
             )
             .join('');
           const exportsString = `export { ${identifiers
@@ -282,7 +281,7 @@ export const pitch: Rspack.LoaderDefinition['pitch'] = function (
       }
       if (sourceMap) {
         const sourceMapPath = `${distFilepath}.map`;
-        m.set(sourceMapPath, `${sourceMap}`);
+        m.set(sourceMapPath, sourceMap);
         // Associate the source map with the CSS file
         const sourceMappingURL = `/*# sourceMappingURL=${cssFilename}.map */`;
         m.set(distFilepath, `${m.get(distFilepath)}\n${sourceMappingURL}`);

packages/core/src/utils/helper.ts

@@ -11,7 +11,7 @@ import { logger } from './logger';
  * Node.js built-in modules.
  * Copied from https://github.com/webpack/webpack/blob/dd44b206a9c50f4b4cb4d134e1a0bd0387b159a3/lib/node/NodeTargetPlugin.js#L12-L72
  */
-export const nodeBuiltInModules: Array<string | RegExp> = [
+export const nodeBuiltInModules: (string | RegExp)[] = [
   'assert',
   'assert/strict',
   'async_hooks',
@@ -140,7 +140,7 @@ export const isEmptyObject = (obj: object): boolean => {
 
 export function pick<T, U extends keyof T>(
   obj: T,
-  keys: ReadonlyArray<U>,
+  keys: readonly U[],
 ): Pick<T, U> {
   return keys.reduce(
     (ret, key) => {

packages/core/src/utils/logger.ts

@@ -43,7 +43,7 @@ logger.override({
     if (logger.level !== 'verbose') {
       return;
     }
-    const time = color.gray(`${getTime()}`);
+    const time = color.gray(getTime());
     console.log(`  ${color.green('rslib')} ${time} ${message}`, ...args);
   },
 });