create-arsh-tauri 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Liz@Arshdelight
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,56 @@
-# Temporary Holding Version
+# create-arsh-tauri
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/create-arsh-tauri)](https://www.npmjs.com/package/create-arsh-tauri)
+
+The lightweight desktop stack we use for client work, one command away: **Tauri 2 + Vite + React 19 + TypeScript + Tailwind CSS 4**, a frameless window with a hand-rolled title bar, the same UI kit as `create-arsh-electron` — and Rust-side release polish (LTO, strip) done at the factory level.
+
+```bash
+npm create arsh-tauri@latest my-app
+```
+
+## What you get
+
+```
+├── src-tauri/           # Rust backend: commands, window config, bundle settings
+├── src/                 # frontend (React + Tailwind 4)
+│   └── ui/              # AppLayout, TitleBar, NavItem, Button, Dialog,
+│   │                    # Tooltip, Spinner, Switch — theme tokens in
+│   │                    # plain CSS variables, same kit as arsh-electron
+├── AGENTS.md            # bootstrap: the first AI session interviews you
+│                        # and writes this project's conventions
+├── src-tauri/tauri.conf.json
+└── vite.config.ts
+```
+
+- **Frameless window, custom title bar** — minimize / maximize / close via Tauri's window API, double-click to toggle maximize, an optional always-on-top pin, drag regions already wired up
+- **Minimal single-page starter** — a counter button plus a `greet` round-trip through Rust, so the bridge is proven before you write real code
+- **Test & CI baseline** — vitest wired up (`npm test`), a GitHub Actions workflow running lint + typecheck + tests + `cargo check` on push/PR
+- **Packaging polish built in** — release profile with LTO + strip for small binaries, fixed Vite dev port (1420) that the Tauri CLI expects, a complete `.gitignore`, and git initialized with a first commit so AI edits are diffable from day one
+- **Tiny output** — a scaffolded app builds to a few MB, no bundled runtime browser
+
+## Usage
+
+```bash
+npm create arsh-tauri@latest [project-name]
+npm create arsh-tauri@latest [project-name] -- --scope <name>
+
+# non-interactive
+npm create arsh-tauri@latest my-app -- --yes
+```
+
+| Flag | Description |
+|---|---|
+| `--scope <name>` | bundle identifier namespace, `com.<scope>.<app>` (default: `arshdelight`) |
+| `--yes` | Skip prompts, use defaults (git init included) |
+
+The CLI asks two questions — project name, git init or not — and derives everything else: `package.json` name (and `author`, from your git config), Rust crate + lib names, bundle `identifier`, `productName`, window title and title-bar brand. Answer `arsh-demo` and you get crate `arsh-demo`, lib `arsh_demo_lib`, product `ArshDemo` / `com.arshdelight.arshdemo`; add `--scope mycompany` and it becomes `com.mycompany.arshdemo`.
+
+## Prerequisites
+
+- Node.js ≥ 20.11
+- Rust ≥ 1.77.2 (`rustup` — https://rustup.rs)
+- WebView2 (preinstalled on Windows 10/11) — see https://tauri.app/start/prerequisites/
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,239 @@
+#!/usr/bin/env node
+import fs from 'node:fs'
+import path from 'node:path'
+import { execFileSync } from 'node:child_process'
+import process from 'node:process'
+import * as p from '@clack/prompts'
+
+const templateDir = path.join(import.meta.dirname, 'template')
+
+const usage = [
+  'Usage: npm create arsh-tauri@latest [project-name] [--scope <name>] [--yes]',
+  '',
+  '  --scope <name>  appId namespace (default: arshdelight)',
+  '  --yes           Skip prompts and use defaults (git init included)',
+].join('\n')
+
+function slugify(name) {
+  return name.trim().toLowerCase().replace(/[^a-z\d-]+/g, '-').replace(/-+/g, '-').replace(/^-|-$/g, '')
+}
+
+function toProductName(name) {
+  return name
+    .split(/[^a-zA-Z\d]+/)
+    .filter(Boolean)
+    .map((w) => w[0].toUpperCase() + w.slice(1))
+    .join('') || 'ArshApp'
+}
+
+function isEmptyDir(dir) {
+  return !fs.existsSync(dir) || fs.readdirSync(dir).length === 0
+}
+
+function emptyDir(dir) {
+  for (const entry of fs.readdirSync(dir)) {
+    fs.rmSync(path.join(dir, entry), { recursive: true, force: true })
+  }
+}
+
+function gitAvailable() {
+  try {
+    execFileSync('git', ['--version'], { stdio: 'ignore' })
+    return true
+  } catch {
+    return false
+  }
+}
+
+function gitAuthor() {
+  try {
+    const name = execFileSync('git', ['config', 'user.name'], { stdio: 'pipe' }).toString().trim()
+    if (!name) return null
+    const email = execFileSync('git', ['config', 'user.email'], { stdio: 'pipe' }).toString().trim()
+    return email ? { name, email } : { name }
+  } catch {
+    return null
+  }
+}
+
+function initGit(projectDir) {
+  const run = (args) => execFileSync('git', args, { cwd: projectDir, stdio: 'ignore' })
+  run(['init'])
+  run(['add', '-A'])
+  try {
+    run(['commit', '-m', 'chore: initial commit'])
+  } catch {
+    p.log.warn('git commit skipped — set user.name / user.email, then commit manually')
+  }
+}
+
+function applyRenames(projectDir, { packageName, productName, appId, libName, author }) {
+  const replace = (file, pairs) => {
+    const file_ = path.join(projectDir, file)
+    let content = fs.readFileSync(file_, 'utf8')
+    for (const [from, to] of pairs) content = content.split(from).join(to)
+    fs.writeFileSync(file_, content)
+  }
+  replace('package.json', [['"name": "arsh-tauri-app"', `"name": "${packageName}"`]])
+  if (author) {
+    replace('package.json', [['"author": "Your Name"', `"author": ${JSON.stringify(author)}`]])
+  }
+  replace('src-tauri/tauri.conf.json', [
+    ['com.arshdelight.arshapp', appId],
+    ['"productName": "ArshApp"', `"productName": "${productName}"`],
+    ['"title": "ArshApp"', `"title": "${productName}"`],
+  ])
+  replace('src-tauri/Cargo.toml', [
+    ['name = "arsh-tauri-app"', `name = "${packageName}"`],
+    ['arsh_tauri_app_lib', libName],
+  ])
+  replace('src-tauri/src/main.rs', [['arsh_tauri_app_lib', libName]])
+  replace('index.html', [['Arsh Tauri', productName]])
+  replace('src/App.tsx', [['brand="Arsh Tauri"', `brand="${productName}"`]])
+  replace('README.md', [['# Arsh Tauri', `# ${productName}`]])
+}
+
+async function main() {
+  const args = process.argv.slice(2)
+  if (args.includes('-h') || args.includes('--help')) {
+    console.log(usage)
+    return
+  }
+
+  const yes = args.includes('--yes')
+  const scopeIdx = args.indexOf('--scope')
+  const scopeArg = scopeIdx !== -1 ? args[scopeIdx + 1] : args.find((a) => a.startsWith('--scope='))
+  const positional = args.find((a) => !a.startsWith('-') && a !== scopeArg)
+  const nonInteractive = !process.stdout.isTTY || yes
+
+  p.intro('create-arsh-tauri')
+
+  let scopeSlug = 'arshdelight'
+  if (scopeArg !== undefined) {
+    const raw = scopeArg.startsWith('--scope=') ? scopeArg.slice('--scope='.length) : scopeArg
+    scopeSlug = slugify(raw)
+    if (!scopeSlug) {
+      p.log.error('Scope must contain letters or digits')
+      process.exitCode = 1
+      return
+    }
+  }
+
+  let projectName = positional
+  if (!projectName) {
+    if (nonInteractive) {
+      p.log.error(`Project name is required in non-interactive mode.\n${usage}`)
+      process.exitCode = 1
+      return
+    }
+    const res = await p.text({
+      message: 'Project name',
+      placeholder: 'my-app',
+      validate: (v) => {
+        if (!v || !v.trim()) return 'Please enter a project name'
+        if (!slugify(v)) return 'Must contain letters or digits'
+      },
+    })
+    if (p.isCancel(res)) return
+    projectName = res
+  }
+
+  const slug = slugify(projectName)
+  if (!slug) {
+    p.log.error('Project name must contain letters or digits')
+    process.exitCode = 1
+    return
+  }
+  const projectDir = path.resolve(process.cwd(), slug)
+  const packageName = slug
+  const productName = toProductName(slug)
+  const appId = `com.${scopeSlug}.${slug.replace(/-/g, '')}`
+  const libName = `${slug.replace(/-/g, '_')}_lib`
+  const author = gitAuthor()
+
+  if (!isEmptyDir(projectDir)) {
+    let overwrite = yes
+    if (process.stdout.isTTY && !yes) {
+      const res = await p.confirm({
+        message: `Directory "${slug}" is not empty. Remove existing files and continue?`,
+        initialValue: false,
+      })
+      if (p.isCancel(res)) return
+      overwrite = res
+    }
+    if (!overwrite) {
+      p.log.warn('Cancelled — directory left untouched')
+      return
+    }
+    emptyDir(projectDir)
+  }
+
+  const spinner = p.spinner()
+  spinner.start('Scaffolding project…')
+  // the published tarball never contains these dirs; skipping them here keeps
+  // local runs (template with node_modules / cargo target) identical to prod
+  fs.cpSync(templateDir, projectDir, {
+    recursive: true,
+    filter: (src) => {
+      const rel = path.relative(templateDir, src)
+      if (!rel) return true
+      const segs = rel.split(path.sep)
+      const [top] = segs
+      if (segs.includes('node_modules') || segs.includes('target')) return false
+      return !(top.startsWith('.temp') || top === 'dist' || (top === 'src-tauri' && segs[1] === 'gen'))
+    },
+  })
+  // npm publish strips .gitignore from the tarball, so the template ships it
+  // dotless and it gets its dot back here
+  for (const f of ['gitignore', 'temp']) {
+    fs.renameSync(path.join(projectDir, f), path.join(projectDir, `.${f}`))
+  }
+  applyRenames(projectDir, { packageName, productName, appId, libName, author })
+
+  let gitNote = ''
+  if (gitAvailable()) {
+    let doGit = true
+    if (process.stdout.isTTY && !yes) {
+      const res = await p.confirm({ message: 'Initialize a git repository and make the first commit?', initialValue: true })
+      if (p.isCancel(res)) return
+      doGit = res
+    }
+    if (doGit) {
+      try {
+        initGit(projectDir)
+        gitNote = 'git repository initialized with a first commit'
+      } catch {
+        gitNote = 'git initialization failed — you can run it manually'
+      }
+    }
+  } else {
+    gitNote = 'git not found — skipped version control setup'
+  }
+  spinner.stop('Project scaffolded')
+
+  const nextSteps = [
+    `cd ${slug}`,
+    'npm install',
+    'npm run dev',
+  ]
+  p.note(
+    [
+      ...nextSteps,
+      '',
+      'npm run dev compiles the Rust backend on first run —',
+      'grab a coffee, later runs are instant.',
+      '',
+      'Then open the project with any AI coding tool —',
+      'AGENTS.md is a bootstrap: the first AI session will interview you',
+      'and write the project conventions.',
+      gitNote,
+    ].join('\n'),
+    'Next steps',
+  )
+  p.outro(`Done. Build something marvelous with ${productName}.`)
+}
+
+main().catch((err) => {
+  p.log.error(String(err?.message ?? err))
+  process.exitCode = 1
+})

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "create-arsh-tauri",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Scaffold an Arshdelight-style Tauri 2 + React + TypeScript desktop app — frameless window, UI primitives, and Rust-side build polish built in.",
+  "type": "module",
+  "bin": {
+    "create-arsh-tauri": "index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Arshdelight/create-arsh-tauri.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Arshdelight/create-arsh-tauri/issues"
+  },
+  "homepage": "https://github.com/Arshdelight/create-arsh-tauri#readme",
+  "files": [
+    "index.js",
+    "template",
+    "!template/node_modules",
+    "!template/src-tauri/target",
+    "!template/dist",
+    "!template/src-tauri/gen/schemas"
+  ],
+  "engines": {
+    "node": ">=20.11"
+  },
+  "keywords": [
+    "tauri",
+    "react",
+    "typescript",
+    "scaffold",
+    "create",
+    "starter",
+    "template"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Liz@Arshdelight",
+    "email": "cjhzisme@163.com"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.8.1"
+  }
+}

package/template/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', 'dist-electron', 'release', '.temp', '*.local'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}

package/template/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  web:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'npm'
+
+      - run: npm ci
+
+      - run: npm run lint
+
+      - run: npx tsc --noEmit
+
+      - run: npm test
+
+  rust:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'npm'
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: src-tauri
+
+      # generate_context! embeds the frontend assets, so dist/ must exist
+      - run: npm ci
+
+      - run: npm run build:web
+
+      - run: cargo check
+        working-directory: src-tauri

package/template/AGENTS.md

@@ -0,0 +1,50 @@
+# AGENTS.md — bootstrap
+
+This file bootstraps the real AGENTS.md. Instead of shipping opinions the user
+never asked for, your **first session** in this project runs a short interview
+and rewrites this file into the project's actual conventions.
+
+## First session: run the interview
+
+If this file still contains the "Engineering rules" section kept verbatim, the
+interview has not happened yet. Ask everything in **one round** (not one message
+per question), accept short answers, and skip any question the user answers
+with "default".
+
+1. **Commit style** — prefix convention (`feat:` / `fix:` / `chore:` / none)?
+   Message language? Subject-line rules (length, imperative, capitalization)?
+2. **Collaboration style** — plan first and wait for approval, or act directly?
+   Where is the line between "just do it" and "ask first"? How much refactoring
+   is welcome while touching nearby code?
+3. **Language** — for conversation, code comments, docs, and UI strings?
+4. **Delivery bar** — besides `npm run lint` and `npx tsc --noEmit`, what must
+   pass before work counts as done (tests, `cargo check`, packaging smoke)?
+5. **Anything else** — pet peeves, forbidden actions, naming or structure
+   preferences worth writing down?
+
+Then rewrite this file:
+
+- Keep the file name `AGENTS.md` and keep the `## Engineering rules` section
+  intact — translate it only if the user asked for another language.
+- Structure the rest around the interview answers.
+- Zero filler. No platitudes ("write clean code", "be concise"), nothing the
+  template already enforces by construction. Every line must change how you act.
+- The interview is one-time. Once this bootstrap section is gone, never ask again.
+
+## Engineering rules
+
+Three rules that normal, well-scoped tasks would otherwise silently violate.
+Keep them intact.
+
+- **Dependency partition**: `dependencies` in package.json stays empty — the
+  Vite frontend bundles everything, so all JS libraries go to
+  `devDependencies`. Rust dependencies live in `src-tauri/Cargo.toml` and are
+  added only when actually used.
+- **Frontend never touches system capabilities directly**: all native calls go
+  through `@tauri-apps/api` (`invoke` / `listen`, see `src/lib/tauri.ts`).
+  New commands: `#[tauri::command]` in `src-tauri/src/lib.rs`, registered in
+  `generate_handler!`, permission entries in `src-tauri/capabilities/` when
+  needed.
+- **Definition of done**: `npm run lint` (zero warnings), `npx tsc --noEmit`,
+  and `npm test` all pass before work counts as complete; run `cargo check`
+  in `src-tauri/` whenever Rust code or capabilities change.

package/template/README.md

@@ -0,0 +1,51 @@
+# Arsh Tauri
+
+Tauri 2 + React + TypeScript desktop app.
+
+## Prerequisites
+
+- Node.js ≥ 20.11
+- Rust ≥ 1.77.2（`rustup` — https://rustup.rs）
+- WebView2（Windows 10/11 自带）
+
+## Commands
+
+```bash
+npm install
+npm run dev        # 启动桌面应用（首次会编译 Rust，之后秒开）
+npm run dev:web    # 只跑前端（UI 开发，无 Rust 桥接，自动降级）
+npm run build      # 类型检查 + 前端构建 + 打包安装器到 src-tauri/target/release/bundle/
+npm run lint       # ESLint，零警告
+npm test           # vitest
+```
+
+## Structure
+
+```
+├── src-tauri/           # Rust 后端
+│   ├── src/lib.rs       # run() + 所有 #[tauri::command]
+│   ├── src/main.rs      # 入口
+│   ├── capabilities/    # 权限配置（默认含无边框窗口控制）
+│   ├── tauri.conf.json  # 窗口 / 打包 / dev server 配置
+│   └── icons/           # 应用图标（npx tauri icon <png> 重新生成）
+├── src/
+│   ├── ui/              # AppLayout, TitleBar, NavItem, Button, Dialog,
+│   │                    # Tooltip, Spinner, Switch + theme tokens (styles.css)
+│   ├── lib/             # cn() 和 Tauri 桥接检测
+│   ├── App.tsx          # 入口页（含 invoke 示例）
+│   └── index.css
+├── AGENTS.md            # project conventions for AI coding tools
+└── vite.config.ts
+```
+
+## Packaging
+
+- 自定义图标：放一张 ≥ 1024×1024 的方形 PNG，跑 `npx tauri icon <png>` 重新生成 `src-tauri/icons/`。
+- 安装器元数据在 `src-tauri/tauri.conf.json`（`identifier`、`productName`）。
+- 发布体积优化（LTO/strip）在 `src-tauri/Cargo.toml` 的 `[profile.release]`。
+
+## AI coding tools
+
+`AGENTS.md` holds the project conventions. On the first session it walks the
+tool through a short interview and writes the final conventions for this
+project.

package/template/gitignore

@@ -0,0 +1,37 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+release
+src-tauri/target
+src-tauri/gen/schemas
+*.local
+
+# 本地草稿 / AI 协作产物（约定：临时文件一律进 .temp/）
+.temp*
+.zcode/
+.zcodeignore
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# AGENTS.md 默认随模板入库；若想保持本地不提交，取消下一行注释
+# AGENTS.md
+
+# test coverage
+coverage/

package/template/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Arsh Tauri</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>