芙芙工具箱开发工具说明

适用于芙芙工具箱独立开发工具包

你可以通过下载单独的开发工具包获取。

本文档的路径针对独立开发工具包编辑。

总调用

你可以在主程序直接启动总调用程序对代码进行检查，也可以使用指令调用指定工具。

在主程序的开发工具分类你应该会看到 4 个按钮，以下是各个按钮的解释:

名称	解释
总调用	应用所有检查
复制目录	将开发工具所在目录复制到剪贴板上以方便`cd`
配置文件	打开开发工具的总配置文件(`config.ini`)
文档	打开本页面

你虽然可以直接在主程序中调用一些功能，但我并不建议这样做。

最好的调用方法应该是使用命令调用。

命令调用

以下为示例命令，在执行前请先cd到开发工具目录，然后再cd到对应分类。

使用python 工具名.py --help获取每个工具的详细指令帮助！

分类	校验内容	命令
代码校对	尾随空格	`usage: 尾随空格.py [-h] [--file_extensions FILE_EXTENSIONS] --dir DIRECTORY 检查指定目录下的文件是否存在尾随空格 options: -h, --help show this help message and exit --file_extensions FILE_EXTENSIONS 要检查的文件扩展名列表，以 , 分隔 --dir DIRECTORY 要检查的目录路径`
代码校对	非UTF-8编码	`usage: 非UTF-8编码.py [-h] [--file_extensions FILE_EXTENSIONS] --dir DIRECTORY 检查指定目录下的文件是否存在非UTF-8编码的文件 options: -h, --help show this help message and exit --file_extensions FILE_EXTENSIONS 要检查的文件扩展名列表，以 , 分隔 --dir DIRECTORY 要检查的目录路径`
代码校对	参数查重	`usage: 参数查重.py [-h] [--show-duplicates] [--remove-duplicates] [--copy-to-clipboard] input 参数查重工具 positional arguments: input 输入以逗号分隔的字符串 options: -h, --help show this help message and exit --show-duplicates 查找并显示重复内容 --remove-duplicates 查找并移除重复内容（保留一个） --copy-to-clipboard 将结果复制到剪贴板（必须与--remove_duplicates同时使用）`
代码校对	末尾空行	`usage: 末尾空行.py [-h] --dir DIRECTORY 检查文件末尾是否为空行 options: -h, --help show this help message and exit --dir DIRECTORY 要检查的目录路径`
生成工具	需求生成	`usage: 需求生成.py [-h] --dir DIR [--output OUTPUT] [--env ENV] 根据目录中的Python文件生成requirements.txt文件。 options: -h, --help show this help message and exit --dir DIR 包含Python文件的目录路径。 --output OUTPUT requirements.txt文件的输出路径（完整路径）。 --env ENV 指定已有环境中的Python解释器，仅列出环境中还未安装的库。`
统计	代码总行数	usage: 代码总行数.py [-h] --dir DIR_PATH [--ignore-folders IGNORE_FOLDERS] [--ignore-files IGNORE_FILES] [--formats FILE_FORMATS] [--ignore-empty-lines] [--ignore-comments] [--show-ignored-lines] [--show-test-info] [--code-file-formats] 计算指定目录中的总代码行数 options: -h, --help show this help message and exit --dir DIR_PATH 要扫描的目录 --ignore-folders IGNORE_FOLDERS 要忽略的文件夹（逗号分隔） --ignore-files IGNORE_FILES 要忽略的文件（逗号分隔） --formats FILE_FORMATS 要包含的文件格式（逗号分隔） --ignore-empty-lines 在统计时忽略空行 --ignore-comments 在统计时忽略注释行 --show-ignored-lines 显示总共忽略的空行和注释行数 --show-test-info 显示测试信息（非必要不要使用） --code-file-formats 仅统计代码文件
git	账号切换	`usage: 账号切换.py [--fast] USERNAME`

在终端中调用

与前面的方式的区别是这里直接在终端通过ffdev 工具参数调用。

在第一次配置时，请先进行以下操作:

找到芙芙工具箱安装目录
找到Tools\开发工具\Script目录
将该目录添加到环境变量PATH中，类似步骤请查看[Q：我该如何添加python到系统PATH环境变量] (我相信你能通过这个类似的文档看懂)
尝试在终端中使用ffdev命令，如果提示命令不存在则请重启你的设备。

如果你已正常配置，你应该可以看到类似如下的输出:

                    
PS D:\root> ffdev
WARNING: 无效的程序调用
可用程序: [目录复制] [参数查重] [非UTF-8编码] [尾随空格] [需求生成] [代码行数]

最后，使用ffdev <工具> [参数]即可执行工具，具体参数请见上方。

ini配置文件说明

详见配置文件中的注释。

~~什么？你说你把注释删掉了？请~~[点我下载默认配置文件(20240527)]

json配置文件说明

Examples:

git/账户切换/accounts.json

                            
{
    "用户1": {
        "name": "用户名1",
        "email": "邮箱1@example.com",
        "aliases": ["用户1别名1", "用户1别名2"]
    },
    "用户2": {
        "name": "用户名2",
        "email": "邮箱2@example.com",
        "aliases": ["用户2别名1", "用户2别名2"]
    }
}

[!WARNING]
请勿在json文件中添加注释！

芙芙工具箱 开发工具 说明