Как использовать команду cloc в Linux

Команда cloc — это инструмент командной строки Линукс, задача которого состоит в подсчете количества строк в разных версиях файлов исходного кода программ (включая строки с комментариями). А также — в измерении объема изменений в исходной и итоговой версиях файла. Это крайне полезно, если Вы работаете над различными проектами в секторе ИТ, потому что иногда Вам может потребоваться предоставить подробный отчет о проделанной работе. С этим Вам поможет данная утилита, которая доступна для установки на большинство современных дистрибутивов Linux, а также — поддерживает множество языков программирования и форматов файлов (в том числе — сжатых архивов).

Из этой короткой статьи Вы узнаете, как установить и использовать инструмент сloc в Linux.

Содержание:

1. Как установить утилиту cloc
2. Как использовать cloc
   1. Посчитайте строки конкретного файла
   2. Посчитайте строки в сжатых файлах
   3. Получите отчет по нескольким файлам в каталоге, используя cloc
3. Выводы

Как установить утилиту cloc

Как было сказано ранее, инструмент доступен для скачивания и установки практически во всех современных популярных дистрибутивах Линукс. Для этого воспользуйтесь пакетными менеджерами, соответствующими Вашему дистрибутиву.

Для Debian, Ubuntu:

sudo apt install cloc

Для Red Hat, CentOS, Fedora:

sudo yum install cloc

Для Fedora 22 и новее:

sudo dnf install cloc

Также Вы можете установить утилиту с помощью npm:

npm install -g cloc

Как использовать cloc

Перед тем как начать работать с cloc — советуем Вам ознакомиться с ее синтаксисом и доступными для использования опциями. Для начала Вам могут пригодиться следующие параметры:

• --exclude-dir — исключит директорию, указанную далее в качестве аргумента, из проверки;
• --exclude-lang — исключит язык программирования, указанный далее в качестве аргумента, из проверки;
• --by-file — сообщит о результатах анализа для каждого встреченного файла исходного кода в директории;
• --list-file — позволит указать список названий файлов или каталогов для обработки;
• --exclude-list-file — проигнорирует указанный файл при анализе содержимого директории.

Чтобы увидеть полный список опций утилиты — введите в командную строку следующую команду:

cloc --help

Или же перейдите на соответствующую справочную страницу с помощью команды man:

man cloc

Посчитайте строки конкретного файла

Главной функцией команды является подсчет количества строк в конкретном файле. Чтобы использовать утилиту для этого — просто введите команду с названием файла в качестве аргумента:

cloc <file-name>

Как Вы можете видеть на скриншоте, команда определила язык программирования, количество файлов, число пустых строк, количество строк комментариев и строк кода.

Посчитайте строки в сжатых файлах

Еще одна задача, с которой справится команда cloc — подсчет строк в сжатых архивах. Допустим, Вы скачали архив в формате *tar.gz и хотите его изучить. Для этого используйте приведенную ниже команду:

cloc <name>.tar.gz

На скриншоте видно, какие языки программирования распознал инструмент и какую привел статистику по ним.

Читайте также: Как извлечь Tar-файлы в каталог в Linux

Получите отчет по нескольким файлам в каталоге, используя cloc

Вы также можете использовать команду для анализа всего содержимого в выбранном каталоге, а не только в отдельных файлах. В таком случае используется параметр --by-file. Эта опция проанализирует файлы в папке и подсчитает строки в каждом из них. После этого — предоставит соответствующий отчет. Время выполнения такой задачи будет зависеть от загруженности каталога.

Для примера попробуем использовать текущую папку, поэтому укажем в качестве аргумента вместо пути точку — .:

cloc --by-file <directory>

Выводы

Команда cloc — это инструмент, который может существенно упростить ИТ-специалисту процесс подготовки отчетов для работодателя, а также — свести к минимуму время, необходимое для выполнения рутинных операций по сбору статистики на проекте.

Спасибо за время, уделенное прочтению статьи!

Если возникли вопросы — задавайте их в комментариях.

Подписывайтесь на обновления нашего блога и оставайтесь в курсе новостей мира инфокоммуникаций!

Чтобы знать больше и выделяться знаниями среди толпы IT-шников, записывайтесь на курсы Cisco, курсы по кибербезопасности, полный курс по кибербезопасности, курсы DevNet / DevOps (программируемые системы) от Академии Cisco, курсы Linux от Linux Professional Institute на платформе SEDICOMM University (Университет СЭДИКОММ).