AILint

该项目的主要功能是分析一个软件项目的代码，找出可能存在的BUG并提出合理的改进建议。项目会读取软件的目录结构及文件内容，通过调用AI服务进行分析，并将结果输出到一个指定的文件中。

功能简介

1. 读取项目目录，过滤不必要的文件和文件夹。
2. 根据项目目录结构和文件内容，生成分析请求的输入。
3. 调用AI服务分析代码，找出BUG并提出改进建议。
4. 将分析结果输出到指定文件。

使用方法

环境准备

在使用该工具前，请确保已安装Node.js环境，并设置环境变量 AILINT_TOKEN，该变量用于存储AI服务的访问令牌。

安装依赖

npm install -g ailint

通过CLI传入参数

ailint -d <项目目录> -e <引擎> -t <令牌> -o <输出路径>

• -d：指定项目目录路径，默认为当前工作目录。
• -e：指定AI引擎，默认为 gpt-4o。
• -t：指定AI服务的访问令牌。
• -o：指定结果输出路径，默认为项目目录下的 ailint_result.txt。

使用配置文件

在项目根目录下创建 ailint.config.json 配置文件，内容格式如下：

{
    "directory": "<项目目录>",
    "engine": "<引擎>",
    "ignoreFolders": ["<忽略的文件夹或文件>"]
}

• directory：指定项目目录路径。
• engine：指定AI引擎。
• ignoreFolders：指定需要忽略的文件或文件夹。

参数优先级

CLI传入参数的优先级高于配置文件中的参数，例如同时指定了CLI参数和配置文件参数，则以CLI参数为准。

示例

先设置环境变量AILINT_TOKEN

export AILINT_TOKEN=your_secret_token

ailint -d ./my_project -e gpt-4o -t your_secret_token -o ./results

或使用配置文件 ailint.config.json：

{
    "directory": "./my_project",
    "engine": "gpt-4o",
    "ignoreFolders": ["node_modules", ".git"]
}

或使用配置文件 ailint.config.js：

module.exports = {
    directory: '/your/default/directory',
    engine: 'gpt-4o',
    // system: '',
    ignoreFolders: [/node_modules/, '__pycache__', 'build', /^\..*/, 'package-lock.json']
}

然后直接运行：

ailint

注意事项

1. 请确保环境变量 AILINT_TOKEN 已正确设置。
2. 忽略文件和文件夹的配置支持字符串和正则表达式。
3. 支持的文件类型包括 .js、.jsx 和 .py。

问题反馈

如果在使用过程中遇到任何问题，请通过项目的Issue进行反馈。