AGILE TEAM
Skip to content

日志输出规范(05)

平台规范第 05 条 · 强制度:🔴 必遵。

来源

@agile-team/wl-skills-kit · standards/05-logging.md

📝 作者
朱祥
朱祥·025877
研究院
杨晨誉
杨晨誉·409322
共享技术中心
仲于
仲于·026397
信息化中心
胥庆玉
胥庆玉·026117
信息化中心
马佳瑞
马佳瑞·409338
信息化中心

开发期

  • 允许 console.log 调试,ESLint 仅给 warn 提示
  • AI 生成的代码不要包含调试用 console.log

提交期

  • husky pre-commit 钩子自动触发 lint 检查
  • 必须清理 console.log / console.warn / console.debug 才能提交

生产代码

  • ❌ 禁止出现 console.logconsole.warnconsole.error
  • ❌ 大量 console 输出会带来性能问题(参考 jhat.tech 规范)

替代方案

场景替代方式
错误监控走全局错误处理器(接入 Sentry 或自研上报通道)
调试信息仅在开发环境通过 import.meta.env.DEV 守卫
用户提示使用 ElMessage / jh-message
typescript
// ✅ 允许:开发期守卫
if (import.meta.env.DEV) {
  console.log("[debug] payload:", payload);
}

// ❌ 禁止:生产代码无守卫的 console
console.log("user info:", user);

You may not distribute, modify, or sell this software without permission.