luacheck - Online in de cloud

PROGRAMMA:

NAAM

luacheck - luacheck-documentatie

Inhoud:

LIJST OF WAARSCHUWINGEN

Waarschuwingen geproduceerd door Luacheck worden gecategoriseerd met behulp van driecijferige waarschuwingscodes. Waarschuwing
codes kunnen worden weergegeven in CLI-uitvoer met behulp van --codes CLI-optie of codes configuratie optie.
Fouten hebben ook codes die beginnen met nul.

┌─────┬───────────────────────────────── ─┐
│Code │ Beschrijving │
├─────┼───────────────────────────────── ─┤
│011 │ Een syntaxisfout. │
├─────┼───────────────────────────────── ─┤
│021 │ Een ongeldige inline-optie. │
├─────┼───────────────────────────────── ─┤
│022 │ Een verbeterde inline push │
│ │ richtlijn. │
├─────┼───────────────────────────────── ─┤
│023 │ Een bijgewerkte inline pop-richtlijn. │
├─────┼───────────────────────────────── ─┤
│111 │ Een ongedefinieerde globale │ instellen
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│112 │ Een ongedefinieerde globale │ muteren
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│113 │ Toegang tot een ongedefinieerde globale │
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│121 │ Een alleen-lezen globale │ instellen
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│122 │ Muteren van een alleen-lezen globale │
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│131 │ Ongebruikte impliciet gedefinieerde globale │
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│211 │ Ongebruikte lokale variabele. │
├─────┼───────────────────────────────── ─┤
│212 │ Ongebruikt argument. │
├─────┼───────────────────────────────── ─┤
│213 │ Ongebruikte lusvariabele. │
├─────┼───────────────────────────────── ─┤
│221 │ Lokale variabele is toegankelijk, maar │
│ │ nooit ingesteld. │
├─────┼───────────────────────────────── ─┤
│231 │ Lokale variabele is ingesteld, maar nooit │
│ │ toegankelijk. │
├─────┼───────────────────────────────── ─┤
│232 │ Er is een argument ingesteld, maar nooit │
│ │ toegankelijk. │
├─────┼───────────────────────────────── ─┤
│233 │ Lusvariabele is ingesteld, maar nooit │
│ │ toegankelijk. │
├─────┼───────────────────────────────── ─┤
│311 │ Waarde toegewezen aan een lokale │
│ │ variabele is ongebruikt. │
└─────┴───────────────────────────────── ─┘

│312 │ Waarde van een argument wordt niet gebruikt. │
├─────┼───────────────────────────────── ─┤
│313 │ Waarde van een lusvariabele is │
│ │ ongebruikt. │
├─────┼───────────────────────────────── ─┤
│321 │ Toegang tot niet-geïnitialiseerde lokale │
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│411 │ Een lokale variabele opnieuw definiëren. │
├─────┼───────────────────────────────── ─┤
│412 │ Een argument opnieuw definiëren. │
├─────┼───────────────────────────────── ─┤
│413 │ Een lusvariabele opnieuw definiëren. │
├─────┼───────────────────────────────── ─┤
│421 │ Een lokale variabele schaduwen. │
├─────┼───────────────────────────────── ─┤
│422 │ Een argument schaduwen. │
├─────┼───────────────────────────────── ─┤
│423 │ Schaduw van een lusvariabele. │
├─────┼───────────────────────────────── ─┤
│431 │ Een stijging van de waarde in de schaduw stellen. │
├─────┼───────────────────────────────── ─┤
│432 │ Een opwaardeerargument in de schaduw stellen. │
├─────┼───────────────────────────────── ─┤
│433 │ Schaduw van een opwaarderingslus │
│ │ variabel. │
├─────┼───────────────────────────────── ─┤
│511 │ Onbereikbare code. │
├─────┼───────────────────────────────── ─┤
│512 │ Lus kan maximaal │ worden uitgevoerd
│ │ een keer. │
├─────┼───────────────────────────────── ─┤
│521 │ Ongebruikt etiket. │
├─────┼───────────────────────────────── ─┤
│531 │ Linkerkant van een opdracht │
│ │ is te kort. │
├─────┼───────────────────────────────── ─┤
│532 │ Linkerkant van een opdracht │
│ │ is te lang. │
├─────┼───────────────────────────────── ─┤
│541 │ Een lege do einde blok. │
├─────┼───────────────────────────────── ─┤
│542 │ Een lege if tak. │
├─────┼───────────────────────────────── ─┤
│551 │ Een lege verklaring. │
└─────┴───────────────────────────────── ─┘

