eslint-formatter-html 更好的展示项目的ESLint报告

1,244 阅读1分钟

简介

一个带有统计信息和符合现代网页设计的 ESLint 报告生成器。

ESLint其实内置了html格式器,但是生成的html文件界面很简陋,交互性很差。本项目着重解决这些问题,旨在提供更贴近开发者的ESLint报告,分析项目的ESLint接入情况!

本项目其实已经迭代了5年,在美团使用过3年,在某壳使用过2年,经历了海量业务的考验。目前想将项目贡献到ESLint社区,欢迎各位大佬去GitHub给个 Star 哇~

效果预览

shuoshubao.github.io/eslint-form…

示例1示例2示例3示例4
示例5示例6示例7示例8

官方示例

安装

npm i D eslint-formatter-html

使用

npx eslint -f html -o ESLintReport.html

有关 ESLint-formatters 的更多信息,请访问 eslint.org/docs/latest…

功能点

  • 页面基于 antd 开发, 交互性很好 (内置的真的很粗糙~)
  • 文件路径是相对路径 (内置的是绝对路径, 很长很长~)
  • 文件路径可以复制
  • 有问题的代码行号和列号可以随路径一起复制, 配合编辑器的 cmd+P 可以快速定位到代码的具体位置
  • 可正常展示 ansi
  • 默认是 antd 的 dark 护眼模式🤩
  • 采用字符串压缩算法 pako, 当检测的文件非常多且问题也巨多时,生成的报告文件能比内置生成的文件小很多

页面效果对比

本项目的效果图

暗黑模式

Eslint Report (1).png

浅色模式

Eslint Report (2).png

ESLint 内置

ESLint Report.png