cloc - šteje vrstice kode v številnih programskih jezikih


Med delom na različnih projektih boste včasih morali predložiti poročilo ali statistiko svojega napredka ali preprosto izračunati vrednost svoje kode.

Obstaja to preprosto, a zmogljivo orodje, imenovano\"cloc - count line code", ki vam omogoča, da preštejete vso številko svoje kode in hkrati izključite komentarje in prazne vrstice.

Na voljo je v vseh večjih distribucijah Linuxa in podpira več programskih jezikov in razširitev datotek ter nima posebnih zahtev za uporabo.

V tej vadnici se boste naučili, kako namestiti in uporabljati cloc v sistemu Linux.

Kako namestiti in uporabljati Cloc v sistemih Linux

Namestitev cloca je enostavna in enostavna. Spodaj si lahko ogledate, kako namestiti cloc v različne operacijske sisteme z njimi povezanimi upravitelji paketov:

$ 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 lahko uporabite za štetje vrstic v določeni datoteki ali v več datotekah v imeniku. Če želite uporabiti cloc, preprosto vnesite cloc, ki mu sledi datoteka ali imenik, ki ga želite pregledati.

Tukaj je primer iz datoteke v bash. Zadevna datoteka vsebuje naslednjo kodo v bash:

$ cat bash_script.sh

Zdaj pa zaženimo cloc.

$ cloc bash_script.sh

Kot lahko vidite, je štelo število datotek, praznih vrstic, komentarjev in vrstic kode.

Še ena kul lastnost cloca je, da se lahko uporablja celo za stisnjene datoteke. Na primer, prenesel sem najnovejši arhiv WordPress in ga zagnal cloc.

$ cloc latest.tar.gz

Tukaj je rezultat:

Vidite lahko, da prepozna različne vrste kode in loči statistiko za vsak jezik.

Če potrebujete poročilo za več datotek v imeniku, lahko uporabite možnost \"-by-file" , ki bo štela vrstice v vsaki datoteki in za njih zagotovila poročilo. lahko traja nekaj časa za projekte z veliko datotekami in tisoči vrstic kode.

Sintaksa je naslednja:

$ cloc --by-file <directory>

Čeprav je pomoč cloca lahko berljiva in razumljiva, bom vključil nekatere dodatne možnosti, ki jih je mogoče uporabiti s clocom, kar se bo nekaterim uporabnikom zdelo koristno.

  • --diff -izračuna razlike v kodi med izvornimi datotekami set1 in set2. Vnos je lahko kombinacija datotek in imenikov.
  • --git -prisili, da se vhodi prepoznajo kot cilji git, če niso prvi identificirani kot imena datotek ali imenikov.
  • --ignore-presledki -prezre vodoravne presledke pri primerjavi datotek z --diff .
  • --max-file-size= -če želite preskočiti datoteke, večje od danega zneska MB.
  • --exclude-dir=, -izključi dane imenike, ločene z vejicami.
  • --exclude-ext=, -izključite dane razširitve datotek.
  • --csv -izvoz rezultatov v obliko datoteke CSV.
  • --csv-delimiter= -za razmejitev uporabite znak .
  • --out= -shranite rezultate v <file>.
  • --quiet -zatre vsa sporočila z informacijami in prikaže samo končno poročilo.
  • --sql= -rezultate zapišite kot ustvarjanje in vstavljanje stavkov, ki jih lahko prebere program zbirke podatkov, kot je SQLite.

Cloc je majhen uporaben pripomoček, ki ga je vsekakor dobro imeti v svojem arzenalu. Čeprav ga morda ne uporabljate vsak dan, vam lahko pomaga, ko morate ustvariti poročilo ali če vas samo zanima, kako poteka vaš projekt.