rollup-plugin-code-raker

A Rollup/Vite plugin that rakes your bundle to remove dead leaves.

Features

• Removes leftover comments, console.* calls and debugger statements from your bundle.
• Does not come in the way of treeshaking: remaining function annotations are removed after Rollup/Vite did their magic.
• Fully configurable.
• Comes with sensible defaults for both application and library bundling.

Requirements

This plugin requires Rollup 4 or later or Vite 5 or later.

Usage

Install the plugin using your favorite package manager:

1npm install --save-dev rollup-plugin-code-raker

Then import the plugin in your rollup.config.js/vite.config.js:

1import rake from 'rollup-plugin-code-raker'
2
3export default {
4    ...
5    plugins: [
6        rake(/* options */)
7    ]
8}

Options

code-raker uses presets to decide what to remove from code.

• The default preset is a "kill'em all" preset that blindly removes all comments (including licensing and documentation comments), all console.* calls and debugger statements.
• The application preset preserves licensing comments and console.info, console.warn, console.error and console.debug calls.
• The library preset preserves licensing and documentation comments.

[!NOTE]

• Licensing comments are block comments that start with /*! followed by a space or a newline, or documentation comments that contain the @license tag.
• Documentation, or JsDoc/TsDoc comments, are block comments that start with /** followed by a space or a newline.
• Annotations are block comments that contain one of these strings: #__PURE__, @__PURE__, #__NO_SIDE_EFFECTS__, @__NO_SIDE_EFFECTS__. See https://rollupjs.org/configuration-options/#treeshake-annotations for more info.

All options are optional.

1export interface Options {
2    /**
3     * The name of a preset to use or extend upon.
4     *
5     * Default: undefined.
6     */
7    preset?: 'library' | 'application'
8
9    /**
10     * Set to `true` to remove all comments, `false` to remove none, or an object
11     * to only remove select comments.
12     *
13     * Default depends on the selected preset:
14     * - default: remove all comments.
15     * - library: preserve licensing and JsDoc/TsDoc comments, remove everything else.
16     * - application: preserve licensing comments, remove everything else.
17     *
18     * Note that this setting only targets "meaningful" comments; common block comments (`/*`)
19     * and line comments (`//`) are always removed.
20     */
21    comments?: boolean | {
22        /**
23         * Whether to remove licensing comments.
24         */
25        licenses?: boolean | ((comment: string) => boolean)
26
27        /**
28         * Whether to remove documentation comments.
29         */
30        docs?: boolean | ((comment: string) => boolean)
31
32        /**
33         * Whether to remove annotations.
34         */
35        annotations?: boolean
36    }
37
38    /**
39     * Set to `true` to remove all `console` calls, `false` to remove none, or a callback
40     * or an object to only remove select `console` calls.
41     *
42     * Default depends on the selected preset:
43     * - default: remove all `console` methods calls.
44     * - library: remove all `console` methods calls.
45     * - application: preserve `info`, `warn`, `error` and `debug` methods calls,
46     *   remove all others.
47     */
48    console?:  boolean | ((method: string, statement: string) => boolean) | {
49        /**
50         * An array of console methods names to remove.
51         */
52        include?: string[]
53        /**
54         * An array of console methods names to preserve.
55         */
56        exclude?: string[]
57    }
58
59    /**
60     * Set to `true` to remove `debugger` statements, or `false` to leave them in code.
61     *
62     * Default: `true` in all presets.
63     */
64    debugger?: boolean
65}

License

MIT.