czon 0.1.0 → 0.1.2

package/.github/workflows/bump-version.yml

@@ -0,0 +1,112 @@
+name: Bump Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version bump type'
+        required: true
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+        default: 'patch'
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          persist-credentials: true
+
+      - name: Setup Git
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: Sync with remote
+        run: |
+          git fetch origin
+          git checkout -b bump-version-${{ github.run_id }}
+          git reset --hard origin/main
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24.x'
+
+      - name: Get current version
+        id: get_version
+        run: |
+          CURRENT_VERSION=$(jq -r '.version' package.json)
+          echo "current_version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+          echo "Current version: $CURRENT_VERSION"
+
+      - name: Bump version
+        id: bump_version
+        run: |
+          # 解析当前版本号 (支持 semver 格式)
+          CURRENT_VERSION="${{ steps.get_version.outputs.current_version }}"
+          echo "Current version: $CURRENT_VERSION"
+
+          # 使用 npm version 命令来安全地更新版本
+          # 这会自动处理 semver 规则
+          npm version "${{ github.event.inputs.version }}" --no-git-tag-version
+
+          # 获取新版本
+          NEW_VERSION=$(jq -r '.version' package.json)
+          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "New version: $NEW_VERSION"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: |
+          npm run test:types
+          npm run test:build
+          npm run test:cli
+
+      - name: Show changed files
+        run: |
+          echo "Changed files:"
+          git status --porcelain
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore: bump version from ${{ steps.get_version.outputs.current_version }} to ${{ steps.bump_version.outputs.new_version }}"
+          title: "chore: bump version from ${{ steps.get_version.outputs.current_version }} to ${{ steps.bump_version.outputs.new_version }}"
+          body: |
+            This PR was automatically created by the Bump Version workflow.
+
+            ## Changes
+            - Bumped version from **${{ steps.get_version.outputs.current_version }}** to **${{ steps.bump_version.outputs.new_version }}**
+            - Version bump type: **${{ github.event.inputs.version }}**
+
+            ## Test Results
+            - Type checking: ✅ Passed
+            - Build test: ✅ Passed
+            - CLI test: ✅ Passed
+
+            🤖 Generated with [Claude Code](https://claude.com/claude-code)
+
+            Co-Authored-By: Claude <noreply@anthropic.com>
+          branch: bump-version-${{ github.run_id }}
+          base: main
+          labels: |
+            automated-pr
+            version-bump
+            enhancement
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-paths: |
+            package.json
+            package-lock.json

package/.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x, 24.x]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linting (if configured)
+        run: |
+          if [ -f .eslintrc.js ] || [ -f .eslintrc.json ] || [ -f .eslintrc ]; then
+            npx eslint src/ --ext .ts,.tsx
+          else
+            echo "No ESLint config found, skipping linting"
+          fi
+
+      - name: Type check
+        run: npx tsc --noEmit
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build package
+        run: npm run build
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.x'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run npm audit
+        run: npm audit --audit-level=moderate
+
+      - name: Check for outdated dependencies
+        run: npm outdated || true

package/.github/workflows/pages.yml

@@ -0,0 +1,61 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: # 允许手动触发
+
+# 设置 GITHUB_TOKEN 的权限以允许部署到 GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# 只允许一个并发部署，跳过正在运行的队列
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          # 从远程分支开始时，需要先同步分支保证代码正确
+          fetch-depth: 0
+          ref: ${{ github.head_ref || github.ref }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24.x'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Create documentation site
+        run: |
+          npm run build:doc
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './.zen/dist'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/publish.yml

@@ -0,0 +1,81 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:  # 允许手动触发
+
+permissions:
+  contents: read
+  id-token: write  # 必需：用于 OIDC 认证
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Fetch all branches and tags
+        run: |
+          git fetch --all
+          git fetch --tags
+
+      - name: Setup Node.js for npm publish
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+
+      - name: Update npm to latest version
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build package
+        run: npm run build
+
+      - name: Verify build
+        run: |
+          ls -la dist/
+          test -f dist/index.js && test -f dist/cli.js
+          echo "Build verification successful"
+
+      - name: Check if version already published
+        id: check_version
+        run: |
+          # 获取当前 package.json 中的版本和包名
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          echo "Package name: $PACKAGE_NAME"
+          echo "Current version in package.json: $CURRENT_VERSION"
+
+          # 尝试从 npm 获取已发布的版本信息
+          if npm view $PACKAGE_NAME@$CURRENT_VERSION version > /dev/null 2>&1; then
+            echo "Version $CURRENT_VERSION is already published on npm"
+            echo "skip_publish=true" >> $GITHUB_OUTPUT
+          else
+            echo "Version $CURRENT_VERSION is not published yet"
+            echo "skip_publish=false" >> $GITHUB_OUTPUT
+          fi
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check npm version
+        run: npm --version
+
+      - name: Publish to npm
+        if: steps.check_version.outputs.skip_publish == 'false'
+        run: |
+          echo "Attempting to publish to npm..."
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.prettierignore

@@ -0,0 +1,14 @@
+# Ignore artifacts
+dist/
+node_modules/
+coverage/
+
+# Ignore demo files
+demo/
+
+# Ignore package lock
+package-lock.json
+
+# Ignore Prettier config itself
+.prettierrc.json
+.prettierignore

package/.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf"
+}

