@picloom/create-theme 0.1.1 → 0.1.2

package/README.md

@@ -1,37 +1,22 @@
 # @picloom/create-theme
 
-Create a standalone Vue 3 Picloom theme with Bun 1.4.3+, simulated preview,
-component/style HMR and ZIP packaging. No application checkout, Node/npm CLI or
-system `zip` is required.
-
-Create a project:
+Create a standalone Picloom Vue 3 theme with Bun 1.4.3+.
 
 ```sh
-bun create @picloom/theme@0.1.1 ./my-theme
+bun create @picloom/theme@0.1.2 ./my-theme
 cd my-theme
 bun install
 bun run dev
+bun run typecheck
 bun run build
-bun run preview
 ```
 
-The target must not exist; its parent must exist. The creator copies files only;
-it does not install dependencies, initialize Git or publish. Both home and login
-pages start from the template maintained in this package.
-`--help` prints usage.
+The target directory must not exist and its parent must exist. Follow the generated README to edit and install the ZIP. The dev server provides a simulated preview. Type checking and building are separate commands.
 
-To test local packages, use the `.tgz` workflow in
-[theme tooling](https://llleixx.github.io/picloom/development/theme-tooling.html).
-Maintainers run `bun run build:create-theme` before `bun pm pack --ignore-scripts`.
-The build copies `template/` into `dist/template/` without reading the host repository. Preview and ZIP builds are provided
-by `@picloom/theme-tools`; generated projects do not contain a copy of the preview host.
-Do not edit `dist/template/`. Use exact npm version 0.1.1.
+[Theme tutorial](https://llleixx.github.io/picloom/development/theme-tooling.html)
 
 ## 中文
 
-基于工具链仓库独立维护的模板创建 Vue 3 主题。提供模拟预览、热更新、生产产物预览与 ZIP 打包。
-创建工具只复制文件，不覆盖已有目录、不安装依赖、不初始化 Git、不发布。
-模拟预览不连接真实服务；上传、登录与权限必须在隔离测试实例安装后验证。
-通过 npm 创建项目，也可按文档使用本地 `.tgz` 验证开发版本。编辑 `template/` 维护模板，构建时复制到 `dist/template/`，不依赖主仓库默认主题源码。
+使用 Bun 1.4.3+ 创建独立 Vue 3 主题。按上方命令创建工程、安装依赖、检查类型并构建。目标目录必须不存在，父目录必须存在。
 
-协议类型来自 `@picloom/theme-sdk`，预览与构建调用 `@picloom/theme-tools`；生成项目不复制通用工具代码。
+开发服务器提供模拟预览。类型检查与构建分别执行；修改文件和安装 ZIP 的步骤见生成项目中的 README。

package/dist/template/README.md

@@ -1,60 +1,50 @@
 # Picloom theme / 主题开发
 
-Requires Bun 1.4.3+. This project starts from Picloom's built-in default theme,
-uses only the public Theme SDK, and bundles its own Vue runtime.
+A Vue 3 theme for Picloom home and login pages. Requires Bun 1.4.3+.
+
+## Develop
 
 ```sh
 bun install
 bun run dev
+```
+
+Open `http://127.0.0.1:5173/`; use `bun run dev --port 5174` to change the port. The preview panel simulates pages, languages, appearance, login and upload states.
+
+- `theme.json`: theme ID, version, localized text and configuration schema.
+- `src/Page.vue`, `src/style.css`: pages and styles, with hot updates.
+- `src/entry.ts`: mounts the theme and disposes it on unmount.
+- `public/assets/`: package resources, read with `context.asset("assets/...")`.
+- `dev/config.json`: created on first preview from schema defaults; edit it to try configuration values. New defaults do not replace existing values.
+
+Keep `style.css` in the manifest's global `styles`; it contains CSS imported by the entry. Configuration and packaged resources are public.
+
+## Build and install
+
+```sh
 bun run typecheck
 bun run build
 bun run preview
 ```
 
-`dev` listens on http://127.0.0.1:5173; use `bun run dev --port 5174` if occupied.
-The collapsible preview panel switches pages, languages, appearance, identity and
-simulated states. Uploads and login are **simulations**, never real API calls.
-Do not use preview success as evidence that a storage service or authentication works.
-
-Edit `src/Page.vue`, `src/style.css` and `theme.json`. All pages use `src/entry.ts`
-(`entry.js` in the package). Put static package resources in `public/assets/` and
-resolve them with `context.asset("assets/...")`. Imported image/CSS resources are
-also processed by Vite. Keep `style.css` in the manifest's global `styles`: it
-contains all CSS imported by the source entry. Additional page-only styles belong
-in `public/assets/` and the corresponding page's `styles`; preview loads and
-unloads them when changing pages. Arbitrary files outside these inputs are not packaged.
-
-Vue components and CSS support HMR. Entry changes reload the preview. Manifest
-and `dev/config.json` changes reload and remount the theme. Invalid JSON shows a
-development error and is never overwritten. The first preview initializes a
-missing config from schema defaults; later edits never restore removed values.
-There is initially no custom config schema, so the generated config is `{}`.
-
-`preview` loads the existing `dist/package/` JavaScript and styles through the
-same simulated host, without theme source HMR. Build first; source edits are not
-visible until you rebuild. The preview toolbar itself is still a local tool.
-
-The distributable is `dist/<theme-id>-<version>.zip`. Upload it to Picloom's Themes
-page, confirm trust, preview and apply. Test real uploads, login and permissions
-there. Increase `theme.json.version` before distributing changed content; package
-versions are immutable on the host. The package builder checks structure and
-resources; full configuration/manifest validation still runs on installation.
-
-SDK and tool dependencies use exact versions after publication. During local validation, install the matching local tarballs; the current development versions are not yet published.
-Commit your generated `bun.lock` to your own repository after installation.
+Type checking is separate. `preview` displays the existing `dist/package/` through the simulated host; rebuild to see source changes.
+
+Install `dist/<theme-id>-<version>.zip` as Owner in Picloom's Themes page, configure, preview and apply. Check uploads and login there. Increment `theme.json.version` before installing changed content; an installed ID/version cannot be overwritten.
+
+[Theme tutorial](https://llleixx.github.io/picloom/development/theme-tooling.html) · [Theme protocol](https://llleixx.github.io/picloom/development/themes.html)
 
 ## 中文
 
-- 使用 Bun 1.4.3+，无需 Node/npm CLI、主仓库或系统 `zip`。
-- `bun run dev` 提供模拟首页、登录页、上传状态、语言和明暗模式；只用于界面开发。
-- 修改 Vue 组件及样式会热更新；入口、清单和本地配置修改后刷新预览。
-- 首次启动时按 Schema 默认值创建 `dev/config.json`，之后清空或删除值不会自动补回。
-- `bun run typecheck` 单独检查类型；`bun run build` 构建并生成可安装 ZIP；`bun run preview` 检查已有构建产物。
-- 修改主题 ID、显示名称和版本均以 `theme.json` 为准，静态资源放入 `public/assets/`。
-- 入口导入的样式合并为 `style.css`，须保留清单全局样式声明；页面专属样式通过各页面的 `styles` 引用，切页时分别加载和卸载。
-- 主题包不包含开发面板、本地配置、凭据或源码映射。所有主题配置可能公开，不要保存密钥。
-- 在隔离 Picloom 测试实例安装 ZIP 后验证真实上传和登录；模拟成功不代表真实服务已验证。
-- SDK 和开发工具在发布后使用 npm 精确版本；当前未发布版本使用本地包验证，安装时同步更新锁文件。
-
-Local preview and ZIP builds are provided by `@picloom/theme-tools` using this theme’s Vite configuration.
-本地预览和 ZIP 构建由 `@picloom/theme-tools` 统一提供，使用本主题的 Vite 配置，不复制预览宿主源码。
+使用 Bun 1.4.3+。运行 `bun install` 和 `bun run dev`，打开 `http://127.0.0.1:5173/`；可用 `--port 5174` 更换端口。面板模拟页面、语言、外观、登录与上传状态。
+
+- `theme.json`：主题 ID、版本、多语言文案与配置 Schema。
+- `src/Page.vue`、`src/style.css`：页面与样式，支持热更新。
+- `src/entry.ts`：挂载主题并在卸载时清理资源。
+- `public/assets/`：包内资源，通过 `context.asset("assets/...")` 读取。
+- `dev/config.json`：首次预览按 Schema 默认值创建，之后手动修改；新默认值不会覆盖已有配置。
+
+入口导入的 CSS 合并到 `style.css`，需保留清单中的全局样式声明。主题配置与包内资源可公开访问。
+
+分别执行 `bun run typecheck`、`bun run build`。`bun run preview` 模拟预览已有构建产物，修改源码后需重新构建。
+
+以 Owner 在 Picloom 主题管理中安装 `dist/<主题ID>-<版本>.zip`，配置、预览并应用，再检查上传和登录。更新时增加 `theme.json.version`；同 ID、同版本不能覆盖。

package/dist/template/package.json

@@ -13,7 +13,7 @@
     "preview": "bun --bun picloom-theme preview"
   },
   "devDependencies": {
-    "@picloom/theme-sdk": "0.1.1",
+    "@picloom/theme-sdk": "0.1.2",
     "@tailwindcss/vite": "4.3.3",
     "@types/bun": "1.3.10",
     "@vitejs/plugin-vue": "6.0.10",
@@ -22,6 +22,6 @@
     "vite": "8.3.4",
     "vue": "3.5.44",
     "vue-tsc": "3.3.13",
-    "@picloom/theme-tools": "0.1.0"
+    "@picloom/theme-tools": "0.1.1"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picloom/create-theme",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Create a standalone Picloom Vue theme with local preview and ZIP packaging",
   "type": "module",
   "license": "MIT",