Globaal variabelen
Voor elk bestand bouwt Luacheck een lijst op met gedefinieerde globalen die daar kunnen worden gebruikt. Standaard
alleen globals uit de Lua-standaardbibliotheek zijn gedefinieerd; aangepaste globalen kunnen worden toegevoegd met behulp van
--mondialen CLI-optie of globals config-optie en de versie van de standaardbibliotheek kunnen zijn
geselecteerd met behulp van --soa CLI-optie of soa configuratie optie. Wanneer een ongedefinieerde globale waarde is ingesteld,
gemuteerd of geopend, geeft Luacheck een waarschuwing.

Alleen-lezen globals
Standaard zijn dit alle standaard globale waarden, behalve _G en pakket zijn gemarkeerd als alleen-lezen, zodat
het instellen of muteren ervan levert een waarschuwing op. Aangepaste alleen-lezen globale waarden kunnen worden toegevoegd met behulp van
--lees-globalen CLI-optie of lees_globalen configuratie optie.

impliciet gedefinieerd globals
Luacheck kan worden geconfigureerd om globale toewijzingen die onder bepaalde omstandigheden zijn toegewezen, te overwegen
impliciet gedefinieerd. Wanneer -d/--allow_gedefinieerd CLI-optie of toestaan_gedefinieerd configuratieoptie is
gebruikt, alle toewijzingen aan globalen definiëren ze; wanneer -t/--allow_gedefinieerde_top CLI-optie of
allow_gedefinieerde_top config-optie wordt gebruikt, toewijzingen aan globalen in de functie op het hoogste niveau
scope (ook bekend als hoofddeel) definieer ze. Er wordt een waarschuwing gegeven als er impliciet een fout optreedt
gedefinieerd globaal is nergens toegankelijk.

Modules
Bestanden kunnen als modules worden gemarkeerd met behulp van -m/--module CLI-optie of module configuratieoptie aan
simuleer de semantiek van de verouderde versie module functie. Globalen impliciet gedefinieerd binnen a
module worden beschouwd als onderdeel van de interface, zijn niet zichtbaar buiten en worden niet gerapporteerd
als ongebruikt. Toewijzingen aan andere globalen zijn niet toegestaan, zelfs niet aan gedefinieerde globalen.

ongebruikt variabelen en waarden
Luacheck genereert waarschuwingen voor alle ongebruikte lokale variabelen behalve één met de naam _. Ook
detecteert variabelen die zijn ingesteld maar nooit worden geopend, of die worden geopend maar nooit worden ingesteld.

ongebruikt waarden en niet geïnitialiseerd variabelen
Voor elke waarde die aan een lokale variabele wordt toegewezen, berekent Luacheck een reeks uitdrukkingen waar deze waarde is
kan gebruikt worden. Er worden waarschuwingen gegenereerd voor ongebruikte waarden (wanneer een waarde niet kan worden gebruikt
waar dan ook) en voor toegang tot niet-geïnitialiseerde variabelen (wanneer geen enkele waarde een
uitdrukking). In het volgende fragment wordt bijvoorbeeld een waarde toegewezen foo op lijn 1 is ongebruikt, en
variabele bars is niet geïnitialiseerd op regel 9:

lokale foo = expr1()
plaatselijke kroeg

als voorwaarde() dan
foo = expr2()
balk = expr3()
anders
foo = expr4()
afdrukken(balk)
einde

retour foo, bar

Secundair waarden en variabelen
Ongebruikte waarde die aan een lokale variabele wordt toegewezen, is secundair als de oorsprong ervan het laatste item is
de RHS van toewijzing, en er wordt een andere waarde van dat item gebruikt. Secundaire waarden
verschijnen meestal wanneer het resultaat van een functieaanroep in de lokale waarden wordt geplaatst, en slechts enkele daarvan
worden later gebruikt. Hier wordt bijvoorbeeld waarde toegekend aan b is secundair, waarde toegekend aan c is
gebruikt en waarde toegekend a is gewoon ongebruikt:

lokaal a, b, c = f(), g()

terug c

Een variabele is secundair als alle daaraan toegewezen waarden secundair zijn. In het fragment hierboven,
b is een secundaire variabele.

Waarschuwingen met betrekking tot ongebruikte secundaire waarden en variabelen kunnen worden verwijderd met behulp van
-s/--geen-ongebruikte-secundaire bestanden CLI-optie of ongebruikte_secundaires configuratie optie.

schaduwing verklaringen
Luacheck detecteert declaraties van lokale variabelen die eerdere declaraties overschaduwen, tenzij
de variabele heeft een naam _. Indien de vorige aangifte onder hetzelfde toepassingsgebied valt als de nieuwe,
herdefiniëren heet dat.

Merk op dat het is niet nodig om een ​​nieuwe lokale variabele te definiëren bij het overschrijven van een argument:

