prebundle 0.0.3 → 1.0.0

package/README.md

@@ -1,6 +1,15 @@
-# dep-pre-bundler
+# Prebundle
 
-This package is used to prebundle 3rd party dependencies, based on [ncc](https://github.com/vercel/ncc) and `dts-packer`.
+Prebundle 3rd party dependencies, output a single js file, a package.json file and the dts files.
+
+Based on [ncc](https://github.com/vercel/ncc) and `dts-packer`.
+
+<p>
+  <a href="https://npmjs.com/package/prebundle">
+   <img src="https://img.shields.io/npm/v/prebundle?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  </a>
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
+</p>
 
 ## Motivation
 
@@ -36,14 +45,17 @@ Supported dependency config:
 Externals to leave as requires of the build.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    externals: {
-      webpack: '../webpack',
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      externals: {
+        webpack: '../webpack',
+      },
     },
-  },
-];
+  ],
+};
 ```
 
 ### minify
@@ -51,12 +63,15 @@ dependencies: [
 Whether to minify the code, default `true`.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    minify: false,
-  },
-];
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      minify: false,
+    },
+  ],
+};
 ```
 
 ### packageJsonField
@@ -64,12 +79,15 @@ dependencies: [
 Copy extra fields from original package.json to target package.json.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    packageJsonField: ['options'],
-  },
-];
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      packageJsonField: ['options'],
+    },
+  ],
+};
 ```
 
 Following fields will be copied by default:
@@ -88,14 +106,17 @@ Following fields will be copied by default:
 Callback before bundle.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    beforeBundle(task) {
-      console.log('do something');
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      beforeBundle(task) {
+        console.log('do something');
+      },
     },
-  },
-];
+  ],
+};
 ```
 
 ### emitFiles
@@ -103,17 +124,20 @@ dependencies: [
 Emit extra entry files to map imports.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    emitFiles: [
-      {
-        path: 'foo.js',
-        content: `module.exports = require('./').foo;`,
-      },
-    ],
-  },
-];
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      emitFiles: [
+        {
+          path: 'foo.js',
+          content: `module.exports = require('./').foo;`,
+        },
+      ],
+    },
+  ],
+};
 ```
 
 ### ignoreDts
@@ -123,10 +147,13 @@ Ignore the original .d.ts declaration file, then generate a fake .d.ts file.
 This can be used to reduce file size for the packages that do not require type definitions, such as webpack plugin.
 
 ```ts
-dependencies: [
-  {
-    name: 'foo',
-    ignoreDts: true,
-  },
-];
+// prebundle.config.mjs
+export default {
+  dependencies: [
+    {
+      name: 'foo',
+      ignoreDts: true,
+    },
+  ],
+};
 ```

package/dist/index.d.ts

@@ -1 +1,2 @@
 export declare function run(): Promise<void>;
+export type { Config } from './types.js';

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "prebundle",
-  "version": "0.0.3",
+  "version": "1.0.0",
   "main": "./dist/index.js",
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rspack-contrib/prebundle"
+  },
   "files": [
     "dist",
     "bin.js"