@ray-js/mp-audit-cli v1.0.13

Miniapp Audit CLI

一个用于小程序代码质量审核的命令行工具 (A command-line tool for miniapp code quality auditing)

功能特性 (Features)

该工具主要用于扫描和审核小程序代码，包含以下功能：

• 🎨 主题变量检查 (Theme Variables Check)

  • 扫描和检查 APP 主题相关变量的使用情况
  • 确保主题样式的一致性

• 🌓 暗黑模式适配检查 (Dark Mode Support Check)

  • 检查小程序是否正确支持暗黑模式
  • 识别可能在暗黑模式下显示异常的样式

• 🌐 多语言使用检查 (Multi-language Usage Check)

  • 扫描代码中的中文字符
  • 帮助识别需要国际化的文本

• 📦 图片资源检查 (Package Image Check)

  • 检测包内的图片资源
  • 分析图片使用情况

• 📊 质量评分 (Quality Score)

  • 根据多个维度计算代码质量评分
  • 生成详细的审核报告

使用方法 (Usage)

# 安装依赖
npm install

# 运行审核
npm run audit <project-path>

配置项 (Configuration)

工具支持以下配置：

• excludeDirs: 排除的目录，默认包含 ["node_modules", "dist", ".git", "typings", "scripts"]
• imageExtensions: 支持的图片格式，默认包含 [".png", ".jpg", ".jpeg", ".gif", ".webp"]

输出报告 (Output Report)

工具会生成包含以下内容的审核报告：

• 总体评分
• 各项指标的详细得分
• 具体问题的位置和建议

贡献指南 (Contributing)

欢迎提交 Issue 和 Pull Request！

开源协议 (License)

MIT License