Skip to content

Latest commit

 

History

History
93 lines (80 loc) · 5.84 KB

README.md

File metadata and controls

93 lines (80 loc) · 5.84 KB
Raw

lnstat

Utility for counting lines of source code, number of comment lines, and blank lines.

Usage

usage: lnstat <path> [options]
       lnstat [options] <path>

options:
  -iu, --include-unsupported  Include file count for unsupported file types
  -id, --include-dotfiles     Include hidden directories
  -e,  --exclude=<regex>      Skip paths matching given regex
  -f,  --filter=<regex>       Skip paths not matching given regex
  -h,  --help                 Show this dialog

examples:
    lnstat ./node_modules -f=".*\.ts"
    lnstat --exclude=.*\.css -ia ./
    lnstat index.js

Sample Output

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Language         ⎪ Files ⎪ Lines       ⎪ Code         ⎪ Comments   ⎪ Blanks   ⎪ Avg/Max Len ⎪
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 ./               ⎪   244 ⎪      480298 ⎪ 85%   409087 ⎪ 14%  64961 ⎪ 1%  6250 ⎪ 1906  30906 ⎪
 ├─ JavaScript    ⎪     9 ⎪ 68%  328196 ⎪ 100%  327632 ⎪ 0%     167 ⎪ 0%   397 ⎪ 382   22365 ⎪
 ├─ TypeScript    ⎪   196 ⎪ 26%  125475 ⎪ 44%    54961 ⎪ 52%  64787 ⎪ 5%  5727 ⎪ 7884  30906 ⎪
 ├─ JSON          ⎪    25 ⎪ 5%    26057 ⎪ 100%   26045 ⎪ 0%       0 ⎪ 0%    12 ⎪ 2099   5530 ⎪
 ├─ Markdown      ⎪    11 ⎪ 0%      281 ⎪ 83%      232 ⎪ 1%       2 ⎪ 17%   47 ⎪ 678    4488 ⎪
 ├─ Plain Text    ⎪     2 ⎪ 0%      250 ⎪ 76%      189 ⎪ 0%       0 ⎪ 24%   61 ⎪ 357   15193 ⎪
 └─ Zig           ⎪     1 ⎪ 0%       39 ⎪ 72%       28 ⎪ 13%      5 ⎪ 15%    6 ⎪ 35       82 ⎪
──────────────────┴───────┴─────────────┴──────────────┴────────────┴──────────┴─────────────┘
 .../node_modules ⎪   238 ⎪      479097 ⎪ 85%   407978 ⎪ 14%  64945 ⎪ 1%  6174 ⎪ 2250  30767 ⎪
 ├─ JavaScript    ⎪     9 ⎪ 69%  328196 ⎪ 100%  327632 ⎪ 0%     167 ⎪ 0%   397 ⎪ 382   22365 ⎪
 ├─ TypeScript    ⎪   195 ⎪ 26%  124880 ⎪ 44%    54431 ⎪ 52%  64776 ⎪ 5%  5673 ⎪ 7849  30767 ⎪
 ├─ JSON          ⎪    22 ⎪ 5%    25562 ⎪ 100%   25556 ⎪ 0%       0 ⎪ 0%     6 ⎪ 2035   5339 ⎪
 ├─ Plain Text    ⎪     2 ⎪ 0%      250 ⎪ 76%      189 ⎪ 0%       0 ⎪ 24%   61 ⎪ 357   15193 ⎪
 └─ Markdown      ⎪    10 ⎪ 0%      209 ⎪ 81%      170 ⎪ 1%       2 ⎪ 18%   37 ⎪ 626    4373 ⎪
──────────────────┴───────┴─────────────┴──────────────┴────────────┴──────────┴─────────────┘

Understanding the Percents

The percentages in the Code, Comments, and Blanks columns are the percents out of the total lines per type of file. The percentages in the Lines column are the percents out of the total lines per directory.

Dart Version (primary version)

Use dart run ./src-dart/lnstat.dart to run without compiling. This requires Dart being installed.
To compile and build for production use:

make dart
make deb-dart

The compiled binary will be in /dist/dart and the deb package in /dist.

TypeScript Version (deprecated)

Use bun run src-ts/lnstat.ts to run without compiling. This requires Bun being installed.
To compile and build for production node (v16 or greater) and zig (v0.13.0 or greater) must be installed. To compile Node dependent version:

make ts
make deb-ts-node

To compile standalone version:

npm install -g pkg
npm install -g npx
npm install -g esbuild
make ts
make deb-ts-standalone

The compiled binary will be in /dist/node or /dist/standalone respectively and the deb package in /dist.

Shermes Version (broken)

To compile the shermes version of lnstat you will need to build Static Hermes from source (How to try Static Hermes) Then run make shermes and the output will be in /dist/shermes

Deb Package

The Node dependent version is a mere 35kB however it requires that the user have Node installed on their system. The TS standalone version is 42.7 MB but can run on systems that do not have Node installed. The shermes version would theoretically be small and fast, but shermes is not mature enough as a software to run without seg faulting. Therefore I made the Dart version which is 5.9MB which is far smaller than the standalone TS version while only being slightly slower.

Install

For the convenience of Debian based Linux users I have provided the compiled deb package in this repo.

Debian based Linux: Download and double click the deb package in dist and press the "Install Package" button.
Other Linux: Compile from source and add the executable to your PATH.
Windows: Download the repo and required softwares, compile the project, and add the executable to your PATH and hope it works because I have not tested it.
Mac: I have never and will never own a Mac so I don't officially support it, but since Mac OS is Unix based it should be trivial to compile for Mac following the "Other Linux" instructions.

Uninstall

Debian based Linux distros: Run sudo apt remove lnstat.
Other: Remove the executable from your path and delete the compiled program.