W repozytorium GitHub możesz zobaczyć „statystyki języka”, która wyświetla procent projektu napisanego w języku. Nie pokazuje jednak, ile wierszy kodu składa się z projektu. Często chcę szybko uzyskać wrażenie skali i złożoności projektu, a liczba wierszy kodu może dać dobre pierwsze wrażenie. 500 linii kodu oznacza stosunkowo prosty projekt, 100 000 linii kodu oznacza bardzo duży / skomplikowany projekt.

Czy możliwe jest uzyskanie wierszy kodu napisanych w różnych językach z repozytorium GitHub, najlepiej bez klonowania?

Pytanie „ Policz liczbę linii w repozytorium git ” pyta, jak policzyć linie kodu w lokalnym repozytorium Git, ale:

1. Musisz sklonować projekt, który może być ogromny. Klonowanie projektu takiego jak na przykład Wine zajmuje wieki.
2. Policzyłbyś wiersze w plikach, które niekoniecznie byłyby kodem, takie jak pliki i13n.
3. Jeśli policzysz tylko (na przykład) pliki Ruby, potencjalnie stracisz ogromną ilość kodu w innych językach, takich jak JavaScript. Musisz wcześniej wiedzieć, jakich języków używa projekt. Musisz także powtórzyć liczenie dla każdego języka, którego używa projekt.

Podsumowując, jest to potencjalnie zbyt czasochłonne, aby „szybko sprawdzić skalę projektu”.

Skrypt powłoki, cloc-git

Za pomocą tego skryptu powłoki można policzyć liczbę wierszy w zdalnym repozytorium Git za pomocą jednego polecenia:

#!/usr/bin/env bash
git clone --depth 1 "$1" temp-linecount-repo &&
  printf "('temp-linecount-repo' will be deleted automatically)\n\n\n" &&
  cloc temp-linecount-repo &&
  rm -rf temp-linecount-repo

Instalacja

Ten skrypt wymaga zainstalowania CLOC („Count Lines of Code”). clocprawdopodobnie można go zainstalować za pomocą menedżera pakietów - na przykład za brew install clocpomocą Homebrew . Istnieje również obraz dokera opublikowany podmribeiro/cloc .

Możesz zainstalować skrypt, zapisując jego kod do pliku cloc-git, uruchamiając chmod +x cloc-git, a następnie przenosząc plik do folderu w swoim, $PATHnp /usr/local/bin.

Stosowanie

Skrypt przyjmuje jeden argument, którym jest dowolny git cloneakceptowany adres URL . Przykładami są https://github.com/evalEmpire/perl5i.git(HTTPS) lub [email protected]:evalEmpire/perl5i.git(SSH). Możesz pobrać ten adres URL z dowolnej strony projektu GitHub, klikając „Klonuj lub pobierz”.

Przykładowe dane wyjściowe:

$ cloc-git https://github.com/evalEmpire/perl5i.git
Cloning into 'temp-linecount-repo'...
remote: Counting objects: 200, done.
remote: Compressing objects: 100% (182/182), done.
remote: Total 200 (delta 13), reused 158 (delta 9), pack-reused 0
Receiving objects: 100% (200/200), 296.52 KiB | 110.00 KiB/s, done.
Resolving deltas: 100% (13/13), done.
Checking connectivity... done.
('temp-linecount-repo' will be deleted automatically)


     171 text files.
     166 unique files.                                          
      17 files ignored.

http://cloc.sourceforge.net v 1.62  T=1.13 s (134.1 files/s, 9764.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Perl                           149           2795           1425           6382
JSON                             1              0              0            270
YAML                             2              0              0            198
-------------------------------------------------------------------------------
SUM:                           152           2795           1425           6850
-------------------------------------------------------------------------------

Alternatywy

Uruchom polecenia ręcznie

Jeśli nie chcesz zawracać sobie głowy zapisywaniem i instalowaniem skryptu powłoki, możesz uruchomić polecenia ręcznie. Przykład:

$ git clone --depth 1 https://github.com/evalEmpire/perl5i.git
$ cloc perl5i
$ rm -rf perl5i

Językoznawca

