@fluid-app/fluid-cli-theme-dev 0.1.38 → 0.1.39
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
CHANGED
|
@@ -30,10 +30,16 @@ fluid theme dev
|
|
|
30
30
|
|
|
31
31
|
The dev server will:
|
|
32
32
|
|
|
33
|
-
1. Create (or reuse)
|
|
34
|
-
2.
|
|
35
|
-
3.
|
|
36
|
-
4.
|
|
33
|
+
1. Create (or reuse) an isolated development theme
|
|
34
|
+
2. Preserve pulled binary assets as ImageKit URL references without downloading or re-uploading their bytes
|
|
35
|
+
3. Keep editable source files (Liquid, CSS, JS, SVG, JSON) locally
|
|
36
|
+
4. Upload a newly added binary once, save its ImageKit URL reference, and remove its local bytes
|
|
37
|
+
5. Watch for source-file changes and sync them automatically
|
|
38
|
+
6. Proxy requests to `{company}.fluid.app` with local file overrides
|
|
39
|
+
|
|
40
|
+
For a pulled theme, a newly created dev theme is a server-side reference clone
|
|
41
|
+
of the pulled source. It preserves theme content and DAM/ImageKit references,
|
|
42
|
+
so initial dev startup does not reseed every asset from the working copy.
|
|
37
43
|
|
|
38
44
|
| Flag | Default | Description |
|
|
39
45
|
| -------------------------- | ----------- | ----------------------------------------- |
|
|
@@ -112,10 +118,33 @@ Existing skills are left untouched unless you confirm the overwrite (or pass `--
|
|
|
112
118
|
|
|
113
119
|
## Theme Directory Structure
|
|
114
120
|
|
|
115
|
-
A valid theme directory must contain at least one of: `templates/`, `assets/`,
|
|
121
|
+
A valid theme directory must contain at least one of: `templates/`, `assets/`,
|
|
122
|
+
`config/`, or the asset reference manifest `.fluid-assets.json`.
|
|
116
123
|
|
|
117
124
|
Use a `.fluidignore` file (same syntax as `.gitignore`) to exclude files from syncing.
|
|
118
125
|
|
|
126
|
+
### Remote binary assets
|
|
127
|
+
|
|
128
|
+
`fluid theme pull` keeps binary assets such as images, fonts, video, and PDFs
|
|
129
|
+
remote rather than downloading them into `assets/`. Their ImageKit URL
|
|
130
|
+
reference metadata is recorded in `.fluid-assets.json`. The CLI uses that
|
|
131
|
+
manifest when it starts a dev theme or pushes to another theme, so existing
|
|
132
|
+
`asset_url` calls continue to resolve normally without local binary copies.
|
|
133
|
+
|
|
134
|
+
When a developer adds a new binary file during `fluid theme dev`, the CLI
|
|
135
|
+
uploads it once, records its ImageKit URL reference in the manifest, and
|
|
136
|
+
removes its local bytes after the theme resource has been saved. A later
|
|
137
|
+
`fluid theme push` writes that same ImageKit URL into the selected target theme
|
|
138
|
+
without a second binary upload.
|
|
139
|
+
|
|
140
|
+
Binary assets must be direct children of `assets/` (for example,
|
|
141
|
+
`assets/logo.png`); nested asset directories are not supported by the theme
|
|
142
|
+
resource API.
|
|
143
|
+
|
|
144
|
+
Do not add `.fluid-assets.json` to `.fluidignore`; it is already excluded from
|
|
145
|
+
theme uploads and file watching. Commit it with the theme source so every
|
|
146
|
+
developer receives the same remote asset references.
|
|
147
|
+
|
|
119
148
|
## Development
|
|
120
149
|
|
|
121
150
|
For contributors working in `fluid-mono`:
|