@quincarter/create-lit-app 1.0.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 +73 -0
- package/create-app-shell.sh +1741 -0
- package/man/create-lit-app.1 +74 -0
- package/package.json +38 -0
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @quincarter/create-lit-app ⚡
|
|
2
|
+
|
|
3
|
+
> Interactive CLI initializer to scaffold production-ready Lit Element applications with an App Shell architecture, Preact Signals, Lit Context, Lit Router, and UI component suites.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
Run instantly with `npx` (no pre-installation required):
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @quincarter/create-lit-app
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Or pass a project name directly:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx @quincarter/create-lit-app my-app
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Starter Templates
|
|
22
|
+
|
|
23
|
+
When prompted, you can choose from three starter presets:
|
|
24
|
+
|
|
25
|
+
1. **Full App Shell Starter**: header, navigation, router, contexts, signals Todo List, cards, charts, and MFE loader.
|
|
26
|
+
2. **Blank App Shell Host**: minimal Lit App host container with App Shell foundations.
|
|
27
|
+
3. **Custom Selection**: interactively toggle specific architectural features and component showcases.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## CLI Options & Flags
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx @quincarter/create-lit-app [options]
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Options Overview
|
|
38
|
+
|
|
39
|
+
| Flag | Description | Default |
|
|
40
|
+
| :--- | :--- | :--- |
|
|
41
|
+
| `--name=<name>` | Project directory / package name | `my-app-shell` |
|
|
42
|
+
| `--template=<type>` | Preset: `full` \| `blank` \| `custom` | `full` |
|
|
43
|
+
| `--pm=<yarn\|npm>` | Package manager to use | `yarn` |
|
|
44
|
+
| `--router` / `--no-router` | `@lit-labs/router` (auto-enables `@lit/context`) | `true` |
|
|
45
|
+
| `--context` / `--no-context` | `@lit/context` dependency injection | `true` |
|
|
46
|
+
| `--signals` / `--no-signals` | Preact Signals & IndexedDB store | `true` |
|
|
47
|
+
| `--todos` / `--no-todos` | Signals Todo List component & view | `true` |
|
|
48
|
+
| `--cards` / `--no-cards` | Generic Card component & view | `true` |
|
|
49
|
+
| `--charts` / `--no-charts` | Chart.js wrapper component & view | `true` |
|
|
50
|
+
| `--header` / `--no-header` | AppShellHeader navigation bar | `true` |
|
|
51
|
+
| `--theme-switcher` / `--no-theme-switcher` | Dark/Light mode theme switcher toggle | `true` |
|
|
52
|
+
| `--mfe-loader` / `--no-mfe-loader` | Micro-Frontend (MFE) loader utility | `true` |
|
|
53
|
+
| `--git` / `--no-git` | Initialize Git repository | `true` |
|
|
54
|
+
| `--install` / `--no-install` | Run package manager installation step | `false` |
|
|
55
|
+
| `-y`, `--yes` | Run non-interactively with defaults | `false` |
|
|
56
|
+
| `-v`, `--version` | Display version number | - |
|
|
57
|
+
| `-h`, `--help` | Display CLI help menu | - |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Publishing to NPM
|
|
62
|
+
|
|
63
|
+
To publish updates to npm under your scope:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
npm publish --access public
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
MIT © Quin Carter
|