Recherche de site Web

cloc - Compter les lignes de code dans de nombreux langages de programmation

Lorsque vous travaillez sur différents projets, vous devrez parfois fournir un rapport ou des statistiques sur vos progrès, ou simplement calculer la valeur de votre code.

Il existe cet outil simple mais puissant appelé « cloc – compter les lignes de code » qui vous permet de compter tous les numéros de votre code et d'exclure les commentaires et les lignes vides en même temps.

Il est disponible dans toutes les principales distributions Linux et prend en charge plusieurs langages de programmation et extensions de fichiers et n'a aucune exigence spécifique pour son utilisation.

Dans ce didacticiel, vous allez apprendre à installer et utiliser cloc sur votre système Linux.

Comment installer et utiliser Cloc sur les systèmes Linux

L'installation de cloc est facile et simple. Ci-dessous, vous pouvez voir comment installer cloc dans différents systèmes d'exploitation avec leurs gestionnaires de packages associés :

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 peut être utilisé pour compter les lignes dans un fichier particulier ou dans plusieurs fichiers d'un répertoire. Pour utiliser cloc tapez simplement cloc suivi du fichier ou du répertoire que vous souhaitez examiner.

Voici un exemple tiré d'un fichier en bash. Le fichier en question contient le code suivant en bash :

cat bash_script.sh

Maintenant, exécutons Cloc dessus.

cloc bash_script.sh

Comme vous pouvez le voir, il comptait le nombre de fichiers, les lignes vides, les commentaires et les lignes de code.

Une autre fonctionnalité intéressante de cloc est qu'elle peut même être utilisée sur des fichiers compressés. Par exemple, j'ai téléchargé la dernière archive WordPress et j'ai exécuté cloc dessus.

cloc latest.tar.gz

Voici le résultat :

Vous pouvez voir qu'il reconnaît les différents types de code et sépare les statistiques par langue.

Si vous avez besoin d'obtenir un rapport pour plusieurs fichiers dans un répertoire, vous pouvez utiliser l'option « --by-file », qui comptera les lignes de chaque fichier et fournira un rapport pour celles-ci. Cela peut prendre un certain temps pour les projets comportant de nombreux fichiers et des milliers de lignes de code.

La syntaxe est la suivante :

cloc --by-file <directory>

Bien que l'aide de cloc soit facilement lisible et compréhensible, j'inclurai certaines des options supplémentaires qui peuvent être utilisées avec cloc que certains utilisateurs pourraient trouver utiles.

  • --diff – calcule les différences de code entre les fichiers sources de set1 et set2. L'entrée peut être un mélange de fichiers et de répertoires.
  • --git – force les entrées à être reconnues comme cibles git si celles-ci ne sont pas d'abord identifiées comme noms de fichiers ou de répertoires.
  • --ignore-whitespace – ignore les espaces horizontaux lors de la comparaison de fichiers avec --diff.
  • --max-file-size= – si vous souhaitez ignorer les fichiers dont la taille dépasse la quantité de Mo indiquée.
  • --exclude-dir=, – exclut les répertoires donnés séparés par des virgules.
  • --exclude-ext=, – exclut les extensions de fichier données.
  • --csv – exporter les résultats au format de fichier CSV.
  • --csv-delimiter= – utilisez le caractère comme délimiteur.
  • --out= – enregistrez les résultats dans <file>.
  • --quiet – supprime tous les messages d'information et affiche uniquement le rapport final.
  • --sql= – écrivez les résultats sous forme d'instructions de création et d'insertion qui peuvent être lues par un programme de base de données tel que SQLite.
Conclusion

Cloc est un petit utilitaire utile qu'il est certainement bon d'avoir dans votre arsenal. Bien qu'il ne soit pas utilisé quotidiennement, il peut vous aider lorsque vous devez générer un rapport ou si vous êtes simplement curieux de savoir comment se déroule votre projet.