@mazhu/envpreset

🚀 一键配置开发环境 CLI 工具 - ESLint、Prettier、TypeScript 等开箱即用

安装

npm install -g @mazhu/envpreset

或者使用 npx（无需安装）：

npx @mazhu/envpreset init

使用方法

交互式初始化

envpreset init

启动交互式命令行界面，选择需要配置的工具和预设。

快速添加配置

# 添加 ESLint 配置
envpreset add eslint

# 添加 Prettier 配置
envpreset add prettier

# 添加 TypeScript 配置
envpreset add typescript

# 添加所有配置
envpreset add all

支持的工具

ESLint

支持以下预设：

• Standard - JavaScript Standard Style
• Airbnb - Airbnb JavaScript Style Guide
• 推荐配置 - 仅包含 ESLint 推荐规则

生成文件：

• .eslintrc.js - ESLint 配置文件
• .eslintignore - ESLint 忽略文件

Prettier

代码格式化工具，自动统一代码风格。

生成文件：

• .prettierrc - Prettier 配置文件
• .prettierignore - Prettier 忽略文件

TypeScript

JavaScript 的超集，提供类型安全。

支持两种模式：

• 严格模式 - 启用所有严格类型检查
• 宽松模式 - 基础类型检查

生成文件：

• tsconfig.json - TypeScript 配置文件

自动添加的 NPM Scripts

运行 envpreset 后，会自动在 package.json 中添加以下脚本：

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix",
    "format": "prettier --write .",
    "format:check": "prettier --check .",
    "build": "tsc",
    "type-check": "tsc --noEmit"
  }
}

示例

# 在新项目中初始化
mkdir my-project && cd my-project
envpreset init

# 选择 ESLint + Prettier
# 安装依赖
npm install

# 开始开发！

配置说明

ESLint + Prettier 集成

当同时选择 ESLint 和 Prettier 时，会自动安装 eslint-config-prettier 和 eslint-plugin-prettier，避免两者规则冲突。

TypeScript 严格模式

严格模式启用了以下额外检查：

• noUnusedLocals - 禁止未使用的局部变量
• noUnusedParameters - 禁止未使用的参数
• noImplicitReturns - 函数所有代码路径都必须有返回值
• noFallthroughCasesInSwitch - 禁止 switch 穿透
• noUncheckedIndexedAccess - 索引访问时包含 undefined
• exactOptionalPropertyTypes - 可选属性类型精确匹配

许可证

MIT © Mike Wang

相关链接

• GitHub 仓库
• 问题反馈