addfox 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -54
- package/index.d.ts +2 -2
- package/index.mjs +2 -2
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
<p align="center">
|
|
2
|
-
<img width="200" src="https://raw.githubusercontent.com/addfox/addfox/main/addfox.png" alt="Addfox">
|
|
3
|
-
</p>
|
|
4
|
-
|
|
5
|
-
<h1 align="center">Addfox</h1>
|
|
6
|
-
<p align="center">Browser extension framework built on Rsbuild</p>
|
|
7
|
-
|
|
8
|
-
<div align="center">
|
|
9
|
-
<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>
|
|
10
|
-
</div>
|
|
11
|
-
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
## Features
|
|
15
|
-
|
|
16
|
-
- 🔥 **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.
|
|
17
|
-
- 📦 **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.
|
|
18
|
-
- 📁 **File-based entries** — Entries are discovered from `app/` layout (background, content, popup, options, sidepanel, devtools); override or add custom entries in config when needed.
|
|
19
|
-
- 🌐 **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.
|
|
20
|
-
- ⚛️ **Framework-agnostic** — Vue, React, Svelte, Solid, or vanilla; TypeScript or JavaScript; choose in scaffold or add the plugin you need.
|
|
21
|
-
- 🤖 **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.
|
|
22
|
-
- 🧪 **Rstest support** — Run `addfox test` for unit and e2e tests; arguments are forwarded to Rstest.
|
|
23
|
-
- 📊 **Rsdoctor bundle analysis** — Add `--report` to build or dev to open the Rsdoctor analysis report after the build.
|
|
24
|
-
- 🧩 **Full Skills support** — Install [addfox/skills](https://github.com/addfox/skills) via create-addfox-app or `skills add`; AI workflow modules in `.agents/skills/`.
|
|
25
|
-
- 🔐 **Env variable support** — `.env` is loaded; `envPrefix` controls which vars are exposed to the extension (e.g. `PUBLIC_`).
|
|
26
|
-
|
|
27
|
-
## Install & use
|
|
28
|
-
|
|
29
|
-
**New project:**
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
pnpm create addfox-app
|
|
33
|
-
# or: npx create-addfox-app
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
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.
|
|
37
|
-
|
|
38
|
-
**Existing project:**
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
pnpm add -D addfox
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Add `addfox.config.ts` (or `.js` / `.mjs`) in the project root and entries under `app/` (or `appDir`). Then:
|
|
45
|
-
|
|
46
|
-
- `addfox dev` — dev with watch + HMR
|
|
47
|
-
- `addfox build` — output to `.addfox/extension` (and optional zip)
|
|
48
|
-
|
|
49
|
-
Use `-b chrome` or `-b firefox` to target a browser.
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
**Full docs, config reference, and examples:** [https://addfox.dev](https://addfox.dev)
|
|
54
|
-
**Skills (AI workflow modules):** [https://github.com/addfox/skills](https://github.com/addfox/skills)
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img width="200" src="https://raw.githubusercontent.com/addfox/addfox/main/addfox.png" alt="Addfox">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Addfox</h1>
|
|
6
|
+
<p align="center">Browser extension framework built on Rsbuild</p>
|
|
7
|
+
|
|
8
|
+
<div align="center">
|
|
9
|
+
<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>
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
- 🔥 **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.
|
|
17
|
+
- 📦 **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.
|
|
18
|
+
- 📁 **File-based entries** — Entries are discovered from `app/` layout (background, content, popup, options, sidepanel, devtools); override or add custom entries in config when needed.
|
|
19
|
+
- 🌐 **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.
|
|
20
|
+
- ⚛️ **Framework-agnostic** — Vue, React, Svelte, Solid, or vanilla; TypeScript or JavaScript; choose in scaffold or add the plugin you need.
|
|
21
|
+
- 🤖 **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.
|
|
22
|
+
- 🧪 **Rstest support** — Run `addfox test` for unit and e2e tests; arguments are forwarded to Rstest.
|
|
23
|
+
- 📊 **Rsdoctor bundle analysis** — Add `--report` to build or dev to open the Rsdoctor analysis report after the build.
|
|
24
|
+
- 🧩 **Full Skills support** — Install [addfox/skills](https://github.com/addfox/skills) via create-addfox-app or `skills add`; AI workflow modules in `.agents/skills/`.
|
|
25
|
+
- 🔐 **Env variable support** — `.env` is loaded; `envPrefix` controls which vars are exposed to the extension (e.g. `PUBLIC_`).
|
|
26
|
+
|
|
27
|
+
## Install & use
|
|
28
|
+
|
|
29
|
+
**New project:**
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pnpm create addfox-app
|
|
33
|
+
# or: npx create-addfox-app
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
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.
|
|
37
|
+
|
|
38
|
+
**Existing project:**
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pnpm add -D addfox
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Add `addfox.config.ts` (or `.js` / `.mjs`) in the project root and entries under `app/` (or `appDir`). Then:
|
|
45
|
+
|
|
46
|
+
- `addfox dev` — dev with watch + HMR
|
|
47
|
+
- `addfox build` — output to `.addfox/extension` (and optional zip)
|
|
48
|
+
|
|
49
|
+
Use `-b chrome` or `-b firefox` to target a browser.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
**Full docs, config reference, and examples:** [https://addfox.dev](https://addfox.dev)
|
|
54
|
+
**Skills (AI workflow modules):** [https://github.com/addfox/skills](https://github.com/addfox/skills)
|
package/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from "@addfox/core";
|
|
2
|
-
export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";
|
|
1
|
+
export * from "@addfox/core";
|
|
2
|
+
export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";
|
package/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from "@addfox/core";
|
|
2
|
-
export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";
|
|
1
|
+
export * from "@addfox/core";
|
|
2
|
+
export { setupAddfoxMonitor } from "@addfox/rsbuild-plugin-extension-monitor/runtime";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "addfox",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Build tool for browser extensions — one install, addfox dev / build",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -39,9 +39,9 @@
|
|
|
39
39
|
},
|
|
40
40
|
"homepage": "https://addfox.dev",
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@addfox/cli": "0.
|
|
43
|
-
"@addfox/core": "0.
|
|
44
|
-
"@addfox/rsbuild-plugin-extension-monitor": "0.
|
|
42
|
+
"@addfox/cli": "0.2.0",
|
|
43
|
+
"@addfox/core": "0.2.0",
|
|
44
|
+
"@addfox/rsbuild-plugin-extension-monitor": "0.2.0"
|
|
45
45
|
},
|
|
46
46
|
"scripts": {
|
|
47
47
|
"build": "echo 'No build step'",
|