Przejdź do głównej zawartości

Werifikacja poprawności kodu

Jak sprawdzić, czy twój kod jest poprawny?


Dziś już oddałem jeden wpis, ale zaoszczędziłem trochę czasu i mogę napisać kolejny. Jest u mnie 22 i może zdążę do północy.
Gdy jesteś początkującym koderem (takim jak ja), chciałbyś wiedzieć, czy twój kod jest poprawny i pisany zgodnie z obowiązującymi standardami. Jednym ze sposobów jest publikacja kodu na forum programistycznym. Kilka razy tak zrobiłem i dostałem treściwą odpowiedź, ale zdarzały się sytuacje, gdy nikt nie odpowiadał. Wtedy zastanawiałem się, czy mój kod jest tak zły, że fachowcy nie mają już siły dopowiadać na te same błędy, czy taki dobry, że nie ma do czego się doczepić. 😉
To niesie także ryzyko, że kod zostanie sprawdzony powierzchownie i o wielu błędach się nie dowiesz. Może się też zdarzyć, że wywiąże się dyskusja pomiędzy kilkoma mistrzami, o tym, jak powinien wyglądać poprawny kod. Po takiej dyskusji zazwyczaj jesteś bardziej skołowany niż przed zadaniem pytania.
Czasami po prostu głupio pytać kolejny raz o sprawdzenie kodu i zawracać ludziom głowę.

Codacy

Parę dni temu trafiłem na Codacy. Na ich stronie można przeczytać: "Check code style, security, duplication, complexity and coverage on every change while tracking code quality throughout your sprints". Hmmm, to coś dla mnie.
Wiecie co, to naprawdę fajnie działa. Co prawda używam dopiero trzeci dzień, ale jest bardzo pomocne.

Na początku Codacy integruje się z twoim GitHubem, ale również może z Bitbucket i GitLab.
Po pomyślnym zalogowaniu i wybraniu repozytorium dostajemy jego analizę.
W lewym górnym rogu widzimy ocenę ogólną naszego kodu. "C" to nawet nieźle, taka nasza 3. Poniżej mamy podział na rodzaje błędów, obok kółko z procentowym podziałem błędów na kategorie. W prawym dolnym rogu wykres występujących problemów po dodawaniu kolejnych commitów. Jak widzicie dzisiejszy commit podniósł mi linie na wykresie.
W zakładce "Commits" możemy się przyjrzeć bliżej naszym commitom. Wydawał mi się, że zrobiłem małe poprawki w kodzie a tu proszę, 39 błędów poprawionych, 57 nowych.
Statystyki, statystykami, ale dopiero to mnie uszczęśliwiło. Program zaznacza niepoprawny fragment kodu, opisuje dlaczego nie powinno się tego tak robić, podaje przykład poprawnego rozwiązania, wyświetla źródło dokumentacji. Nawet informuje o tym ile czasu powinno zająć usuwanie tego błędu. Dla mnie bomba.
Zakładka "files" to rozbicie błędów na pliki, wraz z ich oceną. Średnią ocenę ratują mi pliki CSS. Ciężko mi uwierzyć, że są tak dobrze napisane. W plikach CSS algorytm sprawdzający raczej nie jest efektywny.
W "code patterns" mamy listę narzędzi sprawdzających kod. Możemy je wyłączyć i ustawić własne reguły. Z ciekawości sprawdziłem mój kod w CSSLint online i wysypało dużo błędów. Widocznie narzędzie CSSLint w Codacy, nie działa jak powinno. 

Po commicie przychodzi mail informujący o jego jakości.

Pomimo tego małego zgrzytu z CSS, Codacy to bardzo przydatne narzędzie dla początkujących programistów. Poprawa kodu sprawia frajdę. Ocena rośnie, słupki błędów idą w dół.

Codacyma wersję darmową i płatną 15$ na miesiąc. W płatnej masz nieograniczone prywatne repozytoria, szybsza analza i inne dodatki. W wersji darmowej nieograniczone repozytoria ma kod open source.

Komentarze

Popularne posty z tego bloga

Animacja w tle

Pierwsze próby animacji SVG W poprzednim poście przedstawiłem wam tło do gry. Może wrzucę rysunek jeszcze raz. Całość jest zrobiona wektorowo i ustawiona w CSS jako background body. To teraz dodaję animację chmur i słońca. Chwilę googlowania i... zaraz, zaraz, jak to nie można animować elementy SVG w background? Oczywiście, że nie! Przecież miałem już podobny problem. Opowiem Wam o tym. Nie wiem, czy wam się już chwaliłem, ale jedna z moich postaci już rusza ręką. Macha sobie radośnie, ale żeby to robiła, to ja straciłem dla niej dużo czasu. Pewnie jak większość wie, plik SVG może składać się z figur geometrycznych, ścieżek, które mogą posiadać  swój id. Można też dodać im klasy. Po umieszczeniu SVG w HTML, można nim manipulować CSS lub JavaScriptem, podobnie jak np. divem, img, tekstem. A przynajmniej tak mi się wydawało. W pierwszych podejściach do animacji z pomocą GSAP, ustawiłem moją postać w tagu img. Na nic się nie zdała próba animacji jakiejkolwiek części ci...

GSAP - framework Javascript

GSAP, ależ to dobre jest   Im dłużej siedzę nad tą grą, tym częściej jestem miło zaskakiwany. Chociaż nie od razu jest przyjemnie, zwłaszcza jak się ma bardziej skomplikowane problemy do rozwiązania (jak dla mnie). Do tej pory nie stosowałem żadnych frameworków i prostą animację chciałem zrobić w CSS. W miarę czytania o GASP (GreenSock Animation Platform) i jego testowania, zrezygnowałem z jakiejkolwiek animacji w CSS. Czym jest GSAP? Jest to zbiór narzędzi do tworzenia animacji w JS. https://greensock.com/gsap Obsługuje podstawowe funkcje animacji, takich jak ruch w dowolnym kierunku, czas trwania, zmiana koloru, przeźroczystości, skalowania, obracania obiektu. Na tym jednak się nie kończy. Można manipulować opóźnieniem animacji, krzywą prędkości https://greensock.com/ease-visualizer ,wykonywać przekształcenia 3D. Animacje mogą nachodzić na siebie lub występować jedna po drugiej. Jest też sporo wtyczek z zaawansowanymi funkcjami. Użycie Wystarczy wkleić link do...

Nowe plansze

To jeszcze nie koniec Część uczestników już pożegnała się z konkursem, ale przecież jeszcze trwa trzy dni. Można kilka postów napisać 😉. Ja walczę do końca. Oceniam, że projekt wykonałem na ok 85%. Brakuje planszy "Author" i dopieszczonego kodu. I to właśnie na kodzie skupię się przez te ostatnie dni. Aby trochę nadrobić czasu, nowe tła są pobrane z pixabay.com Gdy zbliża się deadline, automatycznie pogarsza się jakość nowego kodu. DRY przeszedł na dalszy plan, pojawiły się powtórzenia.  Byle wszystko działało, aby klient był zadowolony. Niestety i stety, Wy macie wgląd do mojego kodu i możecie powiedzieć: "panie! co mi tu za bubla pokazujesz?". Repo: https://github.com/GuyDiamond/where_is_my_letter Dlatego mam ambitny plan w Codacy (opisywałem go tutaj ), podnieść jakość kodu z C na B. Bug Wcześniej jednak muszę się uporać z błędem, który znajduje się w metodach parseClick i guessPair w kontrolerze. Czasami (na razie, nie umiem wyłapać reguły) niek...