create-zenith-plugin 0.1.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 +87 -0
- package/dist/cli.js +2864 -0
- package/dist/index.js +2864 -0
- package/package.json +25 -0
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# ⚡ create-zenith-plugin
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<img src="https://raw.githubusercontent.com/zenithbuild/zenith/main/assets/logos/logo.png" alt="Zenith Logo" width="160" />
|
|
5
|
+
<h2>The Zero-Friction Zenith Plugin Scaffolder</h2>
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/create-zenith-plugin)
|
|
8
|
+
[](https://github.com/zenithbuild/zenith)
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 🚀 Overview
|
|
14
|
+
|
|
15
|
+
**`create-zenith-plugin`** is a lightning-fast, zero-friction CLI designed to jumpstart your Zenith plugin development. Our philosophy is simple: **One step, zero questions.**
|
|
16
|
+
|
|
17
|
+
No more nested directory hell or confusing configuration steps. Just run the command, select a template, and start coding your next breakthrough.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 🛠️ Installation & Usage
|
|
22
|
+
|
|
23
|
+
You don't even need to install it globally. Run it directly with your favorite package manager:
|
|
24
|
+
|
|
25
|
+
### Using Bun (Recommended)
|
|
26
|
+
```bash
|
|
27
|
+
bunx create-zenith-plugin <plugin-name>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Using npx
|
|
31
|
+
```bash
|
|
32
|
+
npx create-zenith-plugin <plugin-name>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## ✨ Key Features
|
|
38
|
+
|
|
39
|
+
- 🎯 **One-Step Scaffolding**: Automatically creates a folder in your current directory with everything you need.
|
|
40
|
+
- 📂 **Zero-Wrapper Principle**: No more `zenith-plugins/` parent folders unless you explicitly want them.
|
|
41
|
+
- ⚡ **Professional Templates**: Choose between **Utility**, **Theme**, or **Content** patterns.
|
|
42
|
+
- 📖 **Comprehensive READMEs**: Every generated plugin comes with its own professional, documentation-ready README.
|
|
43
|
+
- 🧩 **Type Safety**: Full TypeScript support out of the box.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 📂 Generated Structure
|
|
48
|
+
|
|
49
|
+
When you run `create-zenith-plugin my-plugin`, you get:
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
my-plugin/
|
|
53
|
+
├── index.ts # Main logic & setup hook
|
|
54
|
+
├── types.ts # Typed configuration options
|
|
55
|
+
├── utils/ # Empty helper directory
|
|
56
|
+
└── README.md # Professional documentation
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🎨 Scaffolding Templates
|
|
62
|
+
|
|
63
|
+
| Template | Focus | Best For |
|
|
64
|
+
| :--- | :--- | :--- |
|
|
65
|
+
| **Utility** | Generic Stub | Logic-heavy plugins, API integrations |
|
|
66
|
+
| **Theme** | Styling | TailwindCSS extensions, Design systems |
|
|
67
|
+
| **Content** | Rendering | Markdown parsers, CMS connectors |
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 🤝 Contributing
|
|
72
|
+
|
|
73
|
+
Coming Soon!
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 🩺 Troubleshooting
|
|
78
|
+
|
|
79
|
+
**Q: Command not found?**
|
|
80
|
+
A: Ensure you are using `bunx` or `npx`. If you want it globally, run `npm install -g create-zenith-plugin`.
|
|
81
|
+
|
|
82
|
+
**Q: Directory already exists?**
|
|
83
|
+
A: The CLI will prompt you to overwrite. Use `--overwrite` to skip the prompt.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
*Built with ❤️ for the [Zenith Ecosystem](https://github.com/zenithbuild/zenith)*
|