cloc - Comptar línies de codi en molts llenguatges de programació


Mentre treballeu en diferents projectes, de vegades és possible que se us demani que proporcioneu un informe o estadístiques del vostre progrés, o simplement que calculeu el valor del vostre codi.

Hi ha aquesta eina senzilla però potent anomenada \cloc - comptar línies de codi que us permet comptar tot el nombre del vostre codi i excloure comentaris i línies en blanc alhora.

Està disponible a totes les distribucions principals de Linux i admet diversos llenguatges de programació i extensions de fitxers i no té cap requisit específic per utilitzar-lo.

En aquest tutorial aprendràs a instal·lar i utilitzar cloc al teu sistema Linux.

Com instal·lar i utilitzar Cloc en sistemes Linux

Instal·lar cloc és fàcil i senzill. A continuació podeu veure com instal·lar cloc en diferents sistemes operatius amb els seus gestors de paquets relacionats:

$ 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 es pot utilitzar per comptar línies en un fitxer en particular o en diversos fitxers dins del directori. Per utilitzar cloc, simplement escriviu cloc seguit del fitxer o directori que voleu examinar.

Aquí teniu un exemple d'un fitxer a bash. El fitxer en qüestió conté el codi següent a bash:

$ cat bash_script.sh

Ara anem a executar-hi el cloc.

$ cloc bash_script.sh

Com podeu veure, comptava el nombre d'arxius, línies en blanc, comentaris i línies de codi.

Una altra característica interessant de cloc és que fins i tot es pot utilitzar en fitxers comprimits. Per exemple, he baixat l'últim arxiu de WordPress i he executat cloc.

$ cloc latest.tar.gz

Aquí teniu el resultat:

Podeu veure que reconeix els diferents tipus de codi i separa les estadístiques per idioma.

En cas que necessiteu obtenir un informe per a diversos fitxers en un directori, podeu utilitzar l'opció \--by-file”, que comptarà les línies de cada fitxer i proporcionarà un informe per a ells. pot trigar una estona per a projectes amb molts fitxers i milers de línies de codi.

La sintaxi és la següent:

$ cloc --by-file <directory>

Tot i que l'ajuda de cloc és fàcilment llegible i comprensible, inclouré algunes de les opcions addicionals que es poden utilitzar amb cloc que alguns usuaris poden trobar útils.

  • --diff : calcula les diferències de codi entre els fitxers font de set1 i set2. L'entrada pot ser una barreja de fitxers i directoris.
  • --git: obliga a reconèixer les entrades com a objectius git si no s'identifiquen primer com a noms de fitxers o directoris.
  • --ignore-whitespace: ignora l'espai en blanc horitzontal quan es comparen fitxers amb --diff.
  • --max-file-size=: si voleu saltar fitxers més grans que la quantitat indicada de MB.
  • --exclude-dir=,: exclou els directoris separats per comes.
  • --exclude-ext=,: exclou les extensions de fitxer donades.
  • --csv: exporta els resultats al format de fitxer CSV.
  • --csv-delimiter=: utilitzeu el caràcter com a delimitador.
  • --out=: deseu els resultats a <file>.
  • --quiet: suprimeix tots els missatges d'informació i mostra només l'informe final.
  • --sql=: escriviu els resultats com a sentències de creació i inserció que poden llegir un programa de base de dades com ara SQLite.

Cloc és una petita utilitat útil que definitivament és bo tenir al vostre arsenal. Tot i que pot ser que no s'utilitzi diàriament, us pot ajudar quan hàgiu de generar algun informe o si només teniu curiositat per com va el vostre projecte.