build: add rsbuild-plugin-publint (#569)

web-infra-dev · Dec 17, 2024 · 72587ed · 72587ed
1 parent 3d5312d
commit 72587ed
Show file tree

Hide file tree

Showing 9 changed files with 106 additions and 5 deletions.
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rslib",
+    "url": "git+https://github.com/web-infra-dev/rslib.git",
     "directory": "packages/core"
   },
   "license": "MIT",
@@ -50,6 +50,7 @@
     "memfs": "^4.15.0",
     "picocolors": "1.1.1",
     "prebundle": "1.2.5",
+    "rsbuild-plugin-publint": "^0.2.1",
     "rslib": "npm:@rslib/[email protected]",
     "rslog": "^1.2.3",
     "tsconfck": "3.1.4",

diff --git a/packages/core/rslib.config.ts b/packages/core/rslib.config.ts
@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import type { RsbuildPlugin } from '@rsbuild/core';
+import { pluginPublint } from 'rsbuild-plugin-publint';
 import { defineConfig } from 'rslib';
 
 const pluginFixDtsTypes: RsbuildPlugin = {
@@ -35,7 +36,7 @@ export default defineConfig({
       },
     },
   ],
-  plugins: [pluginFixDtsTypes],
+  plugins: [pluginFixDtsTypes, pluginPublint()],
   source: {
     entry: {
       index: './src/index.ts',

diff --git a/packages/create-rslib/package.json b/packages/create-rslib/package.json
@@ -5,7 +5,7 @@
   "homepage": "https://lib.rsbuild.dev",
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rslib",
+    "url": "git+https://github.com/web-infra-dev/rslib.git",
     "directory": "packages/create-rslib"
   },
   "license": "MIT",
@@ -37,6 +37,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.8.1",
     "fs-extra": "^11.2.0",
+    "rsbuild-plugin-publint": "^0.2.1",
     "rslib": "npm:@rslib/[email protected]",
     "tsx": "^4.19.2",
     "typescript": "^5.6.3"

diff --git a/packages/create-rslib/rslib.config.ts b/packages/create-rslib/rslib.config.ts
@@ -1,5 +1,7 @@
+import { pluginPublint } from 'rsbuild-plugin-publint';
 import { defineConfig } from 'rslib';
 
 export default defineConfig({
   lib: [{ format: 'esm' }],
+  plugins: [pluginPublint()],
 });
diff --git a/packages/plugin-dts/package.json b/packages/plugin-dts/package.json
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rslib",
+    "url": "git+https://github.com/web-infra-dev/rslib.git",
     "directory": "packages/plugin-dts"
   },
   "license": "MIT",
@@ -37,6 +37,7 @@
     "@microsoft/api-extractor": "^7.48.1",
     "@rsbuild/core": "~1.1.10",
     "@rslib/tsconfig": "workspace:*",
+    "rsbuild-plugin-publint": "^0.2.1",
     "rslib": "npm:@rslib/[email protected]",
     "typescript": "^5.6.3"
   },

diff --git a/packages/plugin-dts/rslib.config.ts b/packages/plugin-dts/rslib.config.ts
@@ -1,3 +1,4 @@
+import { pluginPublint } from 'rsbuild-plugin-publint';
 import { defineConfig } from 'rslib';
 
 export default defineConfig({
@@ -16,4 +17,5 @@ export default defineConfig({
       index: ['./src/**'],
     },
   },
+  plugins: [pluginPublint()],
 });
diff --git a/packages/plugin-dts/src/index.ts b/packages/plugin-dts/src/index.ts
@@ -161,6 +161,8 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
           }
         }
       },
+      // Set the order to 'post' to ensure that when DTS files of multiple formats are generated
+      // simultaneously, all errors are thrown together before exiting the process.
       order: 'post',
     });
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/dictionary.txt b/scripts/dictionary.txt
@@ -90,6 +90,7 @@ prebundle
 preflights
 prefresh
 preprocessors
+publint
 pxtorem
 quxx
 rebranded
@@ -135,10 +136,10 @@ unpatch
 unplugin
 unpredictibly
 unshift
+unstubAllEnvs
 upath
 vitest
 vnode
 watchpack
 webm
 webp
-unstubAllEnvs
-Original file line number
+Diff line change
@@ Expand Up @@
               }
             }
           },
+          // Set the order to 'post' to ensure that when DTS files of multiple formats are generated
+          // simultaneously, all errors are thrown together before exiting the process.
           order: 'post',
         });
@@ Expand Down @@