LGTM/it

Descrizione
LGTM è uno strumento di analisi del codice che può essere integrato in più sistemi di controllo della versione del software online e supporta diverse lingue. È un eccellente controllore della qualità del codice, che identifica i problemi del codice che spesso non vengono individuati da altri controllori del codice e linters.

LGTM è adatto come strumento di analisi del codice per lo sviluppo di ambienti di lavoro di FreeCAD in Python e altri progetti di dimensioni medio-piccole. Questa pagina offre una panoramica di come iniziare a usare LGTM con un ambiente di lavoro di FreeCAD in Python.

Per iniziare
Il modo in cui iniziare con LGTM dipende dalla piattaforma di controllo della versione online che si sta utilizzando. La documentazione LGTM per revisione automatica del codice fornisce una buona panoramica di come integrare LGTM nel progetto per diverse piattaforme.

Inoltre su LGTM è possibile eseguire una vasta gamma di analisi approfondite del codice, che va oltre lo scopo di questo tutorial. Si possono leggere ulteriori informazioni al riguardo nella documentazione LGTM su configuring code analysis.

Getting Results
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.

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.

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 file classification, an easy way to filter those files so they don't pollute your analysis results.

Creating a .lgtm.yml File
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:

Note that indent levels are important in LGTM. Incorrect indenting will result in failed file classification.

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.

Relvant Links

 * Continuous Integration
 * LGTM FreeCAD forum discussion thread
 * FreeCAD .lgtm.yml file on Github
 * freecad.trails .lgtm.yml on Github