@feeef.dev/cli 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/LICENSE +6 -0
- package/README.md +94 -0
- package/dist/bin.js +2752 -0
- package/dist/bin.js.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +2730 -0
- package/dist/index.js.map +1 -0
- package/package.json +67 -0
- package/scaffolds/blank/.cursor/rules/feeef-theme.mdc +34 -0
- package/scaffolds/blank/.cursor/rules/filterator.mdc +13 -0
- package/scaffolds/blank/.cursor/rules/order-form.mdc +17 -0
- package/scaffolds/blank/.cursor/rules/theme-source.mdc +32 -0
- package/scaffolds/blank/.cursor/skills/feeef-filterator/SKILL.md +15 -0
- package/scaffolds/blank/.cursor/skills/feeef-theme/SKILL.md +56 -0
- package/scaffolds/blank/.cursor/skills/feeef-theme/reference.md +73 -0
- package/scaffolds/blank/.vscode/extensions.json +3 -0
- package/scaffolds/blank/.vscode/settings.json +13 -0
- package/scaffolds/blank/AGENTS.md +104 -0
- package/scaffolds/blank/README.md +21 -0
- package/scaffolds/blank/docs/00-INDEX.md +33 -0
- package/scaffolds/blank/docs/03-CUSTOM-COMPONENTS.md +116 -0
- package/scaffolds/blank/docs/04-WORKFLOW.md +129 -0
- package/scaffolds/blank/docs/05-ANTI-PATTERNS.md +80 -0
- package/scaffolds/blank/docs/07-SHARED-COMPONENTS.md +144 -0
- package/scaffolds/blank/docs/08-ORDER-FORM.md +376 -0
- package/scaffolds/blank/docs/09-THEME-PORTING.md +211 -0
- package/scaffolds/blank/docs/10-SCHEMA-LIBRARY.md +127 -0
- package/scaffolds/blank/docs/11-PAGES-CHECKOUT-THANKS-PRODUCT.md +81 -0
- package/scaffolds/blank/docs/12-DARK-LIGHT-THEME.md +164 -0
- package/scaffolds/blank/docs/13-TEMPLATE-I18N.md +320 -0
- package/scaffolds/blank/docs/14-FILTERATOR.md +433 -0
- package/scaffolds/blank/docs/16-AUTHORING-TS-IMPORTS.md +73 -0
- package/scaffolds/blank/feeef.template.json +7 -0
- package/scaffolds/blank/locales/README.md +4 -0
- package/scaffolds/blank/locales/ar.json +10 -0
- package/scaffolds/blank/locales/en.json +10 -0
- package/scaffolds/blank/package-lock.json +1975 -0
- package/scaffolds/blank/package.json +23 -0
- package/scaffolds/blank/pages/home/components/hero.tsx +34 -0
- package/scaffolds/blank/pages/home/page.json +3 -0
- package/scaffolds/blank/props.json +6 -0
- package/scaffolds/blank/schema.ts +49 -0
- package/scaffolds/blank/tsconfig.json +24 -0
- package/scaffolds/blank/types/feeef-live-scope.d.ts +162 -0
- package/scaffolds/blank/types/feeef-template-schema.d.ts +84 -0
- package/vendor/template-kit/README.md +64 -0
- package/vendor/template-kit/bin/dev.mjs +61 -0
- package/vendor/template-kit/bin/feeef-template.mjs +212 -0
- package/vendor/template-kit/data/lithium-schema.json +4733 -0
- package/vendor/template-kit/lib/build.mjs +377 -0
- package/vendor/template-kit/lib/compile-component.mjs +188 -0
- package/vendor/template-kit/lib/component-meta.mjs +481 -0
- package/vendor/template-kit/lib/library.mjs +168 -0
- package/vendor/template-kit/lib/locales.mjs +68 -0
- package/vendor/template-kit/lib/paths.mjs +84 -0
- package/vendor/template-kit/lib/shared.mjs +268 -0
- package/vendor/template-kit/lib/theme-schema.mjs +300 -0
- package/vendor/template-kit/lib/unpack.mjs +324 -0
- package/vendor/template-kit/lib/validate.mjs +207 -0
- package/vendor/template-kit/schemas/component.schema.json +55 -0
- package/vendor/template-kit/schemas/template.schema.json +18 -0
package/LICENSE
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# @feeef.dev/cli
|
|
2
|
+
|
|
3
|
+
Standalone TypeScript CLI for Feeef theme authors.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g @feeef.dev/cli
|
|
7
|
+
feeef --help
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Config: `~/.config/feeef/config.json` (directory `0700`, file `0600`)
|
|
11
|
+
|
|
12
|
+
## Auth
|
|
13
|
+
|
|
14
|
+
Default sign-in is **browser OAuth** (PKCE, public client — no client secret):
|
|
15
|
+
|
|
16
|
+
- Redirect URI: `http://localhost.feeef.org:7777/oauth/callback` (**http**, not https)
|
|
17
|
+
- Callback binds **127.0.0.1** only (`localhost.feeef.org` must resolve to loopback)
|
|
18
|
+
- Client id is built-in
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
feeef signin # opens browser → consent → token saved
|
|
22
|
+
feeef signin --password-auth # email/password fallback (interactive prompt)
|
|
23
|
+
feeef whoami
|
|
24
|
+
feeef signout
|
|
25
|
+
feeef config show
|
|
26
|
+
feeef config set apiUrl http://127.0.0.1:3333/api/v1
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Theme workflow
|
|
30
|
+
|
|
31
|
+
Themes are **Node.js packages** (`package.json` + scripts). Scripts wrap the global `feeef` CLI.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
feeef template init my-theme
|
|
35
|
+
cd my-theme
|
|
36
|
+
feeef use # pick one of your stores
|
|
37
|
+
|
|
38
|
+
feeef template add page products
|
|
39
|
+
feeef template add component products grid --title "Product grid"
|
|
40
|
+
|
|
41
|
+
npm run build # or: feeef template build
|
|
42
|
+
npm run check
|
|
43
|
+
npm run dev # remote draft preview on your store
|
|
44
|
+
npm run publish -- --apply # go live (explicit)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Preview (`feeef template dev`)
|
|
48
|
+
|
|
49
|
+
Pushes a **draft** theme to your bound store and opens the hosted storefront with a signed `?preview=` token.
|
|
50
|
+
|
|
51
|
+
- Live customers keep seeing `metadata.templateData` (unchanged)
|
|
52
|
+
- You navigate the full shop in draft mode (cookie keeps the session)
|
|
53
|
+
- Exit: banner **Exit preview**, or visit `/?preview=0`
|
|
54
|
+
- Stopping the CLI clears the server draft
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
feeef signin
|
|
58
|
+
feeef use my-store
|
|
59
|
+
feeef template dev
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Going live is only via `feeef template publish --apply` (or the merchant editor).
|
|
63
|
+
|
|
64
|
+
### Local Next (employees only)
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
feeef template dev --local
|
|
68
|
+
# or: feeef config set storefrontPath /path/to/storefront && feeef template dev --local
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Not required for public theme authors.
|
|
72
|
+
|
|
73
|
+
## Publish uploads
|
|
74
|
+
|
|
75
|
+
| Target | Source |
|
|
76
|
+
|--------|--------|
|
|
77
|
+
| `store_templates` | `dist/data.json` (i18n stripped) + schema |
|
|
78
|
+
| `template_components` | `shared/` + `library/` |
|
|
79
|
+
| `store_template_locales` | `dist/locales/*.json` |
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
UNLICENSED — proprietary Feeef software. See [LICENSE](./LICENSE).
|
|
84
|
+
|
|
85
|
+
## Develop (monorepo)
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
cd cli
|
|
89
|
+
npm install
|
|
90
|
+
npm run typecheck
|
|
91
|
+
npm test
|
|
92
|
+
npm run build
|
|
93
|
+
npm run link:global
|
|
94
|
+
```
|