configcat/feature-flag-reference-validator

功能标志引用验证器CLI [已归档]此仓库已归档。在https://github.com/configcat/cli发布后，该项目已过时。

镜像概述和主要用途

本CLI工具可发现源代码中ConfigCat功能标志的使用情况，并根据ConfigCat仪表板上的功能标志进行验证。通过扫描代码中的标志引用，确保其与配置平台上的标志定义一致，帮助开发团队避免使用未定义或已废弃的功能标志。

关于ConfigCat

使用ConfigCat功能标志管理功能并更改软件配置，无需重新部署代码。10分钟即可上手的仪表板让非技术团队成员也能直接管理功能。随时部署，自信发布。可针对特定用户组先行测试新想法，支持A/B/n测试和软发布。提供https://github.com/configcat，便于与任何Web、移动或后端应用集成。

核心功能和特性

• 扫描源代码目录，识别ConfigCat功能标志引用
• 与ConfigCat仪表板上的标志定义进行比对验证
• 支持自定义CDN服务器配置
• 可配置警告是否触发错误退出
• 提供详细日志输出

使用场景和适用范围

• 开发阶段：验证代码中使用的功能标志是否在ConfigCat平台上存在
• CI/CD流程：集成到持续集成流程中，确保代码提交前标志引用有效
• 代码审计：检查项目中是否存在未使用或无效的功能标志引用

使用方法和配置说明

Docker安装与使用

拉取镜像

powershell
docker pull docker.xuanyuan.run/configcat/feature-flag-reference-validator

运行容器

镜像的入口点为configcat-validator.py，直接通过容器传递参数即可执行验证：

bash
docker run docker.xuanyuan.run/configcat/feature-flag-reference-validator [YOUR-CONFIGCAT-SDKKEY] [DIRECTORY-TO-SCAN]

参数说明

使用示例

以下命令将对./repo文件夹执行标志引用验证，发现标志键不匹配时触发失败：

bash
docker run docker.xuanyuan.run/configcat/feature-flag-reference-validator \
    [YOUR-CONFIGCAT-SDKKEY] \
    ./repo \
    --fail_on_warnings \
    --verbose

输出示例

bash
INFO:configcat.reference_validator.config_fetcher:Fetching the current ConfigCat configuration from cdn.configcat.com.
INFO:configcat.reference_validator.config_fetcher:Successful fetch, 2 settings found: ['key1', 'key2'].
INFO:configcat.reference_validator.reference_finder:Scanning the ./repo directory for ConfigCat setting references.
INFO:configcat.reference_validator.reference_finder:6 references found: {'key1', 'key2', 'key3'}.
WARNING:configcat.reference_validator.reference_validator:Feature flag/Setting keys not found in ConfigCat (but present in source code): {'key3'}.
Exited with code 1

CI集成

• https://circleci.com/orbs/registry/orb/configcat/feature-flag-reference-validator
• https://github.com/marketplace/actions/configcat-feature-flag-cleanup

关于ConfigCat

• 官网
• 文档
• 博客