growthbook/gb-find-code-refs

功能标志使用检测工具镜像

镜像概述

本镜像提供一个实用工具，用于扫描源代码仓库并检测功能标志（Feature Flags）在代码中的使用位置。该工具旨在帮助开发团队跟踪、管理和优化代码中的功能标志，提升代码质量和维护效率。

核心功能与特性

• 源代码仓库扫描：支持对各类源代码仓库进行全面扫描
• 功能标志检测：精准识别代码中功能标志的使用位置和调用方式
• 轻量级设计：工具体积小，扫描效率高，对系统资源占用低
• 跨平台兼容：可在任何支持Docker的环境中运行，无需额外依赖配置

使用场景

• 开发团队在功能标志管理过程中，跟踪标志在代码中的分布情况
• 代码审计时，识别未使用或冗余的功能标志，减少代码复杂度
• 系统重构前，评估功能标志的影响范围，降低重构风险
• 持续集成/持续部署（CI/CD）流程中，自动检测功能标志使用合规性

使用方法与配置说明

基本使用（docker run）

bash
docker run --rm -v /path/to/your/source/code:/app/src feature-flag-scanner:latest scan /app/src

参数说明：

• -v /path/to/your/source/code:/app/src：将本地源代码目录挂载到容器内的/app/src路径
• scan /app/src：执行扫描命令，指定扫描路径为容器内的/app/src

输出说明

扫描完成后，工具将在控制台输出功能标志的检测结果，包括：

• 功能标志名称
• 所在文件路径
• 具体代码行号
• 使用上下文描述

高级配置

可通过环境变量自定义扫描行为：

• LOG_LEVEL：日志级别，可选值：info（默认）、debug、warn、error
• INCLUDE_FILES：指定需要包含的文件类型，如*.js,*.ts
• EXCLUDE_DIRS：指定需要排除的目录，如node_modules,dist

示例：

bash
docker run --rm -e LOG_LEVEL=debug -e EXCLUDE_DIRS=node_modules -v /path/to/code:/app/src feature-flag-scanner:latest scan /app/src