vite-plugin-shopify-easel 0.1.0-beta.1 → 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/README.md +21 -2
- package/package.json +23 -24
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Easel
|
|
2
2
|
|
|
3
|
-
Easel is
|
|
3
|
+
Easel is an independent Vite toolkit for Shopify Liquid themes.
|
|
4
4
|
|
|
5
5
|
It builds JavaScript, TypeScript, and CSS into Shopify theme assets, generates the Liquid snippet that loads them, and safely replaces old build output. During development, it can coordinate Vite updates with Shopify CLI reloads. Shopify CLI still handles previews, syncing, and deployment.
|
|
6
6
|
|
|
@@ -14,6 +14,23 @@ pnpm add -D vite-plugin-shopify-easel vite
|
|
|
14
14
|
|
|
15
15
|
Easel requires Node.js 22.12 or newer and supports Vite 7 and 8.
|
|
16
16
|
|
|
17
|
+
## Create a theme
|
|
18
|
+
|
|
19
|
+
The [Clack-based scaffolder, `create-easel-theme`](packages/create-easel) creates a theme with TypeScript or JavaScript, optional Alpine, React or Vue, and plain CSS or Tailwind. It includes generic templates for the standard storefront page types while leaving current customer accounts to Shopify.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npm create easel-theme@latest my-theme
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
From a checkout of this repository:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
pnpm install
|
|
29
|
+
pnpm create:theme ../my-theme
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Use `--yes --no-install` for a non-interactive starter. The CLI also accepts `.` to use the current folder; see [current-directory setup](packages/create-easel#use-the-current-directory) for running it from outside this checkout. Existing folders must be empty apart from Git or Finder metadata. Shopify CLI remains separate.
|
|
33
|
+
|
|
17
34
|
## Start
|
|
18
35
|
|
|
19
36
|
Keep the Shopify theme at the project root and place source files in `src`.
|
|
@@ -145,13 +162,15 @@ Shopify CLI remains responsible for authentication, previews, synchronization, p
|
|
|
145
162
|
|
|
146
163
|
• [`examples/vanilla`](examples/vanilla) for TypeScript and CSS
|
|
147
164
|
|
|
165
|
+
• [`examples/named-bundles`](examples/named-bundles) for separate product and collection entries
|
|
166
|
+
|
|
148
167
|
• [`examples/alpine-tailwind`](examples/alpine-tailwind) for Alpine.js and Tailwind CSS
|
|
149
168
|
|
|
150
169
|
• [`examples/react`](examples/react) for React inside Liquid sections
|
|
151
170
|
|
|
152
171
|
• [`examples/vue`](examples/vue) for Vue single file components inside Liquid sections
|
|
153
172
|
|
|
154
|
-
Each example includes Shopify Theme Editor lifecycle handling
|
|
173
|
+
Each example includes Shopify Theme Editor lifecycle handling and automated build checks.
|
|
155
174
|
|
|
156
175
|
## License
|
|
157
176
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vite-plugin-shopify-easel",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "A Vite build adapter for Shopify Liquid themes",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -30,27 +30,6 @@
|
|
|
30
30
|
"access": "public",
|
|
31
31
|
"provenance": true
|
|
32
32
|
},
|
|
33
|
-
"scripts": {
|
|
34
|
-
"build": "tsup src/index.ts --format esm --dts --sourcemap --clean",
|
|
35
|
-
"check": "pnpm format:check && pnpm lint && pnpm typecheck && pnpm test && pnpm test:examples && pnpm test:site && pnpm build && pnpm test:package",
|
|
36
|
-
"format": "prettier --write .",
|
|
37
|
-
"format:check": "prettier --check .",
|
|
38
|
-
"lint": "eslint .",
|
|
39
|
-
"prepublishOnly": "pnpm check",
|
|
40
|
-
"scaffold:theme": "node scripts/scaffold-theme.mjs",
|
|
41
|
-
"test": "vitest run",
|
|
42
|
-
"test:example:alpine-tailwind": "pnpm --dir examples/alpine-tailwind check",
|
|
43
|
-
"test:example:react": "pnpm --dir examples/react check",
|
|
44
|
-
"test:example:vanilla": "pnpm --dir examples/vanilla check",
|
|
45
|
-
"test:example:vue": "pnpm --dir examples/vue check",
|
|
46
|
-
"test:examples": "node scripts/check-examples.mjs",
|
|
47
|
-
"test:package": "node scripts/check-package.mjs",
|
|
48
|
-
"test:site": "pnpm --dir site check",
|
|
49
|
-
"test:theme-check": "node scripts/check-themes.mjs",
|
|
50
|
-
"test:watch": "vitest",
|
|
51
|
-
"typecheck": "tsc --noEmit",
|
|
52
|
-
"tmp:env": "node /tmp/easel-env-check.mjs"
|
|
53
|
-
},
|
|
54
33
|
"engines": {
|
|
55
34
|
"node": ">=22.12.0"
|
|
56
35
|
},
|
|
@@ -71,5 +50,25 @@
|
|
|
71
50
|
"vitest": "^4.0.0"
|
|
72
51
|
},
|
|
73
52
|
"license": "MIT",
|
|
74
|
-
"
|
|
75
|
-
|
|
53
|
+
"scripts": {
|
|
54
|
+
"build": "tsup src/index.ts --format esm --dts --sourcemap --clean",
|
|
55
|
+
"check": "pnpm format:check && pnpm lint && pnpm typecheck && pnpm test && pnpm test:examples && pnpm test:site && pnpm build && pnpm test:package",
|
|
56
|
+
"create:theme": "pnpm --dir packages/create-easel build && node packages/create-easel/bin/create-easel-theme.mjs",
|
|
57
|
+
"format": "prettier --write .",
|
|
58
|
+
"format:check": "prettier --check .",
|
|
59
|
+
"lint": "eslint .",
|
|
60
|
+
"scaffold:theme": "node scripts/scaffold-theme.mjs",
|
|
61
|
+
"test": "pnpm --dir packages/create-easel build && vitest run",
|
|
62
|
+
"test:example:alpine-tailwind": "pnpm --dir examples/alpine-tailwind check",
|
|
63
|
+
"test:example:named-bundles": "pnpm --dir examples/named-bundles check",
|
|
64
|
+
"test:example:react": "pnpm --dir examples/react check",
|
|
65
|
+
"test:example:vanilla": "pnpm --dir examples/vanilla check",
|
|
66
|
+
"test:example:vue": "pnpm --dir examples/vue check",
|
|
67
|
+
"test:examples": "node scripts/check-examples.mjs",
|
|
68
|
+
"test:package": "node scripts/check-package.mjs && node packages/create-easel/scripts/check-package.mjs",
|
|
69
|
+
"test:site": "pnpm --dir site check",
|
|
70
|
+
"test:theme-check": "node scripts/check-themes.mjs",
|
|
71
|
+
"test:watch": "vitest",
|
|
72
|
+
"typecheck": "tsc --noEmit && pnpm --dir packages/create-easel check"
|
|
73
|
+
}
|
|
74
|
+
}
|