Files
2026-07-13 21:35:40 +08:00

2.1 KiB

name, description
name description
setting-up 项目初始化文件,包括 .gitignore、GitHub Actions 工作流和 VS Code 扩展。用于初始化新项目或添加 CI/编辑器配置。

项目初始化

.gitignore

.gitignore 不存在时创建:

*.log
*.tgz
.cache
.DS_Store
.eslintcache
.idea
.env
.nuxt
.temp
.output
.turbo
cache
coverage
dist
lib-cov
logs
node_modules
temp

GitHub Actions

在设置新项目时添加以下工作流。如果工作流已存在则跳过。所有工作流均使用 sxzz/workflows 可复用工作流。

自动修复工作流

.github/workflows/autofix.yml - 在 PR 上自动修复 lint 问题:

name: autofix.ci

on: [pull_request]

jobs:
  autofix:
    uses: sxzz/workflows/.github/workflows/autofix.yml@v1
    permissions:
      contents: read

单元测试工作流

.github/workflows/unit-test.yml - 在推送/PR 时运行测试:

name: Unit Test

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

permissions: {}

jobs:
  unit-test:
    uses: sxzz/workflows/.github/workflows/unit-test.yml@v1

发布工作流

.github/workflows/release.yml - 在打标签时发布(仅限库项目):

name: Release

on:
  push:
    tags:
      - 'v*'

jobs:
  release:
    uses: sxzz/workflows/.github/workflows/release.yml@v1
    with:
      publish: true
    permissions:
      contents: write
      id-token: write

VS Code 扩展

.vscode/extensions.json 中配置:

{
  "recommendations": [
    "dbaeumer.vscode-eslint",
    "antfu.pnpm-catalog-lens",
    "antfu.iconify",
    "antfu.unocss",
    "antfu.slidev",
    "vue.volar"
  ]
}
扩展 描述
dbaeumer.vscode-eslint ESLint 集成,用于 lint 检查和格式化
antfu.pnpm-catalog-lens 行内显示 pnpm 目录版本提示
antfu.iconify Iconify 图标预览和自动补全
antfu.unocss UnoCSS 智能感知和语法高亮
antfu.slidev Slidev 预览和语法高亮
vue.volar Vue 语言功能