close
Guide
Config
Blog
Guide
Config
Blog

Built-in rules

Introduction

TIP

Please refer to the Linter Type in this document for the type definition of linter.

[E1001] Duplicate packages

Rule details

  • The Duplicate Packages card displays the number of duplicate third-party packages in the project. Clicking the image allows you to view the specific details of the duplicate third-party packages. Note: The third-party packages referred to here are all bundled third-party packages.

  • Duplicate Package Warning Card

  • Clicking the icon to expand the duplicate package details allows you to see: the name, version, size, and reference files of the duplicate package.

    • Clicking the 「Show Relations」 on the far right can view the specific reference chain and the corresponding reference file code position of this third-party package.
    • Clicking the 「!（exclamation mark）」 icon on the far right can view the specific explanation of the rule for the duplicate third-party package.

Configuration

  • Configuration Example:
import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        level: 'Error',
        extends: [],
        rules: {
          'duplicate-package': [
            'Error',
            {
              checkVersion: 'minor',
              ignore: ['chalk', '@babel/runtime'],
            },
          ],
        },
      },
    }),
  ],
};
Type
  • ignore: Configures the packages to be ignored.
  • checkVersion: Refers to the maximum version level to be checked, for example: if set to minor, then the duplicate package will no longer check the major level differences. Default is major.
interface Config {
  checkVersion: keyof typeof CheckVersion;
  ignore: string[];
}

enum CheckVersion {
  null = 0,
  prerelease = 0x1,
  prepatch = 0x10,
  patch = 0x100,
  preminor = 0x1000,
  minor = 0x10000,
  premajor = 0x100000,
  major = 0x1000000,
}

Duplicate package optimization problem

Please refer to the Duplicate Package Optimization Solution.

Clicking 「More」 can view the corresponding rule explanation.

[E1002] Cross chunks package

The cross chunks duplicate package rule can scan duplicate packages in different chunks. These duplicate packages may also lead to redundant code in the build artifacts, depending on the business logic and the size of the redundant code.

  • Display
    • Module refers to the module that is repeatedly packaged in multiple chunks.
    • Chunks are the build artifacts that are repeatedly packaged.

Solution

Please refer to [E1002] Cross Chunks Packages

[E1003] Loader performance optimization

This module allows you to visually see some warning information about our project's compilation, which can help us further optimize the project's compilation performance.

Solution

Please refer to [E1003] Loader Performance Optimization

Configuration type

  • ignore: Can include strings or regular expressions, used to specify the loaders to be ignored.
  • threshold: Represents the total time threshold for the loader, in milliseconds. If the loader's execution time exceeds this threshold, it may trigger warnings or errors. The default value is 5000 milliseconds.
  • extensions: Strings or regular expressions, used to specify the file extensions that need to be matched in rule checks. By default, it includes common file types such as js, css, jpg, jpeg, png, gif, webp, and svg.
interface Config {
  /**
   * loaders which should be ignore.
   */
  ignore: (string | RegExp)[];
  /**
   * threshold which the loader total costs.
   * @unit millisecond
   * @default 5000
   */
  threshold: number;
  /**
   * the file extensions which will be match in rule check.
   * @default ["js", "css", "jpg", "jpeg", "png", "gif", "webp", "svg"]
   */
  extensions: (string | RegExp)[];
}

[E1004] ECMA version check

This rule is used to detect incompatible advanced syntax. When scanning the rule, the configuration of browserslist is prioritized; if browserslist is not configured, manual detection is required, as shown below:

import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        rules: {
          'ecma-version-check': [
            'Warn',
            {
              ecmaVersion: 2015,
              // targets: ["chrome >= 53"],
            },
          ],
        },
      },
    }),
  ],
};

Type definitions

type CheckSyntaxOptions = {
  /**
   * The target browser range of the project.
   * Its value is a standard browserslist array.
   */
  targets?: string[];
  /**
   * Used to exclude a portion of source files during detection.
   * You can pass in one or more regular expressions to match the paths of source files.
   */
  exclude?: CheckSyntaxExclude;
  /**
   * Used to exclude files by output path before detection.
   * You can pass in one or more regular expressions to match the paths of source files.
   */
  excludeOutput?: CheckSyntaxExclude;
  /**
   * The minimum ECMAScript syntax version that can be used in the build artifact.
   * The priority of `ecmaVersion` is higher than `targets`.
   */
  ecmaVersion?: EcmaVersion;
  /**
   * Used to ignore specified syntax error messages after detection.
   * You can pass in one or more error message types to ignore.
   */
  excludeErrorLogs?: SyntaxErrorKey[];
};

For more ECMA Version Check configuration options, please refer to ECMA Version Check Options

[E1005] Default import check

Typically, Rspack automatically supports different types of modules, but in some cases, compatibility operations may fail. For example, when using Default Import to import a cjs module, if the module does not have a compatible statement (such as exports.default), issues may arise.

Solution

Please refer to [E1005] Default Import Check

Configuration

  • ignore：Configure to ignore some imported files.
interface Config {
  /** Packages that need to be ignored */
  ignore: string[];
}

Linter type

  • The type definition for the linter field is as follows:
/** Linter options */
interface Options {
  rules?: RulesMap;
  level?: SeverityString;
  extends?: ExtendRuleData[];
}

/**
 * Linting level
 *   - `'Warn'` runs only rules categorized as `'Warn'`
 *   - `'Error'` runs all rules
 */
type SeverityString = 'Warn' | 'Error';

/** Rule level */
type SeverityInput = SeverityString | 'off' | 'on';

/** Rule configuration */
type RulesMap = Record<string, RuleConfigItem>;

/** Single rule configuration */
type RuleConfigItem =
  // Only error level, this level has higher priority than the rule's own configuration
  | SeverityInput
  // In the case of an array, the first item is the error level, and the second item is the rule configuration
  | [SeverityInput, unknown];

If you want to disable a rule, you can set SeverityInput to off, as shown in the following example:

import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';

export default {
  plugin: [
    new RsdoctorRspackPlugin({
      linter: {
        level: 'Error',
        extends: [],
        rules: {
          'duplicate-package': 'off',
        },
      },
    }),
  ],
};
ON THIS PAGE