https://github.com/tzhangchi/z-pot
project overview tool, used to analyze the amount of code, the number of files, code statistics and so on.
https://github.com/tzhangchi/z-pot
board cli code-review command dashboard nodejs overview project-management statics tool
Last synced: 3 months ago
JSON representation
project overview tool, used to analyze the amount of code, the number of files, code statistics and so on.
- Host: GitHub
- URL: https://github.com/tzhangchi/z-pot
- Owner: tzhangchi
- License: mit
- Created: 2021-04-05T08:03:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T14:32:56.000Z (over 4 years ago)
- Last Synced: 2025-10-28T00:15:30.568Z (7 months ago)
- Topics: board, cli, code-review, command, dashboard, nodejs, overview, project-management, statics, tool
- Language: JavaScript
- Homepage:
- Size: 259 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pot
z-pot is a project overview tool, used to analyze the amount of code, the number of files, code statistics and so on.
## Quick Start
install `z-pot`
```shell
npm i -g z-pot
```
create report
```shell
cd ${yourProject}
pot report
```
## Features
- [x] file stats
- [x] custom
- [x] unit test
- [] stat group by file type
- [] stat group by file line count
- [] stat tech stack of project
- [] stat of project contributor
## Help
```shell
Usage: pot [options]
project overview tool
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
report [options] print project info
Examples:
$ pot report ## build report
$ pot report -t xxx ## custom report template
```
### Custom Template
Template Context
```
this.statInfo = {
createdTime: moment(new Date()).format('YYYY-MM-DD'),
fileSize: 0, // project file size
filesCount: 0, //files count
dirsCount: 0, //dir count
fileLineCount: 0, //the count of all files
maxFileLine: 0, // single file max line count
bigFilesList: [] //big files list
}
```
Custom Template `report.template.html`
```html
Document
${this.statInfo.createdTime}
```
```shell
pot report -t ./tests/report.template.html ## custom template
ls pot_report_2021-04-05.html ## report
```
# License
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2013-present, zhangchi