Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyhaya/lok
Count the number of codes
https://github.com/wyhaya/lok
codes command-line-tool count count-lines count-lines-of-code
Last synced: 3 months ago
JSON representation
Count the number of codes
- Host: GitHub
- URL: https://github.com/wyhaya/lok
- Owner: wyhaya
- License: mit
- Created: 2019-01-18T03:48:11.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-09-08T00:25:47.000Z (about 1 year ago)
- Last Synced: 2024-03-26T16:04:46.706Z (8 months ago)
- Topics: codes, command-line-tool, count, count-lines, count-lines-of-code
- Language: Rust
- Homepage:
- Size: 23.4 KB
- Stars: 44
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - lok
README
# lok
[](https://github.com/wyhaya/lok/actions)
[](https://crates.io/crates/lok)
[](https://github.com/wyhaya/lok/blob/master/LICENSE)
`lok` is a command line tool, that is used to quickly calculate the number of lines of various language codes in a project
```
╭──────────────────────────────────────────────────────────────────────────────╮
│ Language Code Comment Blank File Size │
├──────────────────────────────────────────────────────────────────────────────┤
│ CSS 6384 9 40 108 145.89 KB │
│ HTML 19 0 0 1 1011 B │
│ JSON 205 0 0 110 13.25 KB │
│ JavaScript 206 8 1 113 590.14 KB │
│ Markdown 8 0 5 1 229 B │
│ TypeScript JSX 14733 262 800 109 530.76 KB │
│ TypeScript 680 57 57 8 22.07 KB │
│ YAML 5 0 0 1 83 B │
├──────────────────────────────────────────────────────────────────────────────┤
│ Total 22,240 336 903 451 1.27 MB │
╰──────────────────────────────────────────────────────────────────────────────╯
```
## Features
* Quickly calculate data
* Support multiple languages
* Support multiple output formats, ASCII, HTML, Markdown
## Install
[Download](https://github.com/wyhaya/lok/releases) the binary from the release page
Or use `cargo` to install
```bash
cargo install lok
```
A native package is available on NetBSD from the official repositories.
To install it, simply run
```bash
pkgin install lok
```
A package on the AUR is also available. To install it simply run with your favorite AUR helper
```bash
paru lok
```
## Use
Go to your project in the terminal and type `lok` on the command line
```bash
cd your-project
lok
# Change working directory
lok /root/code
```
```bash
# Exclude all files matched by glob
lok -e './node_modules/**'
# Exclude all files with the specified extension
lok -e '**/*.ts' '**/*.js'
```
```bash
# Include only files matching glob
lok -i './src/*.rs'
```
```bash
# Only count files containing extensions
lok --extension js ts jsx tsx
```
```bash
# Output other formats: table, html, markdown
lok -o markdown
# Save to file
lok -o html > code.html
lok -o markdown > code.md
```
```bash
# Sort by: language, code, comment, blank, file, size
lok -s code
```
## Contributing
If you want to add statistics for other languages, please update [config.rs](./src/config.rs)
Example:
```rust
language!(
"Rust",
vec!["rs"],
vec!["//", "///"],
vec![("/*", "*/")]
);
// ...
```
## Benchmark
First need to install
```bash
cargo install hyperfine loc tokei
```
Run
```bash
./benchmark
```
## License
[MIT](./LICENSE) LICENSE