@jchat/create-addon 1.0.0-alpha.10 → 1.0.0-alpha.11
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/CHANGELOG.md +2 -0
- package/README.md +49 -20
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,39 +1,68 @@
|
|
|
1
1
|
# @jchat/create-addon
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Official CLI scaffolding tool for generating self-contained [JChat](https://jchat.im) addon development workspaces and sandboxes.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
Scaffold a new addon project with zero configuration:
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
12
|
bunx @jchat/create-addon <addon-id>
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
### Options
|
|
14
|
-
|
|
15
|
-
- `<addon-id>`: (Required) The unique ID for your addon, typically hyphenated (e.g., `weather-addon`).
|
|
16
|
-
- `--target=<directory>`: (Optional) The directory to generate the workspace in. Defaults to `../<addon-id>` relative to the current working directory.
|
|
17
|
-
- `--image=<image>`: (Optional) A specific Docker / Podman container image to use for the sandbox environment. Defaults to `ghcr.io/mjjabarullah/jchat-sandbox`.
|
|
18
|
-
|
|
19
15
|
### Example
|
|
20
16
|
|
|
21
17
|
```bash
|
|
22
|
-
bunx @jchat/create-addon
|
|
23
|
-
cd
|
|
18
|
+
bunx @jchat/create-addon poll-manager
|
|
19
|
+
cd poll-manager
|
|
20
|
+
|
|
21
|
+
# Start local live development with hot module reloading
|
|
22
|
+
bun dev
|
|
24
23
|
```
|
|
25
24
|
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Workspace Structure
|
|
28
|
+
|
|
29
|
+
The generated workspace includes a complete, isolated development kit:
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
my-addon/
|
|
33
|
+
├── addon/
|
|
34
|
+
│ ├── src/
|
|
35
|
+
│ │ ├── manifest.ts # Addon configuration & permissions
|
|
36
|
+
│ │ ├── ui.tsx # Frontend UI component
|
|
37
|
+
│ │ ├── db.ts # Optional Kysely schema definitions
|
|
38
|
+
│ │ └── locales/ # Multi-language translations
|
|
39
|
+
│ ├── package.json
|
|
40
|
+
│ ├── tsconfig.json
|
|
41
|
+
│ └── vite.config.ts
|
|
42
|
+
├── docker-compose.yml # Local sandbox environment
|
|
43
|
+
├── package.json # Workspace automation scripts
|
|
44
|
+
└── README.md
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## CLI Options
|
|
50
|
+
|
|
51
|
+
| Option | Description | Default |
|
|
52
|
+
| :---------------- | :------------------------------------------------------------------ | :----------------------------------- |
|
|
53
|
+
| `<addon-id>` | **Required**. Unique identifier (lowercase alphanumeric & hyphens). | — |
|
|
54
|
+
| `--target=<dir>` | Target output directory for the scaffolded workspace. | `./<addon-id>` |
|
|
55
|
+
| `--image=<image>` | Specific container image for the JChat sandbox runtime. | `ghcr.io/mjjabarullah/jchat-sandbox` |
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
26
59
|
## Requirements
|
|
27
60
|
|
|
28
|
-
- Bun 1.
|
|
29
|
-
- Docker or Podman
|
|
61
|
+
- **Bun**: 1.4.0+
|
|
62
|
+
- **Docker** or **Podman** (for running the local interactive sandbox environment)
|
|
30
63
|
|
|
31
|
-
|
|
64
|
+
---
|
|
32
65
|
|
|
33
|
-
|
|
34
|
-
You retain ownership of the original code and content you add to a generated project and may choose
|
|
35
|
-
the license for that original work. Any JChat-authored template portions and third-party components
|
|
36
|
-
remain subject to their respective licenses and notices.
|
|
66
|
+
## License
|
|
37
67
|
|
|
38
|
-
|
|
39
|
-
subject to the applicable JChat and addon marketplace terms.
|
|
68
|
+
Proprietary — All rights reserved. See the [LICENSE](./LICENSE) file included in this package for full terms and conditions.
|