Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.96 KB

README.zh-CN.md

File metadata and controls

64 lines (43 loc) · 1.96 KB
Raw

Vite-Library-Strict-Mode

Vite 库“严格模式”模板（自律版）


English | 简体中文

简介

Vite 库“严格模式”模板（自律版）: JavaScript / TypeScript + 单元测试 + 代码质量测评 + 代码洁癖 + 约定式提交测评 + Git Hooks + 语义化版本控制 + ...

功能集成（魔法挨踢目录）

  • Vite Library Mode - Vite 赋能 DIY JavaScript 功能库
  • Commit Lint - 约定式提交测评
  • Change Log - 约定式日志自动化集成
  • Vitest - Vite 筑基的敏捷单元测试框架
  • Prettier - DIY 个性化代码洁癖 & 代码风格的格式化工具人（风纪委员）
  • ESLint - 无缝衔接的 Javascript 代码 QA 的测评工具人
  • simple-git-hooks - DIY Git Hooks
  • lint-staged - 暂存区文件测评的工具人
  • standard-version - npm 同款语义化版本控制的工具人

使用指南

步骤 1：使用此模板仓库

点击绿色的 "Use this template" 按钮并选择 "create a new repository"（创建新仓库）。

在此模板仓库中，我们默认使用 JavaScript 编程语言。

倘若你想使用 TypeScript，你可以检出 ts 分支，将其作为主分支使用。

步骤 2：将仓库克隆到本地

# 克隆到本地
git clone your_repo_url

# 删除 .git 目录
cd your_repo
rm -rf .git

# 初始化版本仓库以重置历史
git init

# 安装第三方依赖模块
npm install

步骤 3：DIY 你的配置

  • 修改 package.json 文件中的配置，name 和 author 等。
  • 删除 LICENSE 开源协议文件，DIY 你自己的的开源协议。在此模板中，我们默认使用 MIT 开源协议。倘若你也选择此协议，你需要在 LICENSE 文件中将作者替换为你的名字。
  • DIY 你的 README.md 文件，按需删除 README.zh-CN.md。
  • DIY 其他配置。