ARTICLE · INTELLIGENCE

战地情报 · 详情页

来自尧图项目组的一线实战观察与深度解析

如何关闭 Swagger UI npm 包安装时的 Scarf 匿名统计?

如何关闭 Swagger UI npm 包安装时的 Scarf 匿名统计? 如何关闭 Swagger UI npm 包安装时的 Scarf 匿名统计【免费下载链接】swagger-uiSwagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.项目地址: https://gitcode.com/GitHub_Trending/sw/swagger-ui安装swagger-ui、swagger-ui-react或swagger-ui-dist这几个 npm 包时安装过程会通过 Scarf 上报匿名安装统计。项目文档README.md、flavors/swagger-ui-react/README.md、swagger-ui-dist-package/README.md在 Anonymized analytics 一节中说明这些统计用于支持库的维护者并且只在安装阶段运行ONLY run during installation不会影响 Swagger UI 运行时的行为。如果你希望安装这些包时不发送这类数据文档给出了两种关闭方式下面分别说明。确认哪些包会触发安装统计项目文档明确使用 Scarf 的包有三个对应三份文档的说明swagger-ui见根目录 README.md仓库的 package.json 依赖中声明了scarf/scarf: 1.4.0swagger-ui-react见 flavors/swagger-ui-react/README.mdswagger-ui-dist见 swagger-ui-dist-package/README.md其 package.json 依赖中同样声明了scarf/scarf: 1.4.0。只要你的项目会安装其中任意一个包下面的关闭方式就适用。方式一在项目 package.json 中设置 scarfSettings文档推荐的方式是把你自己项目的package.json不是 swagger-ui 仓库的 package.json中的scarfSettings.enabled字段设为false。文档给出的配置示例如下// package.json { // ... scarfSettings: { enabled: false } // ... }即在你的package.json顶层加入scarfSettings字段{ scarfSettings: { enabled: false } }这种配置写进项目文件后长期生效对在该项目中执行的后续npm install都适用。方式二通过环境变量关闭某次安装文档给出的替代方式是在安装 npm 包的环境中设置环境变量SCARF_ANALYTICS为false文档示例命令为SCARF_ANALYTICSfalse npm install这种方式只对当前这次带环境变量的安装命令生效适合 CI 任务、一次性安装或临时排查的场景不需要改动项目文件。关闭后的影响范围与验证文档对这项统计的边界说明是它ONLY run during installation也就是只发生在安装阶段。因此关闭它影响的只是安装时的上报行为与 Swagger UI 加载、渲染 API 文档的运行时功能无关。需要注意的是项目文档只给出了上述两种关闭配置没有提供专门的命令或输出来核验统计是否已停止。你可以对照文档确认两点配置是否已按上面两种方式之一写入scarfSettings.enabled为false或安装命令带有SCARF_ANALYTICSfalse前缀以及npm install命令本身能否正常完成。除命令正常执行外文档没有列出其他可观察的成功判定。参考位置README.md 的 Anonymized analytics 一节swagger-ui主包flavors/swagger-ui-react/README.md 的同名一节swagger-ui-reactswagger-ui-dist-package/README.md 的同名一节swagger-ui-distpackage.json 与 swagger-ui-dist-package/package.json 中scarf/scarf依赖声明用于确认哪些发布包携带该统计组件【免费下载链接】swagger-uiSwagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.项目地址: https://gitcode.com/GitHub_Trending/sw/swagger-ui创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
RELATED READING

延伸阅读

更多一线实战笔记与深度复盘,助您持续精进