Jeśli chcesz, aby wyniki dokładnie odpowiadały procentom językowym GitHub, możesz spróbować zainstalować Linguist zamiast CLOC . Zgodnie z README musisz gem install linguisturuchomić, a następnie uruchomić linguist. Nie mogłem zmusić go do pracy ( problem nr 2223 ).

Możesz uruchomić coś takiego

git ls-files | xargs wc -l

co da ci całkowitą liczbę →

Lub użyj tego narzędzia → http://line-count.herokuapp.com/

Istnieje rozszerzenie przeglądarki Google Chrome - GLOC, która działa w publicznych i prywatnych repozytoriach.

Liczy liczbę wierszy kodu projektu z:

• strona szczegółów projektu
• repozytoria użytkownika
• strona organizacji
• strona wyników wyszukiwania
• strona trendów
• eksploruj stronę

Jeśli przejdziesz na stronę wykresów / autorów, zobaczysz listę wszystkich autorów repozytorium oraz liczbę dodanych i usuniętych linii.

O ile mi czegoś nie brakuje, odjęcie łącznej liczby wierszy usuniętych od łącznej liczby wierszy dodanych wśród wszystkich autorów powinno dać całkowitą liczbę wierszy kodu w repozytorium. (EDYCJA: okazuje się, że mimo wszystko czegoś mi brakowało. Spójrz na komentarz orbitbota, aby uzyskać szczegółowe informacje.)

AKTUALIZACJA:

Te dane są również dostępne w interfejsie API GitHub . Napisałem więc szybki skrypt, aby pobrać dane i wykonać obliczenia:

'use strict';

function countGithub(repo) {
fetch('https://api.github.com/repos/'+repo+'/stats/contributors')
    .then(response => response.json())
    .then(contributors => contributors
        .map(contributor => contributor.weeks
            .reduce((lineCount, week) => lineCount + week.a - week.d, 0)))
    .then(lineCounts => lineCounts.reduce((lineTotal, lineCount) => lineTotal + lineCount))
    .then(lines => window.alert(lines));
}

countGithub('jquery/jquery'); // or count anything you like

Wystarczy wkleić go we fragmencie kodu Chrome DevTools, zmienić repozytorium i kliknąć Uruchom.

Oświadczenie (dzięki lovasoa ):

Weź wyniki tej metody z odrobiną soli, ponieważ dla niektórych repozytoriów (sorich87 / bootstrap-tour) daje to wartości ujemne, co może wskazywać, że coś jest nie tak z danymi zwracanymi z API GitHub.

AKTUALIZACJA:

Wygląda na to, że ta metoda obliczania całkowitej liczby linii nie jest całkowicie niezawodna. Spójrz na komentarz orbitbot w celu uzyskania szczegółowych informacji.

Możesz sklonować tylko najnowsze zatwierdzenie za pomocą, git clone --depth 1 <url>a następnie przeprowadzić własną analizę za pomocą Linguist , tego samego oprogramowania, którego używa Github. To jedyny sposób, w jaki wiem, że dostaniesz linie kodu.

Inną opcją jest użycie interfejsu API do wyświetlenia listy języków używanych w projekcie . Nie podaje ich w wierszach, ale w bajtach. Na przykład...

$ curl https://api.github.com/repos/evalEmpire/perl5i/languages
{
  "Perl": 274835
}

Choć weźmy to z odrobiną soli, ten projekt obejmuje YAML i JSON, co potwierdza strona internetowa, ale API nie.

Na koniec możesz użyć wyszukiwania kodu, aby zapytać, które pliki pasują do danego języka. Ten przykład pyta, które pliki w Perl5i to Perl. https://api.github.com/search/code?q=language:perl+repo:evalEmpire/perl5i. Nie podadzą ci wierszy i musisz poprosić o rozmiar pliku osobno, używając zwrotu urldla każdego pliku.

Obecnie nie jest możliwe na Github.com lub ich interfejsach API

Rozmawiałem z obsługą klienta i potwierdziłem, że nie można tego zrobić na github.com. Przekazali tę sugestię zespołowi Github, więc mam nadzieję, że będzie to możliwe w przyszłości. Jeśli tak, na pewno zedytuję tę odpowiedź.

