feat: add enable option

README.md

@@ -24,10 +24,9 @@ Install:
 npm add rsbuild-plugin-publint -D
 ```
 
-Add plugin to your `rsbuild.config.ts`:
+Add plugin to your `rslib.config.ts` or `rsbuild.config.ts`:
 
 ```ts
-// `rslib.config.ts` or `rsbuild.config.ts`
 import { pluginPublint } from "rsbuild-plugin-publint";
 
 export default {
@@ -37,6 +36,21 @@ export default {
 
 ## Options
 
+### enable
+
+Whether to enable publint.
+
+- Type: `boolean`
+- Default: `true`
+
+For example, only run publint in the CI environment:
+
+```ts
+pluginPublint({
+  enable: Boolean(process.env.CI),
+});
+```
+
 ### publintOptions
 
 Options for publint. See [publint - API](https://github.com/bluwy/publint/blob/master/pkg/README.md#api) for more details.

src/index.ts

@@ -5,6 +5,11 @@ import color from 'picocolors';
 import type { Options } from 'publint';
 
 export type PluginPublintOptions = {
+  /**
+   * Whether to enable publint.
+   * @default true
+   */
+  enable?: boolean;
   /**
    * Options for publint.
    * @see https://github.com/bluwy/publint/blob/master/pkg/README.md#api
@@ -18,6 +23,12 @@ export const pluginPublint = (
   name: 'plugin-publint',
 
   setup(api) {
+    const { enable = true } = options;
+
+    if (!enable) {
+      return;
+    }
+
     api.onAfterBuild(async () => {
       const { publint } = await import('publint');
       const { formatMessage } = await import('publint/utils');

test/basic/index.test.ts

@@ -68,3 +68,18 @@ test('should allow to pass publint options', async () => {
 
   restore();
 });
+
+test('should allow to disable publint', async () => {
+  const rsbuild = await createRsbuild({
+    cwd: __dirname,
+    rsbuildConfig: {
+      plugins: [
+        pluginPublint({
+          enable: false,
+        }),
+      ],
+    },
+  });
+
+  await expect(rsbuild.build()).resolves.toBeTruthy();
+});