bundle-cop-vercel-plugin 0.1.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nadeem Ahmed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,17 +1,32 @@
 # bundle-cop-vercel-plugin
 
-Next.js adapter that attributes bundle cost to source files and enforces budgets during `next build`.
+[![npm version](https://img.shields.io/npm/v/bundle-cop-vercel-plugin.svg)](https://www.npmjs.com/package/bundle-cop-vercel-plugin)
+[![npm downloads](https://img.shields.io/npm/dm/bundle-cop-vercel-plugin.svg)](https://www.npmjs.com/package/bundle-cop-vercel-plugin)
+[![license](https://img.shields.io/npm/l/bundle-cop-vercel-plugin.svg)](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/blob/main/LICENSE)
+[![CI publish](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/actions/workflows/publish-npm.yml/badge.svg)](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/actions/workflows/publish-npm.yml)
+
+Next.js **adapter** that attributes client bundle cost to the importing source file and enforces size budgets during `next build`.
+
+| | |
+|---|---|
+| **npm** | [bundle-cop-vercel-plugin](https://www.npmjs.com/package/bundle-cop-vercel-plugin) |
+| **Source** | [nad33mahm3d/bundle-cop-vercel-plugin](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin) (`packages/vercel-plugin`) |
+| **Changelog** | [CHANGELOG.md](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/blob/main/CHANGELOG.md) |
+| **Issues** | [GitHub Issues](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/issues) |
+
+Part of the [Bundle Cop](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin) monorepo (adapter + Vercel integration app).
 
 ## Requirements
 
-- Next.js **16+** (Adapters API / `adapterPath`)
-- Node.js 20+
+- **Next.js 16+** (`adapterPath` / Adapters API)
+- **Node.js 20+**
 
 ## Install
 
 ```bash
 pnpm add bundle-cop-vercel-plugin
-# or: npm i bundle-cop-vercel-plugin
+# npm i bundle-cop-vercel-plugin
+# yarn add bundle-cop-vercel-plugin
 ```
 
 ## Setup
@@ -30,27 +45,48 @@ const nextConfig: NextConfig = {
 export default nextConfig
 ```
 
-Optional budgets — create `bundle-cop.config.json` in the project root:
+Use the **`/adapter`** export. Next loads adapters via `require.resolve` + ESM interop; the dedicated adapter entry exposes `onBuildComplete` correctly.
+
+### Optional budgets
+
+Create `bundle-cop.config.json` in the project root:
 
 ```json
 {
   "budgets": [
-    { "path": "/*", "maxSize": "250kb", "enforce": "warn" }
+    { "path": "/*", "maxSize": "250kb", "enforce": "warn" },
+    { "path": "/dashboard", "maxSize": "400kb", "enforce": "error" }
   ],
-  "suggestions": true
+  "ignore": [],
+  "suggestions": true,
+  "githubComment": true
 }
 ```
 
+- `enforce: "warn"` — logs over-budget routes  
+- `enforce: "error"` — fails the build  
+
 ## What it does
 
 On `onBuildComplete`:
 
-1. Parses `.next` diagnostics / chunks (Turbopack-aware fallbacks)
-2. Attributes heavy packages (e.g. `moment`) to the importing file
-3. Checks budgets (`warn` or fail build on `error`)
-4. Writes `bundle-report.json`
-5. Uploads to Vercel Blob when `BLOB_READ_WRITE_TOKEN` is set (`access: 'private'`)
+1. Parses `.next` diagnostics when present; otherwise uses route/chunk fallbacks (Turbopack-friendly)
+2. Attributes known heavy packages (e.g. `moment`, `lodash`) to the importing source file
+3. Enforces budgets from `bundle-cop.config.json`
+4. Writes `bundle-report.json` (and under `.vercel/output/static/` when possible)
+5. Uploads a **private** Blob report when `BLOB_READ_WRITE_TOKEN` is set
+
+## Environment (optional)
+
+| Variable | Purpose |
+|----------|---------|
+| `BLOB_READ_WRITE_TOKEN` | Upload private report to Vercel Blob |
+| `VERCEL_GIT_COMMIT_SHA` / `GITHUB_SHA` | Report key (commit SHA) |
+
+## Releases
+
+Versions are published from GitHub Releases. Tag `vX.Y.Z` → CI publishes the same version to npm. See the [repo README](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin#publishing-the-npm-package).
 
 ## License
 
-MIT
+[MIT](https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/blob/main/LICENSE)

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "bundle-cop-vercel-plugin",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Next.js adapter that attributes bundle cost to source files and enforces budgets",
   "license": "MIT",
+  "author": {
+    "name": "Nadeem Ahmed",
+    "url": "https://github.com/nad33mahm3d"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,12 +22,14 @@
       "require": "./next-adapter.cjs",
       "import": "./next-adapter.cjs",
       "default": "./next-adapter.cjs"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
     "next-adapter.cjs",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts --clean",
@@ -35,7 +41,7 @@
     "node": ">=20"
   },
   "peerDependencies": {
-    "next": ">=15"
+    "next": ">=16.0.0"
   },
   "dependencies": {
     "@vercel/blob": "^2.8.0"
@@ -47,16 +53,20 @@
     "typescript": "^5.8.2"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "keywords": [
     "nextjs",
+    "next.js",
     "vercel",
     "bundle",
+    "bundle-size",
     "webpack",
     "turbopack",
     "adapter",
-    "budget"
+    "budget",
+    "performance"
   ],
   "repository": {
     "type": "git",
@@ -66,5 +76,5 @@
   "bugs": {
     "url": "https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/issues"
   },
-  "homepage": "https://github.com/nad33mahm3d/bundle-cop-vercel-plugin#readme"
+  "homepage": "https://github.com/nad33mahm3d/bundle-cop-vercel-plugin/tree/main/packages/vercel-plugin#readme"
 }