LGTM/pl: Difference between revisions

From FreeCAD Documentation
(Created page with "Ponadto możliwe jest przeprowadzenie szerokiego zakresu dogłębnych analiz kodu w LGTM, co wykracza poza zakres tego samouczka. Więcej informacji na ten temat można znaleźć w dokumentacji LGTM na stronie [https://lgtm.com/help/lgtm/configuring-lgtm-analysis-project konfigurowanie analizy kodu].")
(Created page with "* Ciągła integracja * LGTM [https://www.forum.freecadweb.org/viewtopic.php?f=10&t=40228 FreeCAD wątek dyskusyjny na forum] * FreeCAD <tt>.lgtm.yml</tt> file on [https://github.com/FreeCAD/FreeCAD/blob/master/lgtm.yml GitHub] * freecad.trails <tt>.lgtm.yml</tt> on [https://github.com/joelgraff/freecad.trails/blob/dev/.lgtm.yml GitHub]")
 
(9 intermediate revisions by the same user not shown)
Line 17: Line 17:
Ponadto możliwe jest przeprowadzenie szerokiego zakresu dogłębnych analiz kodu w LGTM, co wykracza poza zakres tego samouczka. Więcej informacji na ten temat można znaleźć w dokumentacji LGTM na stronie [https://lgtm.com/help/lgtm/configuring-lgtm-analysis-project konfigurowanie analizy kodu].
Ponadto możliwe jest przeprowadzenie szerokiego zakresu dogłębnych analiz kodu w LGTM, co wykracza poza zakres tego samouczka. Więcej informacji na ten temat można znaleźć w dokumentacji LGTM na stronie [https://lgtm.com/help/lgtm/configuring-lgtm-analysis-project konfigurowanie analizy kodu].


<span id="Getting_Results"></span>
== Getting Results ==
==Uzyskiwanie rezultatów==


Po skonfigurowaniu LGTM i zapewnieniu dostępu do repozytoriów kodu, analizy są zwykle wykonywane codziennie w repozytorium. Tak więc wypchnięte zmiany nie przyniosą natychmiastowych wyników. Możliwe jest, aby LGTM analizował pull requesty po ich przesłaniu, jak opisano w dokumentacji LGTM.
Once you've set up LGTM and provided access to your code repositories, analyses are typically done daily on the repository. So, pushed changes will not yeild results immediately. It is possible to have LGTM analyze pull requests when they are submitted, as described in the LGTM documentation.


Przeglądanie wyników wymaga po prostu zalogowania się do pulpitu nawigacyjnego LGTM i wybrania żądanego projektu. Z tego miejsca analizy kodu dostarczą listę problemów ''(takich jak błędy, złe praktyki kodowania, bezużyteczny / nieistotny / niewykorzystany kod itp.)'' Ponadto LGTM zapewnia ogólne "oceny" kodu ''(A, B, C, D)'' w zależności od liczby problemów w porównaniu z ogólnym rozmiarem projektu.
Reviewing the results simply requires logging in to your LGTM dashboard and selecting the desired project. From there, code analyses will provide a list of issues (like bugs, bad coding practices, useless/irrelevant/unused code, etc.) for your perusal. In addition LGTM provides overall code 'ratings' (A, B, C, D) depending on the number of issue you have compared to the overall size of your project.


Prawdopodobnie najbardziej użytecznym, natychmiastowym sposobem zarządzania wynikami analizy kodu jest po prostu odfiltrowanie plików w projekcie, których nie chcesz analizować. Załóżmy, że rozwijasz nowy kod, który jest niekompletny, przechowujesz starszy kod, który jest nieużywany lub masz dużo kodu testowego, który nie wymaga analizy. LGTM zapewnia [https://lgtm.com/help/lgtm/file-classification klasyfikację plików], łatwy sposób filtrowania tych plików, aby nie zanieczyszczały wyników analizy.
Probably, the most useful, immediate way to manage the results of your code analysis is simply filtering out files in your project that you don't want analyzed. That is, suppose you're developing new code that is incomplete, keeping around legacy code that is otherwise unused, or have a good deal of testing code that doesn't need analysis. LGTM provides [https://lgtm.com/help/lgtm/file-classification file classification], an easy way to filter those files so they don't pollute your analysis results.


===Creating a .lgtm.yml File===
==Tworzenie pliku .lgtm.yml ==
Aby włączyć klasyfikację plików, należy najpierw utworzyć plik o nazwie ".lgtm.yml" w najwyższym katalogu projektu. Następnie w tym pliku dodaj kilka klasyfikacji.
To enable file classification, first create a file named ".lgtm.yml" in your projects top-most directory. Then, in that file, add some classifications.


Below is an example from the FreeCAD Trails Python workbench:
Poniżej znajduje się przykład ze środowiska pracy FreeCAD Trails zakodowanego w Python:


{{Code|code=
{{Code|code=
Line 50: Line 51:
}}
}}


Należy pamiętać, że poziomy wcięć są ważne w LGTM. Nieprawidłowe wcięcie spowoduje nieudaną klasyfikację pliku.
Note that indent levels are important in LGTM. Incorrect indenting will result in failed file classification.


Ponadto niektóre klasyfikacje ''(takie jak "szablon" i "test")'' są używane przez LGTM do zapytań i innych komponentów analitycznych. Można również zdefiniować własne tagi, które będą filtrować kod i dostarczać dodatkowych wyników zapytań.
Also, some classifications (like 'template' and 'test') are used by LGTM for queries and other analysis components. You may also define your own custom tags, which will filter code and provide additional queryable results.


<span id="Relevant_Links"></span>
=== Relevant Links ===
==Istotne odnośniki internetowe==


* [[Continuous_Integration/pl|Ciągła integracja]]
* [[Continuous Integration|Continuous Integration]]
* LGTM [https://www.forum.freecadweb.org/viewtopic.php?f=10&t=40228 FreeCAD forum discussion thread]
* LGTM [https://www.forum.freecadweb.org/viewtopic.php?f=10&t=40228 FreeCAD wątek dyskusyjny na forum]
* FreeCAD <tt>.lgtm.yml</tt> file on [https://github.com/FreeCAD/FreeCAD/blob/master/lgtm.yml Github]
* FreeCAD <tt>.lgtm.yml</tt> file on [https://github.com/FreeCAD/FreeCAD/blob/master/lgtm.yml GitHub]
* freecad.trails <tt>.lgtm.yml</tt> on [https://github.com/joelgraff/freecad.trails/blob/dev/.lgtm.yml Github]
* freecad.trails <tt>.lgtm.yml</tt> on [https://github.com/joelgraff/freecad.trails/blob/dev/.lgtm.yml GitHub]
[[Category:Developer{{#translation:}}]]
[[Category:Developer{{#translation:}}]]
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Developer Documentation{{#translation:}}]]

Latest revision as of 15:52, 30 October 2023

Other languages:

Informacje ogólne

LGTM to narzędzie do analizy kodu, które może być zintegrowane z wieloma systemami kontroli wersji oprogramowania online i obsługuje kilka różnych języków. Jest to doskonałe narzędzie do sprawdzania jakości kodu, identyfikujące problemy z kodem, które często są pomijane przez inne narzędzia do sprawdzania kodu i lintery.

LGTM doskonale nadaje się jako narzędzie do analizy kodu do opracowywania środowisk pracy FreeCAD Python i innych małych i średnich projektów. Ta strona zawiera przegląd tego, jak rozpocząć korzystanie z LGTM w środowisku pracy FreeCAD przygotowanym w Python.

Rozpoczęcie pracy

Rozpoczęcie pracy z LGTM zależy od używanej platformy kontroli wersji online. Dokumentacja LGTM dla automatycznego przeglądu kodu zawiera dobry przegląd tego, jak zintegrować LGTM z projektem dla kilku platform.

Ponadto możliwe jest przeprowadzenie szerokiego zakresu dogłębnych analiz kodu w LGTM, co wykracza poza zakres tego samouczka. Więcej informacji na ten temat można znaleźć w dokumentacji LGTM na stronie konfigurowanie analizy kodu.

Uzyskiwanie rezultatów

Po skonfigurowaniu LGTM i zapewnieniu dostępu do repozytoriów kodu, analizy są zwykle wykonywane codziennie w repozytorium. Tak więc wypchnięte zmiany nie przyniosą natychmiastowych wyników. Możliwe jest, aby LGTM analizował pull requesty po ich przesłaniu, jak opisano w dokumentacji LGTM.

Przeglądanie wyników wymaga po prostu zalogowania się do pulpitu nawigacyjnego LGTM i wybrania żądanego projektu. Z tego miejsca analizy kodu dostarczą listę problemów (takich jak błędy, złe praktyki kodowania, bezużyteczny / nieistotny / niewykorzystany kod itp.) Ponadto LGTM zapewnia ogólne "oceny" kodu (A, B, C, D) w zależności od liczby problemów w porównaniu z ogólnym rozmiarem projektu.

Prawdopodobnie najbardziej użytecznym, natychmiastowym sposobem zarządzania wynikami analizy kodu jest po prostu odfiltrowanie plików w projekcie, których nie chcesz analizować. Załóżmy, że rozwijasz nowy kod, który jest niekompletny, przechowujesz starszy kod, który jest nieużywany lub masz dużo kodu testowego, który nie wymaga analizy. LGTM zapewnia klasyfikację plików, łatwy sposób filtrowania tych plików, aby nie zanieczyszczały wyników analizy.

Tworzenie pliku .lgtm.yml

Aby włączyć klasyfikację plików, należy najpierw utworzyć plik o nazwie ".lgtm.yml" w najwyższym katalogu projektu. Następnie w tym pliku dodaj kilka klasyfikacji.

Poniżej znajduje się przykład ze środowiska pracy FreeCAD Trails zakodowanego w Python:

path_classifiers:
  template:
    - freecad/trails/resources
    - freecad/trails/project/commands/command_template.py
    - freecad/trails/init_gui.py
 
  test:
    - freecad/trails/project/commands/spiral_test.py
    - freecad/trails/TestFPO.py
 
  legacy:
    - freecad/trails/corridor/loft
    - freecad/trails/alignment/VerticalAlignment.py
    - freecad/trails/alignment/VerticalCurve.py
    - freecad/trails/alignment/GenerateVerticalAlignment.py
    - freecad/trails/alignment/ImportVerticalCurve.py
    - freecad/trails/corridor/template/TemplateLibrary.py

Należy pamiętać, że poziomy wcięć są ważne w LGTM. Nieprawidłowe wcięcie spowoduje nieudaną klasyfikację pliku.

Ponadto niektóre klasyfikacje (takie jak "szablon" i "test") są używane przez LGTM do zapytań i innych komponentów analitycznych. Można również zdefiniować własne tagi, które będą filtrować kod i dostarczać dodatkowych wyników zapytań.

Istotne odnośniki internetowe