npm - @duonghieu0712z/create-tauri-vue-template - Versions diffs - 0.0.3 - Mend

@duonghieu0712z/create-tauri-vue-template 0.0.3

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.

Files changed (78) hide show

package/LICENSE +21 -0
package/README.md +74 -0
package/assets/vscode-settings.json +16 -0
package/dist/bin/index.js +83 -0
package/dist/cli/color.js +25 -0
package/dist/cli/files.js +18 -0
package/dist/cli/project.js +48 -0
package/dist/cli/prompts.js +44 -0
package/dist/cli/release-workflow.js +13 -0
package/dist/cli/scaffold.js +30 -0
package/dist/cli/text.js +24 -0
package/dist/cli/types.js +1 -0
package/dist/scripts/prepare-template.js +67 -0
package/package.json +39 -0
package/template/.editorconfig +8 -0
package/template/.gitattributes +5 -0
package/template/.github/dependabot.yml +38 -0
package/template/.github/workflows/code-quality.yml +70 -0
package/template/.github/workflows/release.yml +112 -0
package/template/.husky/pre-commit +7 -0
package/template/.oxfmtrc.json +36 -0
package/template/.oxlintrc.json +24 -0
package/template/.vscode/extensions.json +11 -0
package/template/CHANGELOG.md +12 -0
package/template/LICENSE +21 -0
package/template/README.md +126 -0
package/template/components.json +24 -0
package/template/eslint.config.ts +32 -0
package/template/index.html +14 -0
package/template/package.json +74 -0
package/template/pnpm-lock.yaml +3953 -0
package/template/pnpm-workspace.yaml +3 -0
package/template/public/favicon.ico +0 -0
package/template/rust-toolchain.toml +2 -0
package/template/scripts/bump-version.js +42 -0
package/template/scripts/rename-app.js +137 -0
package/template/scripts/utils.js +59 -0
package/template/src/App.vue +71 -0
package/template/src/assets/fonts/Geist/Geist-Italic[wght].woff2 +0 -0
package/template/src/assets/fonts/Geist/Geist[wght].woff2 +0 -0
package/template/src/assets/images/tauri.svg +6 -0
package/template/src/assets/images/vite.svg +1 -0
package/template/src/assets/images/vue.svg +1 -0
package/template/src/generated/auto-import.d.ts +139 -0
package/template/src/generated/bindings.ts +9 -0
package/template/src/lib/utils.ts +8 -0
package/template/src/main.ts +9 -0
package/template/src/styles/fonts.css +15 -0
package/template/src/styles/globals.css +130 -0
package/template/src/vite-env.d.ts +7 -0
package/template/src-tauri/Cargo.lock +6328 -0
package/template/src-tauri/Cargo.toml +41 -0
package/template/src-tauri/build.rs +3 -0
package/template/src-tauri/capabilities/default.json +7 -0
package/template/src-tauri/icons/128x128.png +0 -0
package/template/src-tauri/icons/128x128@2x.png +0 -0
package/template/src-tauri/icons/32x32.png +0 -0
package/template/src-tauri/icons/Square107x107Logo.png +0 -0
package/template/src-tauri/icons/Square142x142Logo.png +0 -0
package/template/src-tauri/icons/Square150x150Logo.png +0 -0
package/template/src-tauri/icons/Square284x284Logo.png +0 -0
package/template/src-tauri/icons/Square30x30Logo.png +0 -0
package/template/src-tauri/icons/Square310x310Logo.png +0 -0
package/template/src-tauri/icons/Square44x44Logo.png +0 -0
package/template/src-tauri/icons/Square71x71Logo.png +0 -0
package/template/src-tauri/icons/Square89x89Logo.png +0 -0
package/template/src-tauri/icons/StoreLogo.png +0 -0
package/template/src-tauri/icons/icon.icns +0 -0
package/template/src-tauri/icons/icon.ico +0 -0
package/template/src-tauri/icons/icon.png +0 -0
package/template/src-tauri/src/command/mod.rs +13 -0
package/template/src-tauri/src/lib.rs +54 -0
package/template/src-tauri/src/main.rs +6 -0
package/template/src-tauri/tauri.conf.json +37 -0
package/template/tsconfig.app.json +11 -0
package/template/tsconfig.json +11 -0
package/template/tsconfig.node.json +11 -0
package/template/vite.config.ts +42 -0

