/Code-lines-counter

:mag_right: Generate a summary report of written lines of code (Bash)

Primary LanguageShellMIT LicenseMIT

🔎 Code lines counter License Contributions welcome

Generate a summary report of written lines of code (Bash)

code_lines_counter - generate report about written lines of code and comments, with ommiting empty lines, for given directory and all sub-directories

Examples

  • Counting lines
For actual directory

For given specific directory
  • Supported languages

You can add new extension / extensions with corresponding language_name if you need it (MANUAL)

  • Excluded files / directories from counting

Yoou can add extra ignored files / directories if you need it (MANUAL)

Distinguishing features

  • Jupyter Notebook support (correct counting lines of code inside .ipynb files)
  • Automatically excluding all files / localizations from .gitignore files found inside searched directories
  • Possibility of adding / removing additional localizations / files to exclude from counting
  • Possibility of adding / removing any file extensions with associated languages / names
  • Ommiting empty lines
  • Calculating amount of comments lines
  • Fully customizable by using command flags

Manual Page

You can find full manual page (here)
or just type in terminal any of this:

    info code_lines_counter 
    man code_lines_counter 
    code_lines_counter --help 
    code_lines_counter -h

Setup

This tool use (fd-find app) shell app. First of all, you need to make sure that you have installed it. (Original fd-find installation steps) - In most cases it can by done by typing:

    sudo apt install fd-find

After that you are ready to install code_lines_counter:

    git clone https://github.com/Ukasz09/Code-lines-counter.git
    cd Code-lines-counter/
    sudo make install

How to use it?

Go to directory in which you want to count lines of code and simply type:

    code_lines_counter

You can also specify directory by typing:

    code_lines_counter -d path/to/parent/directory/

or

    code_lines_counter --dir path/to/parent/directory/

All others available flags you can find in (manual)


📫 Contact

Created by

gajerski.lukasz@gmail.com - feel free to contact me! ✊