cloc - loendage koodiread paljudes programmeerimiskeeltes

Erinevate projektidega töötades võidakse mõnikord nõuda aruannet või statistikat oma edusammude kohta või lihtsalt oma koodi väärtuse arvutamiseks.

Seal on see lihtne, kuid võimas tööriist nimega\"cloc - loendage koodiread", mis võimaldab teil loendada kogu koodi ja välistada kommentaarid ja tühjad read korraga.

See on saadaval kõigis suuremates Linuxi distributsioonides ning toetab mitut programmeerimiskeelt ja faililaiendit ning sellel pole mingeid erinõudeid, mida kasutada.

Selles õpetuses saate teada, kuidas installida ja kasutada cloci oma Linuxi süsteemis.

Kuidas installida ja kasutada Cloci Linuxi süsteemides

Cloci installimine on lihtne ja lihtne. Allpool näete, kuidas installida cloc erinevatesse opsüsteemidesse koos nende seotud paketihalduritega:

$ 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

Cloci saab kasutada ridade loendamiseks konkreetses failis või kataloogis mitmes failis. Cloc-i kasutamiseks sisestage lihtsalt cloc, millele järgneb fail või kataloog, mida soovite uurida.

Siin on näide bashi failist. Kõnealune fail sisaldab bashis järgmist koodi:

$ cat bash_script.sh

Nüüd laseb sellel kloki käivitada.

$ cloc bash_script.sh

Nagu näete, loendas see failide, tühjade ridade, kommentaaride ja koodiridade arvu.

Cloci teine lahe omadus on see, et seda saab kasutada isegi tihendatud failides. Näiteks olen alla laadinud uusima WordPressi arhiivi ja käivitanud selle cloc-i.

$ cloc latest.tar.gz

Siin on tulemus:

Näete, et see tunneb ära erinevad kooditüübid ja eraldab statistika keele kohta.

Kui peate kataloogis leidma mitme faili kohta aruande, võite kasutada valikut \"- faili kaupa" , mis loendab iga faili read ja esitab neile aruande. See paljude failide ja tuhandete koodiridadega projektide jaoks võib kuluda aega.

Süntaks on järgmine:

$ cloc --by-file <directory>

Kuigi kloki abi on hõlpsasti loetav ja arusaadav, lisan mõned lisavõimalused, mida saab kasutada klotsiga, millest mõned kasutajad võivad kasulikud olla.

  • --diff - arvutab erinevused koodis set1 ja set2 lähtefailide vahel. Sisend võib olla segu failidest ja kataloogidest.
  • --git - sunnib sisendeid tuvastama git-sihtmärkidena, kui neid ei tuvastata esmalt faili- või katalooginimedena.
  • --ignore-whitespace - ignoreerib horisontaalset tühimikku, kui võrrelda faile --diff -ga.
  • --max-file-size= - kui soovite vahele jätta antud MB-st suuremad failid.
  • --clude-dir=, - välista antud komaga eraldatud kataloogid.
  • --exclude-ext=, - välistage antud faililaiendid.
  • --csv - eksportige tulemused CSV-failivormingusse.
  • --csv-delimiter= - eraldajana kasutage märki .
  • --out= - salvestage tulemused kausta <file>.
  • --quiet - summutage kõik infosõnumid ja kuvage ainult lõpparuanne.
  • --sql= - kirjutage tulemused loomise ja sisestamise lausetena, mida andmebaasiprogramm, näiteks SQLite, saab lugeda.

Cloc on vähe kasulik utiliit, mida on kindlasti hea arsenalis omada. Ehkki seda ei pruugita kasutada igapäevaselt, võib see teid aidata, kui peate mõne aruande koostama või kui olete lihtsalt uudishimulik, kuidas teie projekt edeneb.