package/template/.github/workflows/release.yml ADDED Viewed

@@ -0,0 +1,112 @@
+name: Release
+on:
+  push:
+    branches:
+      - release
+  workflow_dispatch:
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: true
+env:
+  NODE_VERSION: 24
+  PNPM_VERSION: 11
+jobs:
+  build:
+    permissions:
+      contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: macos-latest
+            args: --target aarch64-apple-darwin
+          - platform: macos-latest
+            args: --target x86_64-apple-darwin
+          - platform: ubuntu-22.04
+            args: ''
+          - platform: windows-latest
+            args: ''
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+      - name: Install Linux dependencies
+        if: matrix.platform == 'ubuntu-22.04'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v6
+        with:
+          version: ${{ env.PNPM_VERSION }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: pnpm
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
+      - name: Rust cache
+        uses: swatinem/rust-cache@v2
+        with:
+          workspaces: './src-tauri -> target'
+      - name: Install frontend dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Read release changelog
+        id: changelog
+        shell: pwsh
+        run: |
+          $version = $env:GITHUB_REF_NAME -replace '^v', ''
+          if ($version -eq $env:GITHUB_REF_NAME) {
+            $version = node -p "require('./package.json').version"
+          }
+          $content = Get-Content CHANGELOG.md -Raw
+          $escapedVersion = [regex]::Escape($version)
+          $pattern = "(?ms)^##\s+(?<heading>\[?v?$escapedVersion\]?(?:\s+-[^\r\n]*)?)\r?\n(?<body>.*?)(?=^##\s+|\z)"
+          $match = [regex]::Match($content, $pattern)
+          if (!$match.Success -or [string]::IsNullOrWhiteSpace($match.Groups["body"].Value)) {
+            Write-Error "No changelog entry found for version $version"
+            exit 1
+          }
+          $ref = $env:GITHUB_REF_NAME
+          $anchor = $match.Groups["heading"].Value.Trim().ToLowerInvariant()
+          $anchor = $anchor -replace '[\[\]\.]', ''
+          $anchor = $anchor -replace '[^a-z0-9 _-]', ''
+          $anchor = $anchor -replace '\s+', '-'
+          $changelogUrl = "$env:GITHUB_SERVER_URL/$env:GITHUB_REPOSITORY/blob/$ref/CHANGELOG.md#$anchor"
+          $body = $match.Groups["body"].Value.Trim() + "`n`n[See full changelog]($changelogUrl)"
+          $delimiter = [guid]::NewGuid().ToString()
+          "body<<$delimiter" >> $env:GITHUB_OUTPUT
+          $body >> $env:GITHUB_OUTPUT
+          $delimiter >> $env:GITHUB_OUTPUT
+      - name: Build and upload release
+        uses: tauri-apps/tauri-action@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tagName: v__VERSION__
+          releaseName: Tauri Vue Template v__VERSION__
+          releaseBody: ${{ steps.changelog.outputs.body }}
+          releaseDraft: true
+          prerelease: false
+          args: ${{ matrix.args }}

package/template/.husky/pre-commit ADDED Viewed

@@ -0,0 +1,7 @@
+#!/bin/bash
+pnpm lint-staged
+cd src-tauri
+cargo fmt
+git add .

package/template/.oxfmtrc.json ADDED Viewed

@@ -0,0 +1,36 @@
+{
+    "$schema": "./node_modules/oxfmt/configuration_schema.json",
+    "endOfLine": "lf",
+    "ignorePatterns": ["dist/**", "src/generated/**", "src-tauri/gen/**", "src-tauri/target/**"],
+    "jsxSingleQuote": true,
+    "printWidth": 100,
+    "semi": true,
+    "singleQuote": true,
+    "sortImports": {
+        "newlinesBetween": true,
+        "groups": [
+            "type-import",
+            "value-builtin",
+            "value-external",
+            "value-internal",
+            ["value-parent", "value-sibling", "value-index"],
+            "style",
+            "side_effect",
+            "unknown"
+        ]
+    },
+    "sortTailwindcss": {
+        "functions": ["clsx", "cn", "cva", "twMerge"]
+    },
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "overrides": [
+        {
+            "files": ["**/*.yml", "**/*.yaml"],
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}

package/template/.oxlintrc.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "plugins": ["eslint", "import", "oxc", "typescript", "vue"],
+    "env": {
+        "browser": true
+    },
+    "categories": {
+        "correctness": "error"
+    },
+    "ignorePatterns": ["dist/**", "src/generated/**", "src-tauri/target/**"],
+    "rules": {
+        "curly": "error",
+        "import/consistent-type-specifier-style": "error",
+        "typescript/consistent-type-imports": [
+            "error",
+            {
+                "prefer": "type-imports",
+                "fixStyle": "separate-type-imports"
+            }
+        ],
+        "typescript/no-empty-object-type": "off",
+        "typescript/no-explicit-any": "off"
+    }
+}

package/template/.vscode/extensions.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+    "recommendations": [
+        "Vue.volar",
+        "EditorConfig.EditorConfig",
+        "oxc.oxc-vscode",
+        "dbaeumer.vscode-eslint",
+        "bradlc.vscode-tailwindcss",
+        "rust-lang.rust-analyzer",
+        "tauri-apps.tauri-vscode"
+    ]
+}

package/template/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,12 @@
+# Changelog
+## v0.0.1 - 2026-05-23
+### Added
+- Initial Tauri 2 desktop application template with Vue 3, TypeScript, Vite, and Tailwind CSS 4.
+- shadcn-vue conventions, Lucide Vue, and shared UI utilities for application interface development.
+- Rust backend shell with Tauri command registration and generated Rust-to-TypeScript bindings through Specta.
+- Project scripts for development, production builds, app renaming, version bumping, linting, and formatting.
+- GitHub Actions workflows for frontend quality checks, Rust formatting and Clippy checks, and cross-platform release builds.
+- Release packaging for macOS, Linux, and Windows through `tauri-apps/tauri-action`.

package/template/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 duonghieu0712z
+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/template/README.md ADDED Viewed

@@ -0,0 +1,126 @@
+# Tauri Vue Template
+A compact Tauri 2 + Vue 3 template for desktop apps. It includes TypeScript, Vite, Tailwind CSS 4, shadcn-vue conventions, typed Rust-to-TypeScript bindings through Specta, and GitHub Actions for code quality and release builds.
+## Stack
+This template keeps the stack focused on the pieces that usually need project-level wiring:
+- [Tauri 2](https://tauri.app/) with [Rust](https://www.rust-lang.org/) for the desktop shell and backend commands
+- [Vue 3](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/), and [Vite](https://vite.dev/) for the frontend
+- [shadcn-vue](https://www.shadcn-vue.com/) conventions with [Tailwind CSS 4](https://tailwindcss.com/) and [Lucide Vue](https://lucide.dev/) for UI
+- [Specta](https://github.com/specta-rs/specta) and [tauri-specta](https://github.com/oscartbeaumont/tauri-specta) for generated Rust-to-TypeScript bindings
+- [Oxlint](https://oxc.rs/docs/guide/usage/linter.html), [ESLint](https://eslint.org/), and [Oxfmt](https://oxc.rs/docs/guide/usage/formatter.html) for linting and formatting
+## Prerequisites
+Install Node.js, pnpm, Rust, and the Tauri system dependencies for your operating system. The package is configured for Node.js `^20.19.0 || >=22.12.0`; GitHub Actions currently use Node.js 24 and pnpm 11.
+On Ubuntu/Debian, install the Tauri Linux dependencies:
+```bash
+sudo apt-get update
+sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
+```
+## Create a New Project
+After publishing the create package, scaffold a new project with:
+```bash
+pnpm create @duonghieu0712z/tauri-vue-template@latest
+```
+Pass values directly when needed:
+```bash
+pnpm create @duonghieu0712z/tauri-vue-template@latest my-app --name "My App" --id "com.example.my-app" --author "Your Name"
+```
+The create package copies this template into the target directory, updates the package name, Tauri product name, application identifier, Rust crate names, release workflow metadata, and then leaves dependency installation to the new project.
+## Development
+Install dependencies:
+```bash
+pnpm install
+```
+Run the desktop app in development mode:
+```bash
+pnpm start
+```
+## Local Build
+Build the full Tauri desktop app locally:
+```bash
+pnpm make
+```
+The generated installers and bundles are written under `src-tauri/target/release/bundle/`.
+## Quality Checks
+Check formatting and linting:
+```bash
+pnpm format
+pnpm lint
+```
+Apply automatic fixes:
+```bash
+pnpm format:fix
+pnpm lint:fix
+```
+## Rust and TypeScript Bridge
+Backend commands live in `src-tauri/src/command/` and are registered through `tauri-specta`. During debug builds, Specta exports TypeScript bindings to `src/generated/bindings.ts`, so frontend calls can use generated types instead of manually duplicated contracts.
+## Rename the App
+After creating a new project from this template, update the application name and Tauri identifier:
+```bash
+pnpm rename --name "My App" --id "com.example.my-app" --author "Your Name"
+```
+Set the package name explicitly when needed:
+```bash
+pnpm rename --name "My App" --id "com.example.my-app" --author "Your Name" --package "my-app"
+```
+After renaming, review the updated project identity in:
+- `package.json`
+- `index.html`
+- `src-tauri/tauri.conf.json`
+- `src-tauri/Cargo.toml`
+- `src-tauri/src/main.rs`
+- `.github/workflows/release.yml`
+Regenerate lockfiles after renaming:
+```bash
+pnpm install
+cargo check --manifest-path src-tauri/Cargo.toml
+```
+## Versioning and Releases
+Bump the app version:
+```bash
+pnpm bump 0.1.0
+```
+The version script updates `package.json`, `src-tauri/tauri.conf.json`, and `src-tauri/Cargo.toml`.
+The release workflow builds macOS, Linux, and Windows bundles with `tauri-apps/tauri-action`, then creates a GitHub Release with the generated installers attached.

package/template/components.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+    "$schema": "https://shadcn-vue.com/schema.json",
+    "style": "new-york",
+    "font": "geist-sans",
+    "typescript": true,
+    "tailwind": {
+        "config": "",
+        "css": "src/styles/globals.css",
+        "baseColor": "neutral",
+        "cssVariables": true,
+        "prefix": ""
+    },
+    "iconLibrary": "lucide",
+    "rtl": false,
+    "pointer": true,
+    "aliases": {
+        "components": "@/components",
+        "utils": "@/lib/utils",
+        "ui": "@/components/ui",
+        "lib": "@/lib",
+        "composables": "@/composables"
+    },
+    "registries": {}
+}

package/template/eslint.config.ts ADDED Viewed

@@ -0,0 +1,32 @@
+import skipFormatting from '@vue/eslint-config-prettier/skip-formatting';
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript';
+import pluginOxlint from 'eslint-plugin-oxlint';
+import pluginVue from 'eslint-plugin-vue';
+import { globalIgnores } from 'eslint/config';
+export default defineConfigWithVueTs(
+    {
+        name: 'app/files-to-lint',
+        files: ['**/*.{vue,ts,mts,tsx}'],
+    },
+    globalIgnores(['dist/**', 'src/generated/**', 'src-tauri/target/**']),
+    ...pluginVue.configs['flat/essential'],
+    vueTsConfigs.recommended,
+    ...pluginOxlint.buildFromOxlintConfigFile('.oxlintrc.json'),
+    skipFormatting,
+    {
+        rules: {
+            '@typescript-eslint/no-empty-object-type': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+            'vue/attributes-order': ['error', { alphabetical: true }],
+            'vue/multi-word-component-names': 'off',
+            'vue/require-default-prop': 'off',
+        },
+    },
+);

package/template/index.html ADDED Viewed

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <link rel="icon" href="favicon.ico" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>Tauri Vue Template</title>
+    </head>
+    <body>
+        <div id="app"></div>
+        <script type="module" src="src/main.ts"></script>
+    </body>
+</html>

package/template/package.json ADDED Viewed

@@ -0,0 +1,74 @@
+{
+    "name": "tauri-vue-template",
+    "version": "0.0.1",
+    "private": true,
+    "author": "duonghieu0712z",
+    "type": "module",
+    "scripts": {
+        "dev": "vite",
+        "build": "run-p type-check \"build-only {@}\" --",
+        "preview": "vite preview",
+        "build-only": "vite build",
+        "type-check": "vue-tsc --noEmit",
+        "start": "pnpm tauri dev",
+        "make": "pnpm tauri build",
+        "lint": "run-s lint:check:*",
+        "lint:fix": "run-s lint:fix:*",
+        "lint:check:oxlint": "oxlint .",
+        "lint:check:eslint": "eslint . --cache",
+        "lint:fix:oxlint": "oxlint --fix .",
+        "lint:fix:eslint": "eslint --fix . --cache",
+        "format": "oxfmt --check .",
+        "format:fix": "oxfmt .",
+        "bump": "node scripts/bump-version.js",
+        "rename": "node scripts/rename-app.js",
+        "prepare": "husky"
+    },
+    "dependencies": {
+        "@lucide/vue": "^1.16.0",
+        "@tauri-apps/api": "^2.11.0",
+        "class-variance-authority": "^0.7.1",
+        "clsx": "^2.1.1",
+        "tailwind-merge": "^3.6.0",
+        "vue": "^3.5.34"
+    },
+    "devDependencies": {
+        "@tailwindcss/vite": "^4.3.0",
+        "@tauri-apps/cli": "^2.11.2",
+        "@tsconfig/node24": "^24.0.4",
+        "@types/node": "^25.9.1",
+        "@vitejs/plugin-vue": "^6.0.7",
+        "@vue/eslint-config-prettier": "^10.2.0",
+        "@vue/eslint-config-typescript": "^14.7.0",
+        "@vue/tsconfig": "^0.9.1",
+        "eslint": "^10.4.0",
+        "eslint-plugin-oxlint": "^1.66.0",
+        "eslint-plugin-vue": "^10.9.1",
+        "husky": "^9.1.7",
+        "jiti": "^2.7.0",
+        "lint-staged": "^17.0.5",
+        "npm-run-all2": "^9.0.0",
+        "oxfmt": "^0.51.0",
+        "oxlint": "^1.66.0",
+        "tailwindcss": "^4.3.0",
+        "tw-animate-css": "^1.4.0",
+        "typescript": "~6.0.3",
+        "unplugin-auto-import": "^21.0.0",
+        "unplugin-vue-components": "^32.1.0",
+        "vite": "^8.0.14",
+        "vite-plugin-vue-devtools": "^8.1.2",
+        "vue-tsc": "^3.3.1"
+    },
+    "lint-staged": {
+        "*.{js,ts,tsx,vue,html,css,json,yml,yaml}": [
+            "oxfmt"
+        ],
+        "*.{js,ts,tsx,vue}": [
+            "oxlint --fix",
+            "eslint --fix"
+        ]
+    },
+    "engines": {
+        "node": "^20.19.0 || >=22.12.0"
+    }
+}