cloc - Telja kóðalínur á mörgum forritunarmálum


Þegar þú vinnur að mismunandi verkefnum gætirðu þurft að leggja fram skýrslu eða tölfræði um framfarir þínar, eða einfaldlega að reikna út gildi kóðans þíns.

Það er til þetta einfalda en öfluga tól sem kallast „cloc – teldu línur af kóða“ sem gerir þér kleift að telja allan kóðann þinn og útiloka athugasemdir og auðar línur á sama tíma.

Það er fáanlegt í öllum helstu Linux dreifingum og styður mörg forritunarmál og skráarviðbætur og hefur engar sérstakar kröfur til að nota.

Í þessari kennslu ertu að fara að læra hvernig á að setja upp og nota cloc á Linux kerfinu þínu.

Hvernig á að setja upp og nota Cloc í Linux kerfum

Það er auðvelt og einfalt að setja upp klukkuna. Hér að neðan geturðu séð hvernig á að setja upp cloc í mismunandi stýrikerfum með tengdum pakkastjórum þeirra:

$ 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 er hægt að nota til að telja línur í tiltekinni skrá eða í mörgum skrám innan möppu. Til að nota cloc skaltu einfaldlega slá inn cloc og síðan skrána eða möppuna sem þú vilt skoða.

Hér er dæmi úr skrá í bash. Skráin sem um ræðir inniheldur eftirfarandi kóða í bash:

$ cat bash_script.sh

Nú skulum við keyra clock á það.

$ cloc bash_script.sh

Eins og þú sérð taldi það fjölda skráa, auðra línur, athugasemdir og kóðalínur.

Annar flottur eiginleiki cloc er að jafnvel er hægt að nota hann á þjappaðar skrár. Til dæmis hef ég hlaðið niður nýjasta WordPress skjalasafninu og keyrt cloc á það.

$ cloc latest.tar.gz

Hér er niðurstaðan:

Þú getur séð að það þekkir mismunandi tegundir kóða og aðskilur tölfræðina á hvert tungumál.

Ef þú þarft að fá skýrslu fyrir margar skrár í möppu geturðu notað valkostinn \--by-file, sem mun telja línurnar í hverri skrá og gefa skýrslu fyrir þær. getur tekið smá stund fyrir verkefni með margar skrár og þúsundir kóðalína.

Setningafræðin er sem hér segir:

$ cloc --by-file <directory>

Þó að hjálp cloc sé auðlæsileg og skiljanleg, mun ég láta fylgja með nokkra af aukavalkostunum sem hægt er að nota með cloc sem sumum notendum gæti fundist gagnlegt.

  • --diff – reiknar út mismuninn á kóða milli frumskráa sett1 og sett2. Inntakið getur verið blanda af skrám og möppum.
  • --git – þvingar inntak til að vera þekkt sem git markmið ef þau eru ekki fyrst auðkennd sem skráar- eða möppuheiti.
  • --ignore-whitespace – hunsar lárétta hvíta bilið þegar bornar eru saman skrár við --diff.
  • --max-file-size= – ef þú vilt sleppa skrám sem eru stærri en uppgefið magn MB.
  • --exclude-dir=, – útilokaðu gefnar möppur aðskildar með kommu.
  • --exclude-ext=, – útilokaðu tilteknar skráarendingar.
  • --csv – flyttu út niðurstöður á CSV skráarsnið.
  • --csv-delimiter= – notaðu stafinn sem afmörkun.
  • --out= – vistaðu niðurstöðurnar í <file>.
  • --rólegur – bæla niður öll upplýsingaskilaboð og sýndu aðeins lokaskýrsluna.
  • --sql= – skrifaðu niðurstöðurnar sem búa til og settu inn fullyrðingar sem hægt er að lesa af gagnagrunnsforriti eins og SQLite.

Cloc er lítið gagnlegt tól sem er örugglega gott að hafa í vopnabúrinu þínu. Þó að það sé kannski ekki notað daglega, getur það hjálpað þér þegar þú þarft að búa til einhverja skýrslu eða ef þú ert bara forvitinn hvernig gengur verkefnið þitt.