package/README.md

@@ -0,0 +1,56 @@
+# ZEN - 极简主义 Markdown + AI 静态站点构建器
+
+[> Website Demo](https://zen.zccz14.com/)
+
+## 基本功能
+
+1. 📃 **静态站点生成**：将任意一个包含 Markdown 的 git 文件夹构建成一个静态 HTML 站点。
+2. 🧭 **智能分类导航**：使用 AI 进行内容分析，生成站点地图和导航，源文件的位置不敏感。
+3. 🌍 **自动增量翻译**：使用 AI 进行增量翻译，让用户使用母语编写 Markdown，但是用户可以是多语言的。
+
+为什么又搞了个 Markdown 静态站点生成器？我重新思考了 AI 时代下，文档工具可以如何更好地服务于写作者：
+
+- 回归内容：最小化打扰，专注写作
+
+  让文档回归本质，让写作回归宁静。
+
+  其一，我不想做图书管理员。我有时想写下一些内容，但我可能还没有想好它的标题，还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
+
+  其二，我的书房必须打扫干净。我不想要配置复杂的构建工具，折腾复杂的文档配置，不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构，我就头疼。现在，ZEN 选择将所有的配置都隐藏到 .zen 目录下，扫到角落里，用户只需要专注于写作内容，其他的交给 ZEN 来处理。其他的目录都是您的写作空间，您可以随意组织您的 Markdown 文件。
+
+- 回归母语：用母语写作，丝滑构建多语言版本
+
+  人生苦短，我懒得翻译。人在使用母语时，才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的，我不想放弃多语言的交流。于是我希望有一个工具，能让我用母语写作，同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说，还得自己维护内容更新，太麻烦了。我选择使用 LLM 来帮我做翻译，省下了我很多时间，并且可以一键完成多国语言翻译。
+
+## 快速开始
+
+前提:
+
+- 已安装 [Node.js](https://nodejs.org/)（建议版本 18 及以上，需要有 npx 命令）
+- 已获取 [OpenAI API Key](https://platform.openai.com/account/api-keys)，或者 OPENAI 兼容的 API Key
+- 已安装 Git（用于从 Git 列出 Markdown 文件，忽略 .gitignore 规则过滤的文件）
+
+首先，工作在一个已经被 git 管理的文件夹中：
+
+配置环境变量
+
+```bash
+export OPENAI_API_KEY="sk-xxxxxx"  # 必须：请替换为您的 OpenAI API Key
+export OPENAI_BASE_URL="https://api.openai.com/v1"  # 可选，默认使用 OpenAI 官方 API
+export OPENAI_MODEL="gpt-3.5-turbo"  # 可选，默认使用 gpt-3.5-turbo 模型
+```
+
+构建站点，支持多语言翻译。使用当前目录作为源目录，输出到 `.zen/dist` 目录。
+
+- 可以通过多次使用 `--lang` 参数指定需要生成的语言版本（例如 `--lang zh-Hans --lang en-US`）。
+- 不需要配置源语言，ZEN 会自动检测。
+
+```bash
+npx zengen@latest build --lang zh-Hans --lang en-US
+```
+
+**查看更多参数或帮助**：
+
+```bash
+npx zengen@latest
+```