Tymczasem odpowiedź Rory O'Kane jest doskonałą alternatywą opartą na clocpłytkim klonie repo.

Możesz użyć GitHub API, aby uzyskać sloc podobny do poniższej funkcji

function getSloc(repo, tries) {

    //repo is the repo's path
    if (!repo) {
        return Promise.reject(new Error("No repo provided"));
    }

    //GitHub's API may return an empty object the first time it is accessed
    //We can try several times then stop
    if (tries === 0) {
        return Promise.reject(new Error("Too many tries"));
    }

    let url = "https://api.github.com/repos" + repo + "/stats/code_frequency";

    return fetch(url)
        .then(x => x.json())
        .then(x => x.reduce((total, changes) => total + changes[1] + changes[2], 0))
        .catch(err => getSloc(repo, tries - 1));
}

Osobiście zrobiłem rozszerzenie chrome, które pokazuje liczbę SLOC zarówno na liście projektów github, jak i na stronie szczegółów projektu. Możesz także ustawić swój osobisty token dostępu, aby uzyskać dostęp do prywatnych repozytoriów i ominąć limit prędkości API.

Możesz pobrać stąd https://chrome.google.com/webstore/detail/github-sloc/fkjjjamhihnjmihibcmdnianbcbccpnn

Kod źródłowy jest dostępny tutaj https://github.com/martianyi/github-sloc

Dodatek Firefox Github SLOC

Napisałem mały dodatek do Firefoksa, który drukuje liczbę wierszy kodu na stronach projektu github: Github SLOC

Jeśli pytanie brzmi „czy możesz szybko uzyskać LICZBĘ LINII repozytorium github”, odpowiedź brzmi „nie”, jak podają inne odpowiedzi.

Jeśli jednak pytanie brzmi: „czy możesz szybko sprawdzić SKALĘ projektu”, zwykle oceniam projekt na podstawie jego wielkości. Oczywiście rozmiar będzie zawierał delty ze wszystkich aktywnych zatwierdzeń, ale jest to dobra miara, ponieważ rząd wielkości jest dość bliski.

Na przykład

Jak duży jest projekt „dokera”?

W przeglądarce wpisz api.github.com/repos/ORG_NAME/PROJECT_NAME, tj. Api.github.com/repos/docker/docker

W haszu odpowiedzi można znaleźć atrybut rozmiaru:

{
    ...
    size: 161432,
    ...
}

To powinno dać ci wyobrażenie o względnej skali projektu. Wydaje się, że liczba ta jest w KB, ale kiedy sprawdziłem ją na moim komputerze, jest ona faktycznie mniejsza, mimo że rząd wielkości jest spójny. (161432 KB = 161 MB, dok-du -s-h = 65 MB)

npm install sloc -g

git clone --depth 1 https://github.com/vuejs/vue/
sloc ".\vue\src" --format cli-table
rm -rf ".\vue\"

Instrukcje i objaśnienia

1. Zainstaluj sloc z npm , narzędzia wiersza poleceń ( Node.js musi być zainstalowany).

npm install sloc -g

2. Klon płytkie repozytorium (szybsze pobieranie niż pełny klon).

git clone --depth 1 https://github.com/facebook/react/

3. Uruchom sloc i określ ścieżkę, którą należy przeanalizować.

sloc ".\react\src" --format cli-table

SLOC obsługuje formatowanie danych wyjściowych postaci cli-table, jak jsoni csv. Wykluczeń regularnych można używać do wykluczania plików i folderów ( dalsze informacje na temat npm ).

4. Usuń folder repozytorium (opcjonalnie)

Powershell: rm -r -force ".\react\"lub na Mac / Unix:rm -rf ".\react\"

Zrzuty ekranu z wykonanych kroków (cli-table):

wyjście sloc (bez argumentów):

Potokuj dane wyjściowe z liczby linii w każdym pliku, sortaby uporządkować pliki według liczby linii. git ls-files | xargs wc -l |sort -n

Z komentarza @ Tgr istnieje narzędzie online: https://codetabs.com/count-loc/count-loc-online.html

Otwórz terminal i uruchom następujące polecenie:

curl https://api.codetabs.com/v1/loc?github=username/reponame