addfox 0.1.1-beta.1 → 0.1.1-beta.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 addfox
+
+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,158 +1,54 @@
-[中文](README-zh_CN.md) | English
-
----
-
-<p align="center">
-  <img width="230" src="addmo.png">
-</p>
-
-<h1 align="center">
-Addmo
-</h1>
 <p align="center">
-Browser extension development framework built on Rsbuild
+  <img width="200" src="addfox.png" alt="Addfox">
 </p>
 
-Browser extension development involves more complex debugging, so we use **full-bundle mode** to minimize the gap between dev and production. Thanks to **Rsbuild’s performance**, addmo uses **build watch** for hot reload—same bundled output in dev and production, without sacrificing build speed.
+<h1 align="center">Addfox</h1>
+<p align="center">Browser extension framework built on Rsbuild</p>
 
-## Quick start
+<div align="center">
+  <a href="https://addfox.dev">Documentation</a> · <a href="https://www.npmjs.com/package/addfox">npm</a> · <a href="https://github.com/addfox/skills">Skills</a>
+</div>
 
-### Option 1: Scaffold a new project
+---
 
-```bash
-pnpm create addmo-app
-# or
-npx create-addmo-app
-```
+## Features
 
-Follow the prompts: (1) framework (Vanilla / Vue / React / Preact / Svelte / Solid), (2) language (TypeScript / JavaScript), (3) package manager (pnpm / npm / yarn / bun), (4) entries to include, (5) whether to install addmo skills. A full project layout and `addmo.config` will be generated.
+- 🔥 **Fast dev mode and hot reload** — `addfox dev` runs watch, rebuilds on change, and hot-reloads the extension in the browser; the browser launches automatically; same bundle as production.
+- 📦 **Auto-generated zip** — After `addfox build`, output is packed into a zip under `.addfox` by default; one command for both folder and store-ready zip.
+- 📁 **File-based entries** — Entries are discovered from `app/` layout (background, content, popup, options, sidepanel, devtools); override or add custom entries in config when needed.
+- 🌐 **Many Chromium browsers and Firefox** — Use `-b chrome|edge|brave|vivaldi|opera|firefox|...` to target Chrome, Edge, Brave, Vivaldi, Opera, Arc, Yandex, or Firefox; manifest can be split per browser.
+- ⚛️ **Framework-agnostic** — Vue, React, Svelte, Solid, or vanilla; TypeScript or JavaScript; choose in scaffold or add the plugin you need.
+- 🤖 **AI-friendly error output** — Enable `--debug` for a dev-only error panel with per-entry errors, Copy prompt, Ask ChatGPT, and Ask Cursor in one click.
+- 🧪 **Rstest support** — Run `addfox test` for unit and e2e tests; arguments are forwarded to Rstest.
+- 📊 **Rsdoctor bundle analysis** — Add `--report` to build or dev to open the Rsdoctor analysis report after the build.
+- 🧩 **Full Skills support** — Install [addfox/skills](https://github.com/addfox/skills) via create-addfox-app or `skills add`; AI workflow modules in `.agents/skills/`.
+- 🔐 **Env variable support** — `.env` is loaded; `envPrefix` controls which vars are exposed to the extension (e.g. `PUBLIC_`).
 
-### Option 2: Add to an existing project
+## Install & use
 
-Install the main package **addmo** as a **dev dependency** (build tool; one install gives you the CLI and all build tooling; internally it uses `@addmo/cli` and `@rsbuild/core`):
+**New project:**
 
 ```bash
-pnpm add -D addmo
-# or
-npm install -D addmo
-# or
-yarn add -D addmo
+pnpm create addfox-app
+# or: npx create-addfox-app
 ```
 
-Create `addmo.config.ts` (or `addmo.config.js` / `addmo.config.mjs`) in the project root and configure it as below. Your layout must include entries such as `background`, `content`, `popup`, `options`, `sidepanel` (under `app/` by default or under a dir set via `appDir`).
-
-### Packages and imports
-
-- **Core** (`defineConfig`, types, discovery, manifest, etc.) is exported from **addmo**. In config use: `import { defineConfig } from "addmo"`.
-- **Content UI** is in **`@addmo/utils`**: `import { defineContentUI, mountContentUI } from "@addmo/utils"`. For the `browser` API, install [webextension-polyfill](https://github.com/mozilla/webextension-polyfill) and use `import browser from "webextension-polyfill"`.
-
-## Config
-
-Config file: `addmo.config.ts`, `addmo.config.js`, or `addmo.config.mjs`.
-
-Return a config object from `defineConfig`. Supported fields:
-
-| Field | Description |
-|-------|-------------|
-| **manifest** | Extension manifest. Single object or split as `chromium` / `firefox` |
-| **plugins** | Rsbuild plugins array (like Vite). Use function calls, e.g. `plugins: [vue()]` (from `@addmo/rsbuild-plugin-vue`) or `plugins: [pluginReact()]` (from `@rsbuild/plugin-react`) |
-| **rsbuild** | Override or extend Rsbuild config (like Vite’s build options). **Object**: deep-merged with base. **Function**: `(base, helpers) => config` for full control; use `helpers.merge(base, overrides)` for deep-merge |
-| **entry** | Custom entries: object, key = entry name (reserved: popup, options, sidepanel, background, devtools, content; others custom), value = path string relative to baseDir (e.g. `'content/index.ts'`). Omit to use default discovery from appDir |
-| **appDir** | App directory; default is `app/`. Also the base for **entry** paths |
-| **outDir** | Output directory name under `.addmo`; default `"extension"` (output at `.addmo/extension`) |
-| **browserPath** | Dev browser executable paths. `browserPath.chrome`, `browserPath.firefox`, etc.; used when running `addmo dev`. If unset, uses OS default install paths |
-| **hooks** | Lifecycle hooks at “parse CLI → load config → build Rsbuild config → run build”. See “Lifecycle hooks” below |
-
-### Lifecycle hooks
-
-Configure `hooks` in `defineConfig`. Each hook receives `PipelineContext` (root, command, browser, config, entries, rsbuild, etc.):
-
-| Hook | When |
-|------|------|
-| **afterCliParsed** | After CLI args (command, -b) are parsed |
-| **afterConfigLoaded** | After config and entries are resolved |
-| **beforeRsbuildConfig** | After manifest and entries are fixed, before Rsbuild config is built |
-| **beforeBuild** | After Rsbuild config is ready, before build runs |
-| **afterBuild** | After build finishes (only for `addmo build`; dev runs watch and does not exit) |
-
-### Errors and exit codes
+Choose framework (Vanilla / Vue / React / Preact / Svelte / Solid), language, package manager, entries, and optional [Skills](https://github.com/addfox/skills). A full layout and `addfox.config` are generated.
 
-On missing config, no entries, invalid command or invalid `-b`, the CLI throws **AddmoError** (with `code`, `details`, `hint`), prints a clear message to stderr and exits with a non-zero code. Error codes are exported from `addmo` as `ADDMO_ERROR_CODES`.
+**Existing project:**
 
-### Config example
-
-```ts
-import { defineConfig } from "addmo";
-import vue from "@addmo/rsbuild-plugin-vue";
-
-export default defineConfig({
-  appDir: "app",
-  outDir: "extension",
-  manifest: {
-    name: "My Extension",
-    version: "1.0.0",
-    manifest_version: 3,
-    permissions: ["storage", "activeTab"],
-  },
-  plugins: [vue()],
-  // browserPath: { chrome: "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", firefox: "..." },
-  // rsbuild: (base, helpers) => helpers.merge(base, { ... }),
-  // entry: { background: "background/index.ts", content: "content/index.ts", popup: "popup/index.ts" },
-  // hooks: { beforeBuild: (ctx) => console.log("Building for", ctx.browser) },
-});
+```bash
+pnpm add -D addfox
 ```
 
-## Directory and entry convention
-
-- By default, entries are discovered under **app/** or **appDir** (baseDir). You can override with **entry**:
-  - **background**, **content**: script only
-  - **popup**, **options**, **sidepanel**, **devtools**: require `index.html` + entry script in the same dir
-  - Reserved names (fixed): popup, options, sidepanel, background, devtools, content; other names are custom
-  - **entry** values are paths relative to baseDir, e.g. `'content/index.ts'`, `'src/popup/index.ts'`
-
-## Commands
-
-In a project that has addmo installed:
-
-- `addmo dev` or `pnpm dev` (if `"dev": "addmo dev"` in package.json): dev mode with watch and HMR (Reload Manager extension + local WebSocket)
-- `addmo build`: production build to `.addmo/<outDir>` (default `outDir` is `"extension"`); optionally zips to `.addmo/<outDir>.zip`
-
-**Terminal output**: When running `addmo dev` or `addmo build`, each line is prefixed with **`[addmo]`** so you can tell addmo’s output from Rsbuild’s; full Rsbuild logs and errors are unchanged.
-
-Use **`-b, --browser <browser>`** to choose the target browser (and thus manifest branch and dev browser): `chromium`, `firefox`, `chrome`, `edge`, `brave`, etc.
-
-- `addmo dev -b chrome` / `addmo dev -b firefox`
-- `addmo build -b chrome` / `addmo build -b firefox`
+Add `addfox.config.ts` (or `.js` / `.mjs`) in the project root and entries under `app/` (or `appDir`). Then:
 
-Default is Chrome if `-b` is omitted. The target is determined only by `-b`, not by env vars.
+- `addfox dev` — dev with watch + HMR
+- `addfox build` — output to `.addfox/extension` (and optional zip)
 
-## Dependencies
+Use `-b chrome` or `-b firefox` to target a browser.
 
-The framework follows common practice: **recommended dev dependencies** are checked before build and **installed automatically** when missing (using the project’s package manager: pnpm / npm / yarn / bun).
-
-- **Extension development**: `@types/chrome` (Chrome extension API types) is installed as a dev dependency if not already in the project.
-- **Plugins**: If you use `plugins: [vue()]`, the CLI ensures `vue` is installed. For React, use `@rsbuild/plugin-react` and add `react` and `react-dom` (and `@rsbuild/plugin-react`) to your project.
-
-To skip auto-install (e.g. in CI or when you manage deps yourself), set **`ADDMO_SKIP_DEPS=1`**.
-
-- **addmo** brings in `@addmo/cli`, `@rsbuild/core`, and the framework plugins; you only need to add **addmo** to your project. Use `addmo dev` and `addmo build` in your scripts.
-
-## Dev HMR
-
-In dev, a WebSocket server is started and the extension is reloaded after each build. The Rsbuild plugin opens the browser and loads the extension after the first build; later rebuilds trigger a reload via WebSocket.
-
-Browser paths: set **browserPath** in config to override; otherwise the framework tries OS default paths (Windows / macOS / Linux).
-
-## Repo structure
-
-- `packages/addmo`: **addmo** – main package users install; provides the `addmo` binary and delegates to `@addmo/cli` (same idea as installing `parcel` while internals live in `@parcel/*`)
-- `packages/cli`: **@addmo/cli** – CLI entry and **Pipeline** (parse → config → Rsbuild config → hooks; injects ConfigLoader / CliParser)
-- `packages/core`: Core modules; filenames match class names (camelCase): **ConfigLoader** (configLoader.ts), **CliParser** (cliParser.ts), **EntryDiscoverer** (entryDiscoverer.ts), **EntryResolver** (entryResolver.ts), **ManifestBuilder** (manifestBuilder.ts); constants, AddmoError, mergeRsbuildConfig, defineConfig, types
-- `packages/utils`: Utilities (webextension-polyfill etc.); use `@addmo/utils` as needed
-- `packages/plugins/rsbuild-plugin-extension-entry`: **Internal** – resolves dirs and entries, sets entry/html/output (package: `@addmo/rsbuild-plugin-extension-entry`)
-- `packages/plugins/rsbuild-plugin-extension-manifest`: **Internal** – writes manifest.json (package: `@addmo/rsbuild-plugin-extension-manifest`)
-- `packages/plugins/rsbuild-plugin-extension-hmr**: **Internal** – dev HMR and browser launch
-- `packages/plugins/rsbuild-plugin-vue`: Vue 3 + Vue JSX + Less + Babel; use `plugins: [vue()]`
-- `packages/create-addmo-app`: Scaffold CLI; generates project with `plugins: [vue()]` or `plugins: [pluginReact()]` (use `@rsbuild/plugin-react` for React)
+---
 
-The framework runs rsbuild-plugin-extension-entry, rsbuild-plugin-extension-manifest and rsbuild-plugin-extension-hmr by default. Users add framework plugins via `plugins: [vue()]` etc. and override Rsbuild via `rsbuild`.
+**Full docs, config reference, and examples:** [https://addfox.dev](https://addfox.dev)  
+**Skills (AI workflow modules):** [https://github.com/addfox/skills](https://github.com/addfox/skills)

package/bin/addfox.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// Delegates to @addfox/cli — users install "addfox", internals stay @addfox/*
+import "@addfox/cli/dist/cli.js";

package/index.d.ts

@@ -1,2 +1,2 @@
-export * from "@addmo/core";
-export { setupAddmoMonitor } from "@addmo/rsbuild-plugin-extension-monitor/runtime";
+export * from "@addfox/core";
+export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";

package/index.mjs

@@ -1,2 +1,2 @@
-export * from "@addmo/core";
-export { setupAddmoMonitor } from "@addmo/rsbuild-plugin-extension-monitor/runtime";
+export * from "@addfox/core";
+export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "addfox",
-  "version": "0.1.1-beta.1",
-  "description": "Build tool for browser extensions — one install, addmo dev / build",
+  "version": "0.1.1-beta.3",
+  "description": "Build tool for browser extensions — one install, addfox dev / build",
   "type": "module",
   "bin": {
-    "addmo": "./bin/addmo.mjs"
+    "addfox": "./bin/addfox.mjs"
   },
   "main": "./index.mjs",
   "module": "./index.mjs",
@@ -26,14 +26,14 @@
     "index.mjs",
     "index.d.ts"
   ],
+  "dependencies": {
+    "@addfox/cli": "0.1.1-beta.2",
+    "@addfox/core": "0.1.1-beta.2",
+    "@addfox/rsbuild-plugin-extension-monitor": "0.1.1-beta.2"
+  },
   "scripts": {
     "build": "echo 'No build step'",
     "test": "node -e \"process.exit(0)\"",
     "test:coverage": "node -e \"process.exit(0)\""
-  },
-  "dependencies": {
-    "@addmo/cli": "workspace:*",
-    "@addmo/core": "workspace:*",
-    "@addmo/rsbuild-plugin-extension-monitor": "workspace:*"
   }
-}
+}

package/bin/addmo.mjs

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-// Delegates to @addmo/cli — users install "addmo", internals stay @addmo/*
-import "@addmo/cli/dist/cli.js";