birc-generator 0.5.5

package/install.ps1

@@ -0,0 +1,156 @@
+# 用法:
+#   irm https://gitlab.ntubimdbirc.tw/lucashsu95/birc-generator/-/raw/main/install.ps1 | iex
+# 或下載後執行: powershell -NoProfile -ExecutionPolicy Bypass -File install.ps1
+# 需要 Node.js 18+ 與 npm。程式會放到 $HOME\.birc-generator，跟 curl | bash 同一處。
+
+$ErrorActionPreference = 'Stop'
+[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+
+function Write-Info([string]$Message) {
+    Write-Host "[INFO] $Message" -ForegroundColor Green
+}
+
+function Write-Warn([string]$Message) {
+    Write-Host "[WARN] $Message" -ForegroundColor Yellow
+}
+
+function Write-Err([string]$Message) {
+    Write-Host "[ERROR] $Message" -ForegroundColor Red
+    exit 1
+}
+
+$BaseUrl = if ($env:BIRC_BASE_URL) { $env:BIRC_BASE_URL.TrimEnd('/') } else { 'https://gitlab.ntubimdbirc.tw/lucashsu95/birc-generator' }
+$InstallDir = Join-Path $HOME '.birc-generator'
+
+function Test-NodeAndNpm {
+    $node = Get-Command node -ErrorAction SilentlyContinue
+    if (-not $node) {
+        Write-Err "找不到 Node.js。請先安裝 Node.js 18+：https://nodejs.org/"
+    }
+    $versionText = (& node -v).Trim()
+    if ($versionText -notmatch '^v(\d+)') {
+        Write-Err "無法判讀 Node.js 版本（$versionText）。"
+    }
+    $major = [int]$Matches[1]
+    if ($major -lt 18) {
+        Write-Err "Node.js 版本過低（$versionText）。需要 18+ 版本。"
+    }
+    Write-Info "Node.js 版本: $($versionText.TrimStart('v'))"
+
+    $npm = Get-Command npm -ErrorAction SilentlyContinue
+    if (-not $npm) {
+        Write-Err "找不到 npm。請先安裝 npm。"
+    }
+    Write-Info "npm 版本: $((& npm -v).Trim())"
+}
+
+function Show-PkgInfo([string]$Dir, [string]$Label) {
+    $pkg = Join-Path $Dir 'package.json'
+    if (-not (Test-Path $pkg)) {
+        Write-Warn "${Label}：找不到 package.json"
+        return
+    }
+    $meta = & node -e "const p=require(process.argv[1]); const author=typeof p.author==='string'?p.author:(p.author&&p.author.name?p.author.name:''); process.stdout.write([p.version||'?',author,p.bircUpdatedAt||''].join('\n'));" $pkg
+    $parts = @($meta -split "`n")
+    Write-Info "$Label  版本 $($parts[0])"
+    if ($parts.Count -gt 1 -and $parts[1]) { Write-Info "$Label  作者 $($parts[1])" }
+    if ($parts.Count -gt 2 -and $parts[2]) { Write-Info "$Label  更新 $($parts[2])" }
+}
+
+function Ask-Update {
+    if ($env:BIRC_AUTO_UPDATE -eq '1') {
+        Write-Info 'BIRC_AUTO_UPDATE=1，自動更新'
+        return $true
+    }
+    if (-not [Environment]::UserInteractive) {
+        Write-Info '非互動安裝，自動更新'
+        return $true
+    }
+    $reply = Read-Host '是否要更新到最新版？(Y/n)'
+    return [string]::IsNullOrWhiteSpace($reply) -or $reply -match '^[Yy]'
+}
+
+function Install-FromArchive {
+    if (Test-Path $InstallDir) {
+        Write-Warn "安裝目錄已存在: $InstallDir"
+        Show-PkgInfo $InstallDir '目前已安裝'
+        if (-not (Ask-Update)) {
+            Write-Info '跳過下載，沿用現有檔案'
+            return
+        }
+        Write-Info '更新中...'
+        Remove-Item -Recurse -Force $InstallDir
+    }
+
+    $zipUrl = "$BaseUrl/-/archive/main/birc-generator-main.zip"
+    $staging = Join-Path $env:TEMP ("birc-install-" + [guid]::NewGuid().ToString('N'))
+    New-Item -ItemType Directory -Path $staging | Out-Null
+    $zip = Join-Path $staging 'birc-generator-main.zip'
+    $extract = Join-Path $staging 'extract'
+    try {
+        Write-Info '下載專案...'
+        Invoke-WebRequest -Uri $zipUrl -OutFile $zip -UseBasicParsing
+        Expand-Archive -Path $zip -DestinationPath $extract
+        $inner = Get-ChildItem -Path $extract -Directory | Select-Object -First 1
+        if (-not $inner) {
+            Write-Err '下載的 zip 裡沒有專案資料夾。'
+        }
+        New-Item -ItemType Directory -Path (Split-Path $InstallDir -Parent) -Force | Out-Null
+        Move-Item -Path $inner.FullName -Destination $InstallDir
+        Show-PkgInfo $InstallDir '即將安裝'
+    } finally {
+        Remove-Item -Recurse -Force $staging -ErrorAction SilentlyContinue
+    }
+}
+
+function Install-Dependencies {
+    Write-Info '安裝 Node.js 依賴...'
+    Push-Location $InstallDir
+    try {
+        & npm install
+        if ($LASTEXITCODE -ne 0) {
+            Write-Err 'npm install 失敗。'
+        }
+    } finally {
+        Pop-Location
+    }
+}
+
+function Install-CommandShim {
+    $jsPath = Join-Path $InstallDir 'bin\birc.js'
+    if (-not (Test-Path $jsPath)) {
+        Write-Err "找不到 $jsPath"
+    }
+    & node (Join-Path $InstallDir 'bin\home-install.js') install-command $jsPath
+    if ($LASTEXITCODE -ne 0) {
+        Write-Err '寫入 birc 指令失敗。'
+    }
+}
+
+function Warn-IfNpmMixed {
+    $existing = Get-Command birc -ErrorAction SilentlyContinue
+    if ($existing -and $existing.Source -match 'node_modules') {
+        Write-Warn 'PATH 上的 birc 來自 npm 全域安裝。同一台不要混裝；要改走這份安裝，先 npm uninstall -g birc-generator。'
+    }
+}
+
+function Test-Installation {
+    $existing = Get-Command birc -ErrorAction SilentlyContinue
+    if ($existing) {
+        Write-Info '安裝成功。可執行 birc --help'
+    } else {
+        Write-Warn '目前這個視窗還找不到 birc。關掉終端再開一次，或確認 npm prefix 已在 PATH。'
+    }
+}
+
+Write-Info '開始安裝 birc-generator...'
+Warn-IfNpmMixed
+Test-NodeAndNpm
+Install-FromArchive
+Install-Dependencies
+Install-CommandShim
+Show-PkgInfo $InstallDir '安裝完成'
+Test-Installation
+Write-Info "常用指令: birc create / birc make:entity User / birc --help"
+Write-Info "之後更新用 birc update。"
+Write-Info "解除安裝: irm $BaseUrl/-/raw/main/uninstall.ps1 | iex"

package/install.sh

@@ -0,0 +1,201 @@
+#!/bin/bash
+set -e
+
+# 用法: curl -fsSL https://gitlab.ntubimdbirc.tw/lucashsu95/birc-generator/-/raw/main/install.sh | bash
+# 或下載後執行: bash install.sh
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m'
+
+info() { echo -e "${GREEN}[INFO]${NC} $1"; }
+warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
+error() { echo -e "${RED}[ERROR]${NC} $1"; exit 1; }
+
+INSTALL_DIR="$HOME/.birc-generator"
+DEFAULT_BASE_URL="https://gitlab.ntubimdbirc.tw/lucashsu95/birc-generator"
+BASE_URL="${BIRC_BASE_URL:-$DEFAULT_BASE_URL}"
+BASE_URL="${BASE_URL%/}"
+
+# 自訂下載來源等於要從別台機器抓程式回來執行。env 被 .bashrc 或 CI 塞了
+# BIRC_BASE_URL 時，這裡必須大聲問過使用者；非互動環境一律拒絕，
+# 要自動化就明確設 BIRC_ALLOW_CUSTOM_BASE=1。
+confirm_base_url() {
+    [ "$BASE_URL" = "$DEFAULT_BASE_URL" ] && return 0
+    warn "偵測到自訂下載來源: $BASE_URL"
+    warn "會從這個來源下載並執行程式碼，有資安風險。"
+    if [ "${BIRC_ALLOW_CUSTOM_BASE:-}" = "1" ]; then
+        info "BIRC_ALLOW_CUSTOM_BASE=1，繼續使用自訂來源"
+        return 0
+    fi
+    local reply=""
+    if [ -r /dev/tty ]; then
+        printf '確定要從自訂來源安裝嗎？(y/N): ' > /dev/tty
+        read -r reply < /dev/tty || true
+    elif [ -t 0 ]; then
+        read -r -p "確定要從自訂來源安裝嗎？(y/N): " reply || true
+    else
+        error "非互動環境不接受自訂來源。要強制使用請設 BIRC_ALLOW_CUSTOM_BASE=1。"
+    fi
+    [[ "$reply" =~ ^[Yy] ]] || error "已取消安裝。"
+}
+
+print_pkg_info() {
+    local dir="$1"
+    local label="${2:-birc}"
+    local pkg="$dir/package.json"
+    if [ ! -f "$pkg" ]; then
+        warn "${label}：找不到 package.json"
+        return 0
+    fi
+    local meta
+    meta="$(node -e '
+      const p = require(process.argv[1]);
+      const author = typeof p.author === "string"
+        ? p.author
+        : (p.author && p.author.name ? p.author.name : "");
+      process.stdout.write([p.version || "?", author, p.bircUpdatedAt || ""].join("\n"));
+    ' "$pkg")"
+    local ver author updated
+    ver="$(printf '%s\n' "$meta" | sed -n '1p')"
+    author="$(printf '%s\n' "$meta" | sed -n '2p')"
+    updated="$(printf '%s\n' "$meta" | sed -n '3p')"
+    info "${label}  版本 ${ver}"
+    [ -n "$author" ] && info "${label}  作者 ${author}"
+    [ -n "$updated" ] && info "${label}  更新 ${updated}"
+}
+
+check_node() {
+    if ! command -v node &> /dev/null; then
+        error "找不到 Node.js。請先安裝 Node.js 18+：https://nodejs.org/"
+    fi
+    local NODE_VERSION MAJOR_VERSION
+    NODE_VERSION="$(node -v | sed 's/v//')"
+    MAJOR_VERSION="$(echo "$NODE_VERSION" | cut -d. -f1)"
+    if [ "$MAJOR_VERSION" -lt 18 ]; then
+        error "Node.js 版本過低（$NODE_VERSION）。需要 18+ 版本。"
+    fi
+    info "Node.js 版本: $NODE_VERSION"
+}
+
+check_npm() {
+    if ! command -v npm &> /dev/null; then
+        error "找不到 npm。請先安裝 npm。"
+    fi
+    info "npm 版本: $(npm -v)"
+}
+
+# curl | bash 時 stdin 是腳本本身，read 會讀到 EOF 然後被 set -e 整支杀掉。
+# 改問 /dev/tty；沒有終端機就當成要更新。
+ask_update() {
+    if [ "${BIRC_AUTO_UPDATE:-}" = "1" ]; then
+        info "BIRC_AUTO_UPDATE=1，自動更新"
+        return 0
+    fi
+    local reply=""
+    if [ -r /dev/tty ]; then
+        printf '是否要更新到最新版？(Y/n): ' > /dev/tty
+        read -r reply < /dev/tty || true
+    elif [ -t 0 ]; then
+        read -r -p "是否要更新到最新版？(Y/n): " reply || true
+    else
+        info "非互動安裝，自動更新"
+        return 0
+    fi
+    [[ -z "$reply" || "$reply" =~ ^[Yy] ]]
+}
+
+# 解壓前先驗壓縮檔清單。curl | tar 直接管線時，壞檔半路斷線或被塞
+# ../ 路徑都攔不到；先落地再檢查才擋得住 tar slip。
+# 任何一段是 .. 都拒絕：第一層若就是 ..，會被 --strip-components=1 剝掉而漏判；
+# strip 只用來抓「剝完變絕對路徑」的名字（如 //x）。
+validate_tar_safety() {
+    local archive="$1"
+    local links bad
+    if ! links="$(tar -tvzf "$archive" | awk '$1 ~ /^[lh]/')"; then
+        error "無法讀取下載的壓縮檔內容。"
+    fi
+    if [ -n "$links" ]; then
+        error "壓縮檔內含符號或硬連結項目，拒絕解壓:\n$links"
+    fi
+    if ! bad="$(tar -tzf "$archive" | awk '
+        {
+            line = $0
+            bad = 0
+            n = split(line, seg, "/")
+            for (i = 1; i <= n; i++) {
+                if (seg[i] == "..") { bad = 1; break }
+            }
+            if (line ~ /^\//) { bad = 1 }
+            stripped = line
+            sub(/^[^\/]*\//, "", stripped)
+            if (stripped ~ /^\//) { bad = 1 }
+            if (bad) { print $0 }
+        }
+    ')"; then
+        error "無法讀取下載的壓縮檔內容。"
+    fi
+    if [ -n "$bad" ]; then
+        error "壓縮檔含不安全的路徑（可能為 tar slip 攻擊），拒絕解壓:\n$bad"
+    fi
+}
+
+download_project() {
+    if [ -d "$INSTALL_DIR" ]; then
+        warn "安裝目錄已存在: $INSTALL_DIR"
+        print_pkg_info "$INSTALL_DIR" "目前已安裝"
+        if ask_update; then
+            info "更新中..."
+            rm -rf "$INSTALL_DIR"
+        else
+            info "跳過下載，沿用現有檔案"
+            cd "$INSTALL_DIR"
+            return 0
+        fi
+    fi
+
+    info "下載專案..."
+    local TAR_URL="${BASE_URL}/-/archive/main/birc-generator-main.tar.gz"
+    local tmp_tar
+    tmp_tar="$(mktemp)"
+    mkdir -p "$INSTALL_DIR"
+    curl -fsSL "$TAR_URL" -o "$tmp_tar"
+    validate_tar_safety "$tmp_tar"
+    tar xzf "$tmp_tar" -C "$INSTALL_DIR" --strip-components=1
+    rm -f "$tmp_tar"
+    cd "$INSTALL_DIR"
+    print_pkg_info "$INSTALL_DIR" "即將安裝"
+}
+
+install_dependencies() {
+    info "安裝 Node.js 依賴..."
+    npm install
+}
+
+create_symlink() {
+    node "$(pwd)/bin/home-install.js" install-command "$(pwd)/bin/birc.js"
+}
+
+test_installation() {
+    if command -v birc &> /dev/null; then
+        info "安裝成功。可執行 birc --help"
+    else
+        warn "目前 shell 還找不到 birc，關掉終端再開一次，或執行 hash -r"
+    fi
+}
+
+main() {
+    info "開始安裝 birc-generator..."
+    check_node
+    check_npm
+    confirm_base_url
+    download_project
+    install_dependencies
+    create_symlink
+    print_pkg_info "$(pwd)" "安裝完成"
+    test_installation
+    info "常用指令: birc create / birc make:entity User / birc --help"
+}
+
+main "$@"

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "birc-generator",
+  "version": "0.5.5",
+  "description": "Spring Boot 4 CRUD scaffold generator built on Plop.js",
+  "license": "MIT",
+  "author": "lucashsu95",
+  "keywords": [
+    "spring-boot",
+    "generator",
+    "plop",
+    "crud",
+    "scaffold"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "bin": {
+    "birc": "bin/birc.js"
+  },
+  "files": [
+    "bin",
+    "plopfile.js",
+    "versions.js",
+    "templates",
+    "project-docs",
+    "scripts",
+    "install.sh",
+    "install.ps1",
+    "uninstall.sh",
+    "uninstall.ps1",
+    "AGENTS.md",
+    "PROJECT.md",
+    "implement.md",
+    "test.md",
+    ".bircrc.example.json"
+  ],
+  "scripts": {
+    "generate": "plop",
+    "test": "node --test test/*.test.js",
+    "test:coverage": "c8 npm test",
+    "test:mutation": "stryker run"
+  },
+  "c8": {
+    "include": [
+      "plopfile.js",
+      "versions.js",
+      "bin/cli-util.js"
+    ],
+    "reporter": [
+      "text",
+      "json-summary"
+    ],
+    "check-coverage": true,
+    "lines": 80,
+    "functions": 80,
+    "branches": 65,
+    "statements": 80
+  },
+  "devDependencies": {
+    "@stryker-mutator/core": "^10.0.0",
+    "c8": "^12.0.0",
+    "plop": "^4.0.1"
+  },
+  "dependencies": {
+    "js-yaml": "^5.3.0",
+    "node-plop": "^0.32.3"
+  }
+}