@meituan-nocode/nocode-linter

项目简介

@meituan-nocode/nocode-linter 是一个基于 ESLint 的命令行代码检查工具，支持 TypeScript 和 JavaScript 项目。它可自动扫描指定目录下的代码，输出 Markdown 格式的规范性报告，帮助开发者快速定位和修复常见的代码问题。

安装方法

在项目根目录下执行：

npm install @meituan-nocode/nocode-linter --save-dev

或全局安装：

npm install -g @meituan-nocode/nocode-linter

使用说明

命令行用法

在项目根目录下运行：

npx nocode-lint [options]

或全局安装后直接运行：

nocode-lint [options]

可用参数

• -s, --source <source> 要检查的目录，默认为当前工作目录
• -o, --output <output> 报告输出路径，默认为 eslint-report.md

示例

检查当前目录并生成报告：

npx nocode-lint

指定检查目录和报告输出路径：

npx nocode-lint -s ./src -o ./my-report.md

报告格式示例

生成的 Markdown 报告示例：

# ESLint 规则报告

| 规则 | 文件 | 行号:列号 |
|---|---|---|
| `no-unused-vars` | src/index.ts | 10:5 |
| `@typescript-eslint/no-explicit-any` | src/app.ts | 20:15 |

配置说明

本工具内置推荐的 ESLint 规则，支持 TypeScript 和 JavaScript 文件。你可以根据需要修改 eslint.config.js 以自定义规则。

开发与构建

1. 安装依赖：

   npm install

2. 构建项目：

   npm run build

3. 开发模式（监听文件变更）：

   npm run dev

依赖环境

• Node.js >= 14.0.0
• TypeScript >= 5.8.3
• ESLint >= 9.4.0

许可证

MIT