pot
z-pot is a project overview tool, used to analyze the amount of code, the number of files, code statistics and so on.
项目概述工具，用于分析代码量、文件数、代码统计等。
快速开始
安装 z-pot
npm i -g z-pot
创建报告
cd ${yourProject}
pot report
Features
- 文件统计
- 自定义模板
- 单元测试
- [] 文件类型分布
- [] 代码行数按区间分布
- [] 分析项目技术栈
- [] 分析项目git参与者
使用指南
Usage: pot <command> [options]
project overview tool
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
report [options] 获取项目概要信息
Examples:
$ pot report ## 获取项目概要信息
$ pot report -t xxx ## 自定义模板，输出报告
自定义模板
模板上下文 Context
this.statInfo = {
createdTime: moment(new Date()).format('YYYY-MM-DD'),
fileSize: 0, //文件物理大小
filesCount: 0, //文件数量统计
dirsCount: 0, //目录数量统计
fileLineCount: 0, //全部文件行数统计
maxFileLine: 0, //单个文件最大的行数
bigFilesList: [] //大文件列表
}
自定义模板内容 report.template.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
${this.statInfo.createdTime}
</body>
</html>
pot report -t ./tests/report.template.html ## 指定模板
ls pot_report_2021-04-05.html ## 产物
License
Copyright (c) 2013-present, zhangchi
853 Nov 21, 2022
5 Dec 1, 2022
225 Dec 31, 2022
20 Sep 13, 2022
7k Dec 31, 2022
8 Mar 26, 2022
67 Jan 2, 2023
27.3k Jan 4, 2023
10 Dec 3, 2022
30 Dec 5, 2022