cloc - Počítání řádků kódu v mnoha programovacích jazycích

Při práci na různých projektech můžete být někdy požádáni o poskytnutí zprávy nebo statistiky vašeho postupu nebo jednoduše o výpočet hodnoty vašeho kódu.

Existuje tento jednoduchý, ale výkonný nástroj nazvaný „cloc – count lines of code “, který vám umožní spočítat celý počet vašich kódů a zároveň vyloučit komentáře a prázdné řádky.

Je k dispozici ve všech hlavních distribucích Linuxu a podporuje více programovacích jazyků a přípon souborů a nemá žádné specifické požadavky na použití.

V tomto tutoriálu se naučíte, jak nainstalovat a používat cloc na vašem systému Linux.

Jak nainstalovat a používat Cloc v systémech Linux

Instalace cloc je snadná a jednoduchá. Níže vidíte, jak nainstalovat cloc v různých operačních systémech s jejich souvisejícími správci balíčků:

sudo apt install cloc                  # Debian, Ubuntu
sudo yum install cloc                  # Red Hat, Fedora
sudo dnf install cloc                  # Fedora 22 or later
sudo pacman -S cloc                    # Arch
sudo emerge -av dev-util/cloc          # Gentoo https://packages.gentoo.org/packages/dev-util/cloc
sudo apk add cloc                      # Alpine Linux
sudo pkg install cloc                  # FreeBSD
sudo port install cloc                 # Mac OS X with MacPorts
brew install cloc                      # Mac OS X with Homebrew
npm install -g cloc                    # https://www.npmjs.com/package/cloc

Cloc lze použít k počítání řádků v konkrétním souboru nebo ve více souborech v adresáři. Chcete-li použít cloc, jednoduše napište cloc a za ním soubor nebo adresář, který chcete prozkoumat.

Zde je příklad ze souboru v bash. Dotyčný soubor obsahuje následující kód v bash:

cat bash_script.sh

Nyní na to spustíme cloc.

cloc bash_script.sh

Jak vidíte, počítal počet souborů, prázdných řádků, komentářů a řádků kódu.

Další skvělou funkcí cloc je, že ji lze použít i na komprimované soubory. Například jsem si stáhl nejnovější archiv WordPress a spustil na něm cloc.

cloc latest.tar.gz

Zde je výsledek:

Můžete vidět, že rozpoznává různé typy kódu a odděluje statistiky podle jazyka.

V případě, že potřebujete získat zprávu pro více souborů v adresáři, můžete použít volbu “--by-file ”, která spočítá řádky v každém souboru a poskytne pro ně zprávu. U projektů s mnoha soubory a tisíci řádků kódu to může chvíli trvat.

Syntaxe je následující:

cloc --by-file <directory>

I když je nápověda cloc snadno čitelná a srozumitelná, zahrnu některé další možnosti, které lze s cloc použít, někteří uživatelé mohou považovat za užitečné.

--diff – vypočítá rozdíly v kódu mezi zdrojovými soubory set1 a set2. Vstupem může být kombinace souborů a adresářů.
--git – vynutí rozpoznání vstupů jako cílů git, pokud stejné nejsou nejprve identifikovány jako názvy souborů nebo adresářů.
--ignore-whitespace – ignoruje horizontální mezery při porovnávání souborů s --diff.
--max-file-size= – pokud chcete přeskočit soubory větší než dané množství MB.
--exclude-dir=, – vyloučí dané adresáře oddělené čárkou.
--exclude-ext=, – vyloučí dané přípony souborů.
--csv – export výsledků do formátu souboru CSV.
--csv-delimiter= – jako oddělovač použijte znak .
--out= – uloží výsledky do .
--quiet – potlačí všechny informační zprávy a zobrazí pouze závěrečnou zprávu.
--sql= – výsledky zapište jako příkazy pro vytvoření a vložení, které lze číst databázovým programem, jako je SQLite.

Závěr

Cloc je malá užitečná utilita, kterou je rozhodně dobré mít ve svém arzenálu. I když to nemusí být používáno na denní bázi, může vám pomoci, když musíte vygenerovat nějakou zprávu nebo pokud jste jen zvědaví, jak váš projekt pokračuje.