lokale functie f(x)
lokale x = x of "standaard" -- slecht
einde

lokale functie f(x)
x = x of "standaard" -- goed
einde

Controle stroom en gegevens stroom problemen
De volgende problemen met de besturingsstroom en gegevensstroom worden gedetecteerd:

· Onbereikbare code en lussen die maximaal één keer kunnen worden uitgevoerd (bijvoorbeeld vanwege een
onvoorwaardelijke pauze);

· Ongebruikte etiketten;

· Onevenwichtige opdrachten;

· Lege blokken.

· Lege uitspraken (puntkomma's zonder voorafgaande uitspraken).

COMMAND LINE INTERFACE

luacheck programma accepteert bestanden, mappen en rockspecificaties als argumenten.

· Gegeven een bestand, luacheck zal het controleren.

· Gegeven -, luacheck zal stdin controleren.

· Gegeven een map, luacheck zal alle bestanden daarin controleren en alleen bestanden selecteren met
.maan verlenging tenzij --include-bestanden optie wordt gebruikt. Deze functie vereist
LuaFileSysteem (automatisch geïnstalleerd als LuaRocks werd gebruikt om Luacheck te installeren).

· Gegeven een rockspec (een bestand met .rockspec verlenging), luacheck zal alle bestanden controleren met
.maan extensie genoemd in de rockspec in build.install.lua, build.install.bin en
bouw.modules tabellen.

De uitvoer van luacheck bestaat uit afzonderlijke rapporten voor elk gecontroleerd bestand en eindigt met een
samenvatting:

$ luacheck src
src/bad_code.lua 5 waarschuwingen controleren

src/bad_code.lua:3:16: ongebruikte variabele-helper
src/bad_code.lua:3:23: ongebruikt argument met variabele lengte
src/bad_code.lua:7:10: omarming van niet-standaard globale variabelen instellen
src/bad_code.lua:8:10: variabele opt was eerder gedefinieerd als een argument op regel 7
src/bad_code.lua:9:11: toegang tot ongedefinieerde variabele hepler

src/good_code.lua controleren OK
Controle van src/python_code.lua 1-fout

src/python_code.lua:1:6: verwacht '=' nabij '__future__'

src/unused_code.lua 9-waarschuwingen controleren

src/unused_code.lua:3:18: ongebruikt argument baz
src/unused_code.lua:4:8: ongebruikte lusvariabele i
src/unused_code.lua:5:13: ongebruikte variabele q
src/unused_code.lua:7:11: ongebruikte lusvariabele a
src/unused_code.lua:7:14: ongebruikte lusvariabele b
src/unused_code.lua:7:17: ongebruikte lusvariabele c
src/unused_code.lua:13:7: waarde toegewezen aan variabele x is ongebruikt
src/unused_code.lua:14:1: waarde toegewezen aan variabele x is ongebruikt
src/unused_code.lua:22:1: waarde toegewezen aan variabele z is ongebruikt

Totaal: 14 waarschuwingen / 1 fout in 4 bestanden

luacheck wordt afgesloten met 0 als er geen waarschuwingen of fouten zijn opgetreden en met een positief getal
anders.

commando lijn opties
Korte opties waarvoor geen argument nodig is, kunnen tot één worden gecombineerd, zodat -qqu is
gelijkwaardig -q -q -u. Voor lange opties, beide --optie waarde or --optie=waarde kan zijn
gebruikt.

Opties met meerdere argumenten kunnen meerdere keren worden gebruikt; --negeren foo --negeren bars is
gelijkwaardig --negeren foo bars.

Houd er rekening mee dat opties waaraan meerdere argumenten kunnen voldoen, zoals --mondialen, mag niet worden gebruikt
onmiddellijk vóór positionele argumenten; gegeven --mondialen foo bars bestand.lua, luacheck wil
overweeg alles foo, bars en bestand.lua global en dan in paniek raken omdat er geen bestandsnamen meer zijn.

┌─────────────────────────────────┬─────────────── ───────────────────┐
│Optie │ Betekenis │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-g | --niet-globaal │ Filter waarschuwingen gerelateerd aan │
│ │ globale variabelen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-u | --geen-ongebruikt │ Filter waarschuwingen gerelateerd aan │
│ │ ongebruikte variabelen en waarden. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-r | --niet opnieuw gedefinieerd │ Filter waarschuwingen gerelateerd aan │
│ │ variabelen opnieuw gedefinieerd. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-a | --geen-ongebruikte-args │ Filter waarschuwingen gerelateerd aan │
│ │ ongebruikte argumenten en lus │
│ │ variabelen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-s | --geen-ongebruikte-secundaire bestanden │ Filter waarschuwingen gerelateerd aan │
│ │ ongebruikte variabelen bij elkaar gezet │
│ │ met gebruikte exemplaren. │
│ │
│ │ Zie secundairewaardenenvariabelen │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--geen-zelf │ Filter waarschuwingen gerelateerd aan │
│ │ impliciet zelf argument. │
└─────────────────────────────────┴─────────────── ───────────────────┘

│--soa │ Stel standaard globale waarden in. kan │
│ │ wees een van: │
│ │
│ │ · _G - globalen van de Lua │
│ │ tolk luacheck │
│ │ draait door (standaard); │
│ │
│ │ · lua51 - globalen van Lua │
│ │ 5.1; │
│ │
│ │ · lua52 - globalen van Lua │
│ │ 5.2; │
│ │
│ │ · lua52c - globalen van Lua │
│ │ 5.2 samengesteld met │
│ │ LUA_COMPAT_ALL; │
│ │
│ │ · lua53 - globalen van Lua │
│ │ 5.3; │
│ │
│ │ · lua53c - globalen van Lua │
│ │ 5.3 samengesteld met │
│ │ LUA_COMPAT_5_2; │
│ │
│ │ · luajit - globalen van │
│ │ LuaJIT 2.0; │
│ │
│ │ · ngx_lua - globalen van │
│ │ Open rust │
│ lua-nginx-module met │
│ │ LuaJIT 2.0; │
│ │
│ │ · Min - snijpunt van │
│ │ globalen van Lua 5.1, Lua │
│ │ 5.2 en LuaJIT 2.0; │
│ │
│ │ · max - unie van globalen │
│ │ van Lua 5.1, Lua 5.2 en │
│ │ LuaJIT 2.0; │
│ │
│ │ · busted - globalen toegevoegd │
│ │ door Busted 2.0; │
│ │
│ │ · geen - geen standaard │
│ │ mondiale economieën. │
│ │
│ │ Zie Sets of standaard │
│ globals │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--mondialen [ ] ... │ Voeg aangepaste globale waarden toe bovenop │
│ │ standaard. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--lees-globalen [ ] ... │ Alleen-lezen globale waarden toevoegen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--new-globals [ ] ... │ Aangepaste globale waarden instellen. Verwijdert │
│ │ aangepaste globalen die eerder zijn toegevoegd. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--nieuwe-lees-globalen [ ] │ Alleen-lezen globale waarden instellen. Verwijdert │
│... │ alleen-lezen globals toegevoegd │
│ │ eerder. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-c | --comp │ Gelijk aan --soa max.
└─────────────────────────────────┴─────────────── ───────────────────┘

│-d | --allow-gedefinieerd │ Sta het definiëren van globale waarden toe │
│ │ impliciet door ze in te stellen. │
│ │
│ │ Zie impliciet gedefinieerde globalen │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-t | --allow-gedefinieerd-top │ Sta het definiëren van globale waarden toe │
│ │ impliciet door ze in │ in te stellen
│ │ de reikwijdte op het hoogste niveau. │
│ │
│ │ Zie impliciet gedefinieerde globalen │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-m | --module │ Beperk de zichtbaarheid van impliciet │
│ │ globals gedefinieerd voor hun bestanden. │
│ │
│ │ Zie modules │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--negeren | -i [ ] │ Filter waarschuwingen die overeenkomen met │
│... │ patronen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--inschakelen | -e [ ] │ Filter waarschuwingen niet weg │
│... │ bijpassende patronen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--enkel en alleen | -o [ ] ... │ Filter waarschuwingen die niet overeenkomen │
│ │ patronen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--geen-inline │ Schakel inline-opties uit. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--config │ Pad naar aangepaste configuratie │
│ │ bestand (standaard: .luacheckrc). │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--geen-config │ Zoek geen aangepast │ op
│ │ configuratiebestand. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--bestandsnaam │ Gebruik een andere bestandsnaam in de uitvoer, │
│ │ voor het selecteren van configuratie │
│ │ overschrijvingen en voor bestand │
│ │ filteren. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--exclusief-bestanden [ ] │ Controleer geen bestanden die overeenkomen met │
│... │ deze samenklonterende patronen. │
│ │ Recursieve klodders zoals **/*.lua │
│ │ worden ondersteund. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--include-bestanden [ ] │ Controleer geen bestanden die niet overeenkomen │
│... │ deze samenklonterende patronen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--cache [ ] │ Pad naar cachebestand. (standaard: │
│ .luacheckcache). Zien Caching │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--geen cache │ Gebruik geen cache. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-j | --banen │ Controleer bestanden parallel. │
│ │ Vereist LuaLanes.
└─────────────────────────────────┴─────────────── ───────────────────┘

│--formatter │ Gebruik aangepaste formatter. │
│ moet een module │ zijn
│ │ naam of een van: │
│ │
│ │ · TAP - Test alles │
│ │ Protocolformatter; │
│ │
│ │ · JUnit - JUnit-XML │
│ │ formatter; │
│ │
│ │ · vlakte - eenvoudig │
│ │ waarschuwing per regel │
│ │ formatter; │
│ │
│ │ · verzuim - standaard │
│ │ formatter. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-q | --stil │ Rapportuitvoer voor bestanden onderdrukken │
│ │ zonder waarschuwingen. │
│ │
│ │ · -qq - Uitgang │ onderdrukken
│ │ van waarschuwingen. │
│ │
│ │ · -qqq - Alleen uitgang │
│ │ samenvatting. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--codes │ Toon waarschuwingscodes. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--bereiken │ Toon reeksen gerelateerde kolommen │
│ │ tot waarschuwingen. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│--geen kleur │ Kleur de uitvoer niet in. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-v | --versie │ Toon versie van Luacheck en zijn │
│ │ afhankelijkheden en exit. │
├─────────────────────────────────┼─────────────── ───────────────────┤
│-h | --help │ Toon hulp en sluit af. │
└─────────────────────────────────┴─────────────── ───────────────────┘

Patronen
CLI-opties --negeren, --inschakelen en --enkel en alleen en overeenkomstige configuratieopties maken filteren mogelijk
waarschuwingen met behulp van patroonmatching op waarschuwingscodes, variabelenamen of beide. Als een patroon
bevat een schuine streep, het gedeelte vóór de schuine streep komt overeen met de waarschuwingscode en het gedeelte erna komt overeen
variabele naam. Anders komt het overeen als een patroon een letter of onderstrepingsteken bevat
variabele naam. Anders komt het overeen met de waarschuwingscode. Bijv.:

┌────────┬────────────────────────────── ────┐
│Patroon │ Bijpassende waarschuwingen │
├────────┼────────────────────────────── ────┤
│4.2 │ Schaduwverklaringen van │
│ │ argumenten of het herdefiniëren ervan. │
├────────┼────────────────────────────── ────┤
│.*_ │ Waarschuwingen met betrekking tot variabelen │
│ │ met _ achtervoegsel. │
├────────┼────────────────────────────── ────┤
│4.2/.*_ │ Schaduwverklaringen van │
│ │ argumenten met _ achtervoegsel of │
│ │ ze opnieuw definiëren. │
└────────┴────────────────────────────── ────┘

Tenzij ze al zijn verankerd, worden patronen die overeenkomen met de namen van variabelen aan beide zijden verankerd
patronen die overeenkomen met waarschuwingscodes zijn aan het begin verankerd. Dit maakt het mogelijk
filter waarschuwingen op categorie (bijv --enkel en alleen 1 richt luacheck over mondiale waarschuwingen).

Sets of standaard globals
CLI-optie --standaarden maakt het mogelijk om de hierboven beschreven ingebouwde sets te combineren met behulp van +. Bijvoorbeeld,
--soa max is gelijk aan --std=lua51+lua52+lua53. Het leidende plusteken voegt nieuwe sets toe
standaard één in plaats van deze te vervangen. Bijvoorbeeld, --soa +opgepakt is geschikt voor controle
testbestanden die gebruiken Busted toetsingskader. Aangepaste sets globale waarden kunnen worden gedefinieerd door
muterende globale variabele standaard in configuratie. Zie custom_stds

formatters
CLI-optie --formatter maakt het mogelijk een aangepaste formatter te selecteren voor luacheck uitgang. Een gewoonte
formatter is een Lua-module die een functie retourneert met drie argumenten: rapporteer zoals geretourneerd door
luacheck module (zie rapport), reeks bestandsnamen en tabel met opties. Opties bevatten
waarden toegewezen rustig, kleur, begrenzing, codes, ranges en formaat opties in CLI of
configuratie. De formatterfunctie moet een tekenreeks retourneren.

Caching
Als LuaFileSystem beschikbaar is, kan Luacheck de resultaten van het controleren van bestanden in de cache opslaan. Op volgende
controles worden alleen bestanden die sinds de laatste controle zijn gewijzigd, opnieuw gecontroleerd en verbeterd
looptijd aanzienlijk. Het wijzigen van opties (bijvoorbeeld het definiëren van extra globale waarden) geldt niet
cache ongeldig maken. Caching kan worden ingeschakeld met behulp van --cache optie of cache config
optie. Gebruik makend van --cache zonder argument of setting cache configuratieoptie aan waar sets
.luacheckcache als het cachebestand. Let daar op --cache moet elke keer gebruikt worden luacheck is
rennen, niet alleen tijdens de eerste run.

Stal interface For editor plugins en tools
De opdrachtregelinterface van Luacheck kan tussen kleine releases veranderen. Vanaf 0.11.0
versie, de volgende interface is gegarandeerd ten minste tot versie 1.0.0, en zou dat ook moeten zijn
gebruikt door tools die Luacheck-uitvoer gebruiken, bijv. Editor-plug-ins.

· Luacheck moet worden gestart vanuit de map die het gecontroleerde bestand bevat.

· Bestand kan via stdin worden doorgegeven met behulp van - als argument of met behulp van een tijdelijk bestand. Echt
bestandsnaam moet worden doorgegeven met behulp van --bestandsnaam optie.

· Er moet een gewone formatter worden gebruikt. Er wordt één probleem (waarschuwing of fout) per regel weergegeven.

· Om de exacte foutlocatie te verkrijgen, --bereiken optie kan worden gebruikt. Elke regel begint met echt
bestandsnaam (doorgegeven met --bestandsnaam), gevolgd door : : - :,
WAAR is het regelnummer waarop het probleem zich voordeed en - is
inclusief bereik van kolommen met token gerelateerd aan het probleem. De nummering begint vanaf 1. Als
--bereiken wordt niet gebruikt, de eindkolom en het streepje worden niet afgedrukt.

· Om waarschuwings- en foutcodes te krijgen, --codes optie kan worden gebruikt. Voor elke regel een subtekenreeks
tussen haakjes bevat een driecijferige uitgiftecode, voorafgegaan door E voor fouten en W
voor waarschuwingen. Het ontbreken van een dergelijke substring duidt op een fatale fout (bijvoorbeeld een I/O-fout).

· De rest van de regel is een waarschuwingsbericht.

Als compatibiliteit met een oudere Luacheck-versie gewenst is, wordt de uitvoer van luacheck --help kan zijn
gebruikt om zijn versie te krijgen. Als het een tekenreeks bevat 0. ., Waar is bij
minimaal 11 en stuk is een willekeurig getal, dan moet de hierboven beschreven interface worden gebruikt.

CONFIGURATIE FILE

luacheck probeert de configuratie te laden .luacheckrc bestand in de huidige map. Als
niet gevonden, zal het ernaar zoeken in de bovenliggende map, enzovoort, totdat het gevonden wordt
bereikt de root van het bestandssysteem. Pad naar configuratie kan worden ingesteld met behulp van --config optie, in welk geval
het zal worden gebruikt tijdens recursief laden. Het laden van configuraties kan worden uitgeschakeld met behulp van --geen-config
vlag.

Config is eenvoudigweg een Lua-script dat wordt uitgevoerd door luacheck. Het kan verschillende opties instellen
toewijzen aan globale waarden of door een tabel terug te geven met optienamen als sleutels.

Config opties
┌───────────────────┬─────────────────── ───────┬── ───────────────────┐
│Optie │ Type │ Standaardwaarde │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│kleur │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│codes │ Booleaanse waarde │ vals │
└───────────────────┴─────────────────── ───────┴── ───────────────────┘

│formaat │ String of functie │ "standaard" │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│cache │ Booleaanse waarde of tekenreeks │ vals │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│vacatures │ Positief geheel getal │ 1 │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│sluit_bestanden uit │ Reeks tekenreeksen │ {} │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│inclusief_bestanden │ Array van tekenreeksen │ (inclusief alle bestanden) │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│globaal │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│ongebruikt │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│geherdefinieerd │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│ongebruikte_args │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│ongebruikte_secundaires │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│zelf │ Booleaanse waarde │ waar │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│soa │ String of set van │ "_G" │
│ │ standaard globale cijfers │ │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│globals │ Reeks tekenreeksen │ {} │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│nieuwe_globals │ Reeks strings │ (niet overschrijven) │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│lees_globalen │ Reeks tekenreeksen │ {} │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│new_read_globals │ Reeks strings │ (niet overschrijven) │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│compat │ Booleaanse waarde │ vals │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│toestaan_gedefinieerd │ Booleaanse waarde │ vals │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│allow_gedefinieerde_top │ Booleaanse waarde │ vals │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│module │ Booleaanse waarde │ vals │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│negeren │ Reeks patronen (zie │ {} │
│ │ patronen) │ │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│in staat stellen │ Reeks patronen │ {} │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│Slechts │ Reeks patronen │ (niet filteren) │
├───────────────────┼─────────────────── ───────┼── ───────────────────┤
│inline │ Booleaanse waarde │ waar │
└───────────────────┴─────────────────── ───────┴── ───────────────────┘

Een voorbeeld van een configuratie die maakt luacheck ervoor zorgen dat alleen globals van de draagbare
kruising van Lua 5.1, Lua 5.2, Lua 5.3 en LuaJIT 2.0 worden gebruikt, evenals uitgeschakeld
detectie van ongebruikte argumenten:

standaard = "min"
negeren = {"212"}

Eigen sets of globals
soa Met deze optie kunt u een aangepaste standaardset globale waarden instellen met behulp van een tabel. In die tabel,
tekenreekssleutels zijn globale waarden, en tekenreeksen in het arraygedeelte zijn alleen-lezen globale waarden.

Bovendien kunnen aangepaste sets een naam krijgen door global te muteren standaard variabel. Voor
bijvoorbeeld bij gebruik LPEG bibliotheek, is het zinvol om kort toegang te krijgen tot de functies ervan
globalen. In dat geval maakt de volgende configuratie het verwijderen van valse positieven gerelateerd aan
wereldwijde toegang gemakkelijk:

stds.lpeg = vereist "lpeg"

lokale lpeg = vereist "lpeg"

lokale functie parse1(...)
-- Deze functie gebruikt alleen lpeg-functies als globale waarden.
lokale _ENV = lpeg
-- luacheck: std-lpeg
lokaal cijfer, spatie = R "09", S " "
--...
einde

lokale functie parse2(...)
-- Deze functie gebruikt zowel lpeg-functies als standaard globale waarden.
local _ENV = setmetatable({}, {__index = function(_, k) return _ENV[k] of lpeg[k] end})
-- luacheck: std + lpeg
lokaal cijfer, spatie = R "09", S " "
lokaal nummer = C(cijfer^1) /naargetal
--...
einde

Per bestand en per pad overschrijvingen
De omgeving waarin luacheck laadt de configuratie bevat een speciale global bestanden. Wanneer
een bestand controleren , luacheck zal de opties uit de hoofdconfiguratie met vermeldingen overschrijven
oppompen van bestanden[ ] en bestanden[ ], waarbij eerst vermeldingen voor kortere paden worden toegepast. Voor
De volgende configuratie schakelt bijvoorbeeld de detectie van ongebruikte argumenten opnieuw in, alleen voor bestanden in
src/dir, maar niet voor src/dir/mijnbestand.luaen maakt gebruik mogelijk Busted globalen binnen spec /:

standaard = "min"
negeren = {"212"}
files["src/dir"] = {inschakelen = {"212"}}
files["src/dir/mijnbestand.lua"] = {ignore = {"212"}}
files["spec"] = {std = "+busted"}

Merk op dat bestanden tafel ondersteunt autovivificatie, zodat

files["mijnbestand.lua"].ignore = {"212"}

en

files["mijnbestand.lua"] = {negeren = {"212"}}

zijn gelijkwaardig.

IN LIJN OPTIES

Luacheck ondersteunt het instellen van sommige opties rechtstreeks in de gecontroleerde bestanden met behulp van inline
configuratie opmerkingen. Een inline configuratieopmerking begint met luacheck: etiket,
eventueel na wat witruimte. De hoofdtekst van de opmerking moet door komma's gescheiden zijn
opties, waarbij het aanroepen van opties bestaat uit de naam plus door spaties gescheiden argumenten. De
volgende opties worden ondersteund:

┌───────────────────┬─────────────────── ────────── ─────┐
│Optie │ Aantal argumenten │
├───────────────────┼─────────────────── ────────── ─────┤
│mondiaal │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│ongebruikt │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│opnieuw gedefinieerd │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│ongebruikte argumenten │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│ongebruikte secundaire │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│zelf │ 0 │
└───────────────────┴─────────────────── ────────── ─────┘

│compatibel │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│module │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│toestaan ​​gedefinieerd │ 0 │
├───────────────────┼─────────────────── ────────── ─────┤
│gedefinieerde top │ 0 │ toestaan
├───────────────────┼─────────────────── ────────── ─────┤
│standaard │ 1 │
├───────────────────┼─────────────────── ────────── ─────┤
│mondialen │ 0+ │
├───────────────────┼─────────────────── ────────── ─────┤
│nieuwe globalen │ 0+ │
├───────────────────┼─────────────────── ────────── ─────┤
│lees globale cijfers │ 0+ │
├───────────────────┼─────────────────── ────────── ─────┤
│nieuw lees globals │ 0+ │
├───────────────────┼─────────────────── ────────── ─────┤
│negeren │ 0+ (zonder argumenten alles │
│ │ wordt genegeerd) │
├───────────────────┼─────────────────── ────────── ─────┤
│inschakelen │ 1+ │
├───────────────────┼─────────────────── ────────── ─────┤
│slechts │ 1+ │
└───────────────────┴─────────────────── ────────── ─────┘

Opties waarvoor geen argumenten nodig zijn, kunnen worden voorafgegaan door geen om hun betekenis om te keren. Bijv
--luacheck: geen ongebruikt betoogt schakelt ongebruikte argumentwaarschuwingen uit.

Een deel van het bestand dat door de inline-optie wordt beïnvloed, is afhankelijk van waar het is geplaatst. Als er iets is
code op de regel met de optie, alleen die regel wordt beïnvloed; anders, alles tot
het einde van de huidige sluiting is. Met name inline-opties bovenaan het bestand
beïnvloeden het allemaal:

-- luacheck: globals g1 g2, negeer foo
local foo = g1(g2) -- Er zijn geen waarschuwingen afgegeven.

-- De volgende ongebruikte functie wordt niet gerapporteerd.
lokale functie f() -- luacheck: negeren
-- luacheck: globale g3
g3() -- Geen waarschuwing.
einde

g3() -- Er wordt een waarschuwing afgegeven omdat de inline-optie die g3 definieert alleen de functie f beïnvloedt.

Gebruik voor fijnmazige controle over de zichtbaarheid van inline-opties luacheck: duwen en luacheck:
knal richtlijnen:

-- luacheck: druk op negeer foo
foo() -- Geen waarschuwing.
-- luacheck: pop
foo() -- Er wordt een waarschuwing afgegeven.

Inline-opties kunnen volledig worden uitgeschakeld met behulp van --geen-inline CLI-optie of inline config
optie.

LUACHECK MODULE

Te gebruiken lokaal luacheck = vereisen "luacheck" importeren luacheck module. Het bevat de
volgende functies:

· luacheck.get_report(bron): Gegeven bronreeks, retourneert analysegegevens (een tabel).

· luacheck.process_reports(rapporten, opties): Verwerkt een reeks analyserapporten en
past opties toe. rapporten[ik] toepassingen opties, opties[ik], opties[i][1], opties[i][2], ...
als opties, die elkaar in die volgorde overschrijven. Optiestabel is een tabel met velden
vergelijkbaar met configuratie-opties; zie opties. Analyserapporten met veld fataal worden genegeerd.
proces_rapporten retourneert eindrapport, zie Rapport formaat.

· luacheck.check_strings(bronnen, opties): Controleert een reeks bronnen met behulp van opties, retourneert
laatste rapport. Tabellen met veld fataal binnen bronnen array worden genegeerd.

· luacheck.check_files(bestanden, opties): Controleert een reeks bestanden met behulp van opties, retourneert definitief
rapport. Open bestandshandles kunnen worden doorgegeven in plaats van bestandsnamen, in welk geval dit het geval zal zijn
gelezen tot EOF en gesloten.

· luacheck.get_message(probleem): Retourneert een stringbericht voor een probleem, zie Rapport formaat.

luacheck._VERSIE bevat de Luacheck-versie als string in GROTE.MINEUR.PATCH formaat.

gebruik luacheck als functie is gelijk aan bellen luacheck.check_files.

Rapport formaat
Een eindrapport is een reeks bestandsrapporten plus velden waarschuwingen, fouten en dodelijk
met daarin het totale aantal waarschuwingen, fouten en fatale fouten.

Een bestandsrapport bestaat uit een reeks problemen (waarschuwingen of fouten). Als er een fatale fout is opgetreden tijdens
het controleren van een bestand, zal het rapport zijn fataal veld met het fouttype.

Een probleem is een tabel met veld code met vermelding van het type (zie waarschuwingen), en velden lijn,
kolom en eind_kolom wijzend naar de bron van de waarschuwing. naam veld kan naam bevatten
van de gerelateerde variabele. Sommige typen problemen kunnen ook extra velden bevatten:

┌──────┬───────────────────────────────────────────────────
│Codes │ Extra velden │
├──────┼───────────────────────────────────────────────────
│011 │ msg veld bevat syntaxisfout │
│ │ bericht. │
├──────┼───────────────────────────────────────────────────
│111 │ module veld geeft aan dat │
│ │ opdracht is voor een niet-module │
│ │ globale variabele. │
├──────┼───────────────────────────────────────────────────
│211 │ func veld geeft aan dat ongebruikte │
│ │ variabele is een functie. │
├──────┼───────────────────────────────────────────────────
│4.. │ vorige_regel en vorige_kolom velden │
│ │ bevatten de locatie van de │
│ │ definitie overschreven. │
└──────┴───────────────────────────────────────────────────

Om interne redenen kunnen er andere velden aanwezig zijn.

Dit is documentatie voor versie 0.13.0 van Luacheck, een linter voor Lua.

Gebruik luacheck online met behulp van onworks.net-services