eslint (Pleaseai)

@请/lint

将ESLint配置转换为编码助手的AI可读规则。

概述

@pleaseai/lint 自动将ESLint规则转换为AI编码助手可以理解的指南。这确保了AI生成的代码从一开始就遵循项目的编码标准。

支持的AI助手

• 光标 - .cursor/rules/
• VS代码副本 - .github/copilot-instructions.md
• 克劳德代码 - .claude/CLAUDE.md
• 帆板运动 - .windsurfrules
• 泽德 - .zed/rules/
• 法典 - AGENTS.md
• 基罗 - .kiro/rules/
• 克莱恩 - .clinerules
• 安培 - .amp/rules/
• 帮助 - .aider/rules/
• Firebase 控制台 - .idx/airules.md
• 开放之手 - .openhands/microagents/
• Gemini CLI - GEMINI.md
• 六月 - .junie/rules/
• 增补代码 - augment-guidelines.md
• 基洛代码 - .kilocode/rules/
• 鹅 - .goosehints
• Roo代码 - .roo/rules/
• 曲速 - .warp/rules/

安装

# npm
npm install -g @pleaseai/lint

# pnpm
pnpm add -g @pleaseai/lint

# bun
bun add -g @pleaseai/lint

用法

初始化（交互式）

pleaseai-lint init

交互式地选择要为哪些AI助手生成规则。

生成规则

pleaseai-lint generate

为所有配置的AI助手生成规则。

预览规则

pleaseai-lint preview

在不写入文件的情况下预览生成的规则。

检查配置

pleaseai-lint check

检查ESLint配置状态，查看哪些规则处于活动状态。

运作原理

1. 解析 ESLint配置（支持平面配置和传统配置 .eslintrc)
2. 地图 ESLint规则按类别组织为人类可读的指南：

- 类型安全性和明确性 - 代码质量 - React和JSX - 安全 - 演出 - 代码风格 - 进出口 - 测试

1. 产生 每个工具的适当格式的AI特定指令文件

示例输出

对于使用TypeScript ESLint规则的项目，您可能会看到以下指导方针：

### Type Safety & Explicitness

- Avoid using the any type
  - **Do**: Use specific types, unknown, or generics instead of any
  - **Don't**: Use any to bypass type checking
- Use strict equality operators (=== and !==)
  - **Do**: Always use === and !== for comparisons
  - **Don't**: Use == or != which perform type coercion

需求

• Node.js 18+
• 项目中的ESLint配置

贡献

设置

bun install

Git挂钩（用于GUI应用程序）

如果你正在使用GUI应用程序（VS Code、WebStorm等），并遇到 bun: not found 提交、创建时出错 ~/.config/husky/init.sh:

mkdir -p ~/.config/husky
echo 'export PATH="$HOME/.bun/bin:$PATH"' > ~/.config/husky/init.sh

这确保了bun在GUI环境中可用于Git钩子。

许可证

麻省理工学院