cloc - Koodirivien laskeminen monilla ohjelmointikielillä

Kun työskentelet eri projekteissa, saatat joskus joutua toimittamaan raportin tai tilastot edistymisestäsi tai yksinkertaisesti laskemaan koodisi arvon.

On olemassa tämä yksinkertainen mutta tehokas työkalu nimeltä "cloc – laske koodirivejä", jonka avulla voit laskea kaikki koodisi määrät ja sulkea pois kommentit ja tyhjät rivit samanaikaisesti.

Se on saatavilla kaikissa suurimmissa Linux-jakeluissa ja tukee useita ohjelmointikieliä ja tiedostopäätteitä, eikä sen käytölle ole erityisiä vaatimuksia.

Tässä opetusohjelmassa opit asentamaan cloc-sovelluksen ja käyttämään sitä Linux-järjestelmässäsi.

Kuinka asentaa ja käyttää Clocia Linux-järjestelmissä

Clocin asentaminen on helppoa ja yksinkertaista. Alla näet kuinka Cloc asennetaan eri käyttöjärjestelmiin niihin liittyvien paketinhallintaohjelmien avulla:

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

Clocia voidaan käyttää rivien laskemiseen tietyssä tiedostossa tai useissa hakemiston tiedostoissa. Jos haluat käyttää cloc-näppäintä, kirjoita vain cloc ja sen jälkeen tiedosto tai hakemisto, jota haluat tarkastella.

Tässä on esimerkki tiedostosta bashissa. Kyseinen tiedosto sisältää seuraavan koodin bashissa:

cat bash_script.sh

Jatketaan nyt sitä.

cloc bash_script.sh

Kuten näet, se laski tiedostojen määrän, tyhjiä rivejä, kommentteja ja koodirivejä.

Toinen hieno cloc-ominaisuus on, että sitä voidaan käyttää jopa pakattujen tiedostojen kanssa. Olen esimerkiksi ladannut uusimman WordPress-arkiston ja suorittanut siinä cloc-ohjelman.

cloc latest.tar.gz

Tässä on tulos:

Voit nähdä, että se tunnistaa erityyppiset koodit ja erottaa tilastot kielikohtaisesti.

Jos haluat saada raportin useista tiedostoista hakemistossa, voit käyttää vaihtoehtoa "--by-file", joka laskee jokaisen tiedoston rivit ja antaa niistä raportin. Tämä voi kestää jonkin aikaa projekteissa, joissa on useita tiedostoja ja tuhansia koodirivejä.

Syntaksi on seuraava:

cloc --by-file <directory>

Vaikka cloc-apu on helposti luettavaa ja ymmärrettävää, otan mukaan joitain lisäasetuksia, joita voidaan käyttää clocin kanssa joidenkin käyttäjien mielestä.

  • --diff – laskee koodin erot set1- ja set2-lähdetiedostojen välillä. Syöte voi olla sekoitus tiedostoja ja hakemistoja.
  • --git – pakottaa syötteet tunnistamaan git-kohteiksi, jos niitä ei ensin tunnisteta tiedostojen tai hakemistojen nimiksi.
  • --ignore-whitespace – ohittaa vaakasuuntaisen välilyönnin, kun tiedostoja verrataan parametriin --diff.
  • --max-file-size= – jos haluat ohittaa tiedostot, jotka ovat suurempia kuin annettu määrä Mt.
  • --exclude-dir=, – sulje pois annetut pilkuilla erotetut hakemistot.
  • --exclude-ext=, – ohita annetut tiedostotunnisteet.
  • --csv – vie tulokset CSV-tiedostomuotoon.
  • --csv-delimiter= – käytä merkkiä erottimena.
  • --out= – tallenna tulokset tiedostoon <file>.
  • --hiljainen – piilota kaikki tietoviestit ja näytä vain loppuraportti.
  • --sql= – kirjoita tulokset luomis- ja lisäyskäskyinä, jotka tietokantaohjelma, kuten SQLite, voi lukea.
Johtopäätös

Cloc on pieni hyödyllinen apuohjelma, joka on ehdottomasti hyvä olla arsenaalissasi. Vaikka sitä ei ehkä käytetäkään päivittäin, se voi auttaa sinua, kun sinun on luotava jokin raportti tai jos olet vain utelias, kuinka projektisi etenee.