0.0.31 • Published 2 years ago

z-pot v0.0.31

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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

npm i -g z-pot

create report

cd ${yourProject}

pot report

pot-report

Features

  • file stats
  • custom
  • unit test
  • [] stat group by file type
  • [] stat group by file line count
  • [] stat tech stack of project
  • [] stat of project contributor

Help

Usage: pot <command> [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

<!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 ## custom template

ls pot_report_2021-04-05.html ## report

License

MIT

Copyright (c) 2013-present, zhangchi

0.0.30

2 years ago

0.0.31

2 years ago

0.0.28

2 years ago

0.0.29

2 years ago

0.0.20

3 years ago

0.0.18

3 years ago

0.0.17

3 years ago

0.0.16

3 years ago

0.0.15

3 years ago

0.0.14

3 years ago

0.0.13

3 years ago

0.0.12

3 years ago

0.0.11

3 years ago

0.0.10

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago