Skip to content

Type Alias: AdvancedChunksGroup

  • Type: AdvancedChunksGroup = object

Properties

maxModuleSize?

  • Type: optional maxModuleSize: number

Controls whether a module can only be captured if its size in bytes is smaller than or equal to this value.

Default

ts
Infinity

maxSize?

  • Type: optional maxSize: number

If the accumulated size in bytes of the captured modules by this group is larger than this value, this group will be split into multiple groups that each has size close to this value.

Default

ts
Infinity

minModuleSize?

  • Type: optional minModuleSize: number

Controls whether a module can only be captured if its size in bytes is larger than or equal to this value.

Default

ts
0

minShareCount?

  • Type: optional minShareCount: number

Controls if a module should be captured based on how many entry chunks reference it.

Default

ts
1

minSize?

  • Type: optional minSize: number

Minimum size in bytes of the desired chunk. If the accumulated size of the captured modules by this group is smaller than this value, it will be ignored. Modules in this group will fall back to the automatic chunking if they are not captured by any other group.

Default

ts
0

name

  • Type: name: string | (moduleId, ctx) => string | NullValue

Name of the group. It will be also used as the name of the chunk and replace the [name] placeholder in the output.chunkFileNames option.

For example,

js
import { defineConfig } from 'rolldown';

export default defineConfig({
  advancedChunks: {
    groups: [
      {
        name: 'libs',
        test: /node_modules/,
      },
    ],
  },
});

will create a chunk named libs-[hash].js in the end.

It's ok to have the same name for different groups. Rolldown will deduplicate the chunk names if necessary.

Dynamic name()

If name is a function, it will be called with the module id as the argument. The function should return a string or null. If it returns null, the module will be ignored by this group.

Notice, each returned new name will be treated as a separate group.

For example,

js
import { defineConfig } from 'rolldown';

export default defineConfig({
  advancedChunks: {
    groups: [
      {
        name: (moduleId) => moduleId.includes('node_modules') ? 'libs' : 'app',
        minSize: 100 * 1024,
      },
    ],
  },
});

WARNING

Constraints like minSize, maxSize, etc. are applied separately for different names returned by the function.


priority?

  • Type: optional priority: number

Priority of the group. Group with higher priority will be chosen first to match modules and create chunks. When converting the group to a chunk, modules of that group will be removed from other groups.

If two groups have the same priority, the group whose index is smaller will be chosen.

Example

js
import { defineConfig } from 'rolldown';

export default defineConfig({
 advancedChunks: {
  groups: [
     {
       name: 'react',
       test: /node_modules[\\/]react/,
       priority: 2,
     },
     {
       name: 'other-libs',
       test: /node_modules/,
       priority: 1,
     },
  ],
});

Default

ts
0

test?

  • Type: optional test: StringOrRegExp | (id) => boolean | void | undefined

Controls which modules are captured in this group.

  • If test is a string, the module whose id contains the string will be captured.
  • If test is a regular expression, the module whose id matches the regular expression will be captured.
  • If test is a function, modules for which test(id) returns true will be captured.
  • If test is empty, any module will be considered as matched.

WARNING

When using regular expression, it's recommended to use [\\/] to match the path separator instead of / to avoid potential issues on Windows.

  • ✅ Recommended: /node_modules[\\/]react/
  • ❌ Not recommended: /node_modules/react/

Released under the MIT License.