Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kmilkevych/linecount

A tool to count lines of code in your projects and display the information in a fancy way
https://github.com/kmilkevych/linecount

crystal lines-of-code project-management statistics

Last synced: 12 days ago
JSON representation

A tool to count lines of code in your projects and display the information in a fancy way

Awesome Lists containing this project

README

        

# linecount

A tool to summarize the type and amount of code written inside directories and files.

## Installation

Build `linecount` using:
``` sh
crystal build src/linecount.cr
```
then run using:
``` sh
./linecount [flags] [files/directories]
```

## Usage

The tool can be executed as is, e.g. by running `./linecount` which will summarize the current directory with recursive descent.

Files can be specified by passing their names as arguments to the call:
``` sh
./linecount testfile.txt testdir1 testdir2
```

To specify a maximum recursion depth use the `-d` or `--depth` flag:
``` sh
./linecount --depth 2 testdir
```
Using `--depth 0` disables recursion and only examines the files in top-level.

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Kostiantyn Milkevych](https://github.com/KMilkevych) - creator and maintainer
- [Peter Pisarczyk](https://github.com/ppisarczyk) - gist containing information on file formats and programming languages