luacheck - Bulutta Çevrimiçi

Program:

ADI

luacheck - luacheck Belgeleri

İçindekiler:

LİSTESİ OF UYARILAR

Luacheck tarafından üretilen uyarılar, üç haneli uyarı kodları kullanılarak kategorilere ayrılır. Uyarı
kodlar kullanılarak CLI çıktısında görüntülenebilir --kodlar CLI seçeneği veya kodları yapılandırma seçeneği.
Hataların da sıfırla başlayan kodları vardır.

┌─────┬──────────────────────────────┐
│Kod │ Açıklama │
├─────┼──────────────────────────────┤
│011 │ Bir sözdizimi hatası. │
├─────┼──────────────────────────────┤
│021 │ Geçersiz bir satır içi seçenek. │
├─────┼──────────────────────────────┤
│022 │ Yükseltilmiş bir satır içi itme │
│ │ direktif. │
├─────┼──────────────────────────────┤
│023 │ Yükseltilmiş bir satır içi pop yönergesi. │
├─────┼──────────────────────────────┤
│111 │ Tanımsız bir global ayarlama │
│ │ değişken. │
├─────┼──────────────────────────────┤
│112 │ Tanımsız bir globali mutasyona uğratmak │
│ │ değişken. │
├─────┼──────────────────────────────┤
│113 │ Tanımsız bir genele erişim │
│ │ değişken. │
├─────┼──────────────────────────────┤
│121 │ Salt okunur bir global ayarlama │
│ │ değişken. │
├─────┼──────────────────────────────┤
│122 │ Salt okunur bir global mutasyona uğratma │
│ │ değişken. │
├─────┼──────────────────────────────┤
│131 │ Kullanılmayan, örtük olarak tanımlanmış global │
│ │ değişken. │
├─────┼──────────────────────────────┤
│211 │ Kullanılmayan yerel değişken. │
├─────┼──────────────────────────────┤
│212 │ Kullanılmayan argüman. │
├─────┼──────────────────────────────┤
│213 │ Kullanılmayan döngü değişkeni. │
├─────┼──────────────────────────────┤
│221 │ Yerel değişkene erişilir ancak │
│ │ asla ayarlanmaz. │
├─────┼──────────────────────────────┤
│231 │ Yerel değişken ayarlandı ama asla │
│ │ erişildi. │
├─────┼──────────────────────────────┤
│232 │ Bir argüman belirlenir ama asla │
│ │ erişildi. │
├─────┼──────────────────────────────┤
│233 │ Döngü değişkeni ayarlandı ancak hiçbir zaman │
│ │ erişildi. │
├─────┼──────────────────────────────┤
│311 │ Bir yerele atanan değer │
│ │ değişkeni kullanılmamaktadır. │
└─────┴──────────────────────────────┘

│312 │ Bir argümanın değeri kullanılmıyor. │
├─────┼──────────────────────────────┤
│313 │ Döngü değişkeninin değeri │
│ │ kullanılmamış. │
├─────┼──────────────────────────────┤
│321 │ Başlatılmamış yerel erişim │
│ │ değişken. │
├─────┼──────────────────────────────┤
│411 │ Yerel bir değişkeni yeniden tanımlama. │
├─────┼──────────────────────────────┤
│412 │ Bir argümanı yeniden tanımlama. │
├─────┼──────────────────────────────┤
│413 │ Bir döngü değişkenini yeniden tanımlama. │
├─────┼──────────────────────────────┤
│421 │ Yerel bir değişkeni gölgeleme. │
├─────┼──────────────────────────────┤
=422 = Bir argümanı gölgeleme. │
├─────┼──────────────────────────────┤
=423 = Bir döngü değişkenini gölgeleme. │
├─────┼──────────────────────────────┤
│431 │ Yükselen bir değeri gölgeliyor. │
├─────┼──────────────────────────────┤
=432 = Artan değer argümanını gölgeleme. │
├─────┼──────────────────────────────┤
│433 │ Artan değer döngüsünü gölgeleme │
│ │ değişken. │
├─────┼──────────────────────────────┤
│511 │ Ulaşılamaz kod. │
├─────┼──────────────────────────────┤
│512 │ Döngü en fazla çalıştırılabilir │
│ │ bir kez. │
├─────┼──────────────────────────────┤
│521 │ Kullanılmayan etiket. │
├─────┼──────────────────────────────┤
│531 │ Bir atamanın sol tarafı │
│ │ çok kısa. │
├─────┼──────────────────────────────┤
│532 │ Bir atamanın sol tarafı │
│ │ çok uzun. │
├─────┼──────────────────────────────┤
│541 │ Boş do son engellemek. │
├─────┼──────────────────────────────┤
│542 │ Boş if dal. │
├─────┼──────────────────────────────┤
│551 │ Boş bir ifade. │
└─────┴──────────────────────────────┘

Küresel değişkenler
Her dosya için Luacheck, orada kullanılabilecek tanımlanmış globallerin listesini oluşturur. Varsayılan olarak
yalnızca Lua standart kitaplığındaki globaller tanımlanır; özel globaller kullanılarak eklenebilir
--küresel CLI seçeneği veya globaller yapılandırma seçeneği ve standart kitaplığın sürümü olabilir
kullanılarak seçildi --std CLI seçeneği veya std yapılandırma seçeneği. Tanımsız bir global ayarlandığında,
mutasyona uğramış veya erişilmişse, Luacheck bir uyarı üretir.

Salt okunur globaller
Varsayılan olarak, hariç tüm standart globaller _G ve paket salt okunur olarak işaretlenir, böylece
onları ayarlamak veya mutasyona uğratmak bir uyarı verir. Özel salt okunur globaller kullanılarak eklenebilir
--okuma-küresel CLI seçeneği veya global_oku yapılandırma seçeneği.

dolaylı olarak tanımlı globaller
Luacheck, bazı koşullar altında atanan globalleri dikkate alacak şekilde yapılandırılabilir.
dolaylı olarak tanımlanmıştır. Ne zaman -d/--allow_tanımlanmış CLI seçeneği veya izin_tanımlı yapılandırma seçeneği
kullanıldığında, globallere yapılan tüm atamalar onları tanımlar; ne zaman -t/--allow_tanımlanmış_top CLI seçeneği veya
izin_tanımlanmış_top config seçeneği kullanılır, üst düzey fonksiyonda globallere atamalar
kapsam (ana yığın olarak da bilinir) bunları tanımlar. örtük olarak bir uyarı üretilir
tanımlı global hiçbir yere erişilmez.

Modüller
Dosyalar kullanılarak modüller olarak işaretlenebilir -m/--modül CLI seçeneği veya modül yapılandırma seçeneği
kullanımdan kaldırılanların anlambilimini simüle et modül işlev. Küreseller bir içinde örtük olarak tanımlanmış
modül arayüzünün bir parçasıdır, dışarıdan görünmez ve rapor edilmez.
kullanılmamış olarak Tanımlanmış olanlar da dahil olmak üzere diğer globallere atamalara izin verilmez.

kullanılmamış değişkenler ve değerlerimiz
Luacheck, adlandırılmış biri hariç tüm kullanılmayan yerel değişkenler için uyarılar üretir. _. Ayrıca,
ayarlanmış ancak hiçbir zaman erişilmeyen veya erişilen ancak hiçbir zaman ayarlanmayan değişkenleri algılar.

kullanılmamış değerlerimiz ve başlatılmamış değişkenler
Yerel bir değişkene atanan her bir değer için, Luacheck, bulunduğu yerde ifadeler kümesini hesaplar.
kullanılabilir. Kullanılmayan değerler için uyarılar üretilir (bir değer kullanılamadığında
herhangi bir yerde) ve başlatılmamış değişkenlere erişmek için (hiçbir değer bir
ifade). Örneğin, aşağıdaki kod parçasına atanan değerde foo 1. satırda kullanılmamış ve
değişken bar 9. satırda başlatılmamış:

yerel foo = ifade1()
yerel bar

eğer koşul() o zaman
foo = ifade2()
çubuk = ifade3()
başka
foo = ifade4()
yazdır(çubuk)
son

dönüş foo, bar

ikincil değerlerimiz ve değişkenler
Bir yerel değişkene atanan kullanılmayan değer, kaynağı üzerindeki son öğeyse ikincildir.
atamanın RHS'si ve bu öğeden başka bir değer kullanılır. ikincil değerler
tipik olarak, bir işlev çağrısının sonucu yerellere konulduğunda görünür ve yalnızca bazıları
daha sonra kullanılır. Örneğin, burada atanan değer b ikincildir, değer atanır c is
kullanılan ve atanan değer a basitçe kullanılmaz:

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

dönüş c

Bir değişken, kendisine atanan tüm değerler ikincil ise ikincildir. Yukarıdaki parçada,
b ikincil bir değişkendir.

Kullanılmayan ikincil değerler ve değişkenlerle ilgili uyarılar kullanılarak kaldırılabilir.
-s/--kullanılmayan-ikinciller CLI seçeneği veya kullanılmayan_ikinciller yapılandırma seçeneği.

Gölgeleme bildirimleri
Luacheck, önceki bildirimleri gölgeleyen yerel değişkenlerin bildirimlerini algılar.
değişken adlandırılmış _. Önceki beyanname yenisi ile aynı kapsamda ise,
yeniden tanımlama denir.

olduğunu unutmayın değil bir argümanın üzerine yazarken yeni bir yerel değişken tanımlamak için gereklidir:

yerel fonksiyon f(x)
yerel x = x veya "varsayılan" -- kötü
son

yerel fonksiyon f(x)
x = x veya "varsayılan" -- iyi
son

Control akış ve veri akış sorunlar
Aşağıdaki kontrol akışı ve veri akışı sorunları algılandı:

· En fazla bir kere çalıştırılabilen erişilemeyen kod ve döngüler (örn.
koşulsuz mola);

· Kullanılmayan etiketler;

· Dengesiz atamalar;

· Boş bloklar.

· Boş ifadeler (önceki ifadeler olmadan noktalı virgüller).

KOMUT LINE ARA

luaçek program dosyaları, dizinleri ve kaya özellikleri argümanlar olarak.

· Bir dosya verildi, luaçek kontrol edecek.

· Verilen -, luaçek stdin'i kontrol edecek.

· Bir dizin verildi, luaçek içindeki tüm dosyaları kontrol edecek, yalnızca
.lua sürece uzatma --include-dosyaları seçeneği kullanılır. Bu özellik gerektirir
LuaDosya Sistemi (Luacheck'i kurmak için LuaRocks kullanılmışsa otomatik olarak yüklenir).

· Bir rockspec verildi (bir dosya .rockspec uzantı), luaçek ile tüm dosyaları kontrol edecek
.lua rockspec'te belirtilen uzantı build.install.lua, build.install.bin ve
build.modüller tablolar.

Çıktısı luaçek kontrol edilen her dosya için ayrı raporlardan oluşur ve bir ile biter
özet:

$ luacheck kaynağı
src/bad_code.lua 5 uyarısı kontrol ediliyor

src/bad_code.lua:3:16: kullanılmayan değişken yardımcısı
src/bad_code.lua:3:23: kullanılmayan değişken uzunluk argümanı
src/bad_code.lua:7:10: standart olmayan global değişken kucaklama ayarı
src/bad_code.lua:8:10: opt değişkeni daha önce 7. satırda bir argüman olarak tanımlanmıştı
src/bad_code.lua:9:11: tanımsız değişken hepler'e erişim

src/good_code.lua kontrol ediliyor Tamam
src/python_code.lua 1 hatası kontrol ediliyor

src/python_code.lua:1:6: '__future__' yakınında '=' bekleniyor

src/unused_code.lua 9 uyarıları kontrol ediliyor

src/unused_code.lua:3:18: kullanılmayan argüman baz
src/unused_code.lua:4:8: kullanılmayan döngü değişkeni i
src/unused_code.lua:5:13: kullanılmayan değişken q
src/unused_code.lua:7:11: kullanılmayan döngü değişkeni a
src/unused_code.lua:7:14: kullanılmayan döngü değişkeni b
src/unused_code.lua:7:17: kullanılmayan döngü değişkeni c
src/unused_code.lua:13:7: x değişkenine atanan değer kullanılmıyor
src/unused_code.lua:14:1: x değişkenine atanan değer kullanılmıyor
src/unused_code.lua:22:1: z değişkenine atanan değer kullanılmıyor

Toplam: 14 dosyada 1 uyarı / 4 hata

luaçek herhangi bir uyarı veya hata oluşmadıysa ve pozitif bir sayı ile 0 ile çıkar
aksi takdirde.

Komuta hat seçenekleri
Argüman almayan kısa seçenekler tek bir seçenekte birleştirilebilir, böylece -qqu is
eşdeğerdir -q -q -u. Uzun seçenekler için hem --seçenek değer or --seçenek=değer olabilir
Kullanılmış.

Birkaç argüman alan seçenekler birkaç kez kullanılabilir; --görmezden gelmek foo --görmezden gelmek bar is
eşdeğerdir --görmezden gelmek foo bar.

Gibi çeşitli argümanlar alabilen seçeneklerin olduğunu unutmayın. --küresel, kullanılmamalı
konumsal argümanlardan hemen önce; verilen --küresel foo bar dosya.lua, luaçek irade
hepsini düşün foo, bar ve dosya.lua global ve ardından hiçbir dosya adı kalmadığından panik yapın.

┌──────────────────────────────────────────── ──────────────────┐
│Seçenek │ Anlamı │
├──────────────────────────────────────────── ──────────────────┤
│-g | -- küresel olmayan │ │ ile ilgili uyarıları filtreleyin
│ │ global değişkenler. │
├──────────────────────────────────────────── ──────────────────┤
│-u | --kullanılmamış │ │ ile ilgili uyarıları filtreleyin
│ │ kullanılmayan değişkenler ve değerler. │
├──────────────────────────────────────────── ──────────────────┤
│-r | --no-yeniden tanımlanmadı │ │ ile ilgili uyarıları filtreleyin
│ │ yeniden tanımlanmış değişkenler. │
├──────────────────────────────────────────── ──────────────────┤
│-a | --no-kullanılmayan-arg'lar │ │ ile ilgili uyarıları filtreleyin
│ │ kullanılmayan argümanlar ve döngü │
│ │ değişkenler. │
├──────────────────────────────────────────── ──────────────────┤
│-s | --kullanılmayan-ikinciller │ │ ile ilgili uyarıları filtreleyin
│ │ kullanılmayan değişkenler bir araya getirilir │
│ │ kullanılmış olanlar ile. │
│ │ │
│ │ İkincil değerlere ve değişkenlere bakın │
├──────────────────────────────────────────── ──────────────────┤
│--hayır-öz │ │ ile ilgili uyarıları filtreleyin
│ │ örtük öz argüman. │
└──────────────────────────────────────────── ──────────────────┘

│--std │ Standart globalleri ayarlayın. olabilir │
│ │ şunlardan biri olmak: │
│ │ │
│ │ · _G - Lua'nın küreselleri │
│ │ tercüman luaçek │
│ │ çalışır (varsayılan); │
│ │ │
│ │ · lua51 - Lua'nın küreselleri │
│ │ 5.1; │
│ │ │
│ │ · lua52 - Lua'nın küreselleri │
│ │ 5.2; │
│ │ │
│ │ · lua52c - Lua'nın küreselleri │
│ │ 5.2 │ ile derlendi
│ │ LUA_COMPAT_ALL; │
│ │ │
│ │ · lua53 - Lua'nın küreselleri │
│ │ 5.3; │
│ │ │
│ │ · lua53c - Lua'nın küreselleri │
│ │ 5.3 │ ile derlendi
│ │ LUA_COMPAT_5_2; │
│ │ │
│ │ · lujit - │'nin küreselleri
│ │ LuaJIT 2.0; │
│ │ │
│ │ · ngx_lua - │'nin küreselleri
│ │ Açıklık │
│ │ lua-nginx-modülü │ ile
│ │ LuaJIT 2.0; │
│ │ │
│ │ · dk - │ kesişimi
│ │ Lua 5.1, Lua'nın küreselleri │
│ │ 5.2 ve LuaJIT 2.0; │
│ │ │
│ │ · maksimum - küresellerin birliği │
│ │ Lua 5.1, Lua 5.2 ve │
│ │ LuaJIT 2.0; │
│ │ │
│ │ · baskın - küreseller eklendi │
│ │ Busted 2.0 tarafından; │
│ │ │
│ │ · Yok - standart yok │
│ │ küreseller. │
│ │ │
│ │ Bkz. Setler of standart │
│ │ globaller │
├──────────────────────────────────────────── ──────────────────┤
│--küresel [ ] Kendi ID’n ile mağazalarını oluştur │ Üzerine özel küreseller ekleyin │
│ │ standart olanlar. │
├──────────────────────────────────────────── ──────────────────┤
│--okuma-küresel [ ] Kendi ID’n ile mağazalarını oluştur │ Salt okunur globaller ekleyin. │
├──────────────────────────────────────────── ──────────────────┤
│--yeni-küreseller [ ] Kendi ID’n ile mağazalarını oluştur │ Özel küreselleri ayarlayın. │ kaldırır
│ │ daha önce eklenen özel küreseller. │
├──────────────────────────────────────────── ──────────────────┤
│--yeni-okunan-globals [ ] │ Salt okunur globalleri ayarlayın. │ kaldırır
│Kendi ID’n ile mağazalarını oluştur │ salt okunur globaller eklendi │
│ │ daha önce. │
├──────────────────────────────────────────── ──────────────────┤
│-c | --uyum │ eşdeğer --std maksimum. │
└──────────────────────────────────────────── ──────────────────┘

│-d | --izin verilen tanımlı │ Globalleri tanımlamaya izin ver │
│ │ örtük olarak ayarlayarak. │
│ │ │
│ │ örtük olarak tanımlanmış küresellere bakın │
├──────────────────────────────────────────── ──────────────────┤
│-t | --allow-tanımlı-üst │ Globalleri tanımlamaya izin ver │
│ │ örtük olarak onları │ içinde ayarlayarak
│ │ üst düzey kapsam. │
│ │ │
│ │ örtük olarak tanımlanmış küresellere bakın │
├──────────────────────────────────────────── ──────────────────┤
│-m | --modül │ Görünürlüğü dolaylı olarak sınırlayın │
│ │ dosyalarına tanımlı globaller. │
│ │ │
│ │ Modüllere bakın │
├──────────────────────────────────────────── ──────────────────┤
│--görmezden gelmek | -i [ ] │ Eşleşen uyarıları filtreleyin │
│Kendi ID’n ile mağazalarını oluştur │ desenler. │
├──────────────────────────────────────────── ──────────────────┤
│--etkinleştirme | -e [ ] │ Uyarıları filtrelemeyin │
│Kendi ID’n ile mağazalarını oluştur │ eşleşen desenler. │
├──────────────────────────────────────────── ──────────────────┤
│--bir tek | -o [ ] Kendi ID’n ile mağazalarını oluştur │ Eşleşmeyen uyarıları filtreleyin │
│ │ desenler. │
├──────────────────────────────────────────── ──────────────────┤
│-- satır içi yok │ Satır içi seçenekleri devre dışı bırakın. │
├──────────────────────────────────────────── ──────────────────┤
│--yapılandırma │ Özel yapılandırmaya giden yol │
│ │ dosyası (varsayılan: .luacheckrc). │
├──────────────────────────────────────────── ──────────────────┤
│--yapılandırma yok │ Özel arama yapmayın │
│ │ yapılandırma dosyası. │
├──────────────────────────────────────────── ──────────────────┤
│--dosya adı │ Çıktıda başka bir dosya adı kullanın, │
│ │ konfigürasyonu seçmek için │
│ │ geçersiz kılar ve dosya için │
│ │ filtreleme. │
├──────────────────────────────────────────── ──────────────────┤
│--hariç tutulan-dosyalar [ ] │ Eşleşen dosyaları kontrol etmeyin │
│Kendi ID’n ile mağazalarını oluştur │ bu küresel kalıplar. │
│ │ Özyinelemeli globlar, örneğin **/*.lua │
│ │ desteklenir. │
├──────────────────────────────────────────── ──────────────────┤
│--include-dosyaları [ ] │ Eşleşmeyen dosyaları kontrol etmeyin │
│Kendi ID’n ile mağazalarını oluştur │ bu küresel kalıplar. │
├──────────────────────────────────────────── ──────────────────┤
│--önbellek [ ] │ Dosyayı önbelleğe alma yolu. (varsayılan: │
│ │ .luacheckcache). Görmek önbelleğe alma │
├──────────────────────────────────────────── ──────────────────┤
│--önbellek yok │ Önbellek kullanmayın. │
├──────────────────────────────────────────── ──────────────────┤
│-j | --Meslekler │ Kontrol et dosyalar paralel. │
│ │ Gerektirir LuaLanes. │
└──────────────────────────────────────────── ──────────────────┘

│-- biçimlendirici │ Özel biçimlendirici kullanın. │
│ │ bir modül olmalı │
│ │ ad veya şunlardan biri: │
│ │ │
│ │ · TAP - Her Şeyi Test Edin │
│ │ Protokol biçimlendirici; │
│ │ │
│ │ · JUnit - JUnit XML'i │
│ │ biçimlendirici; │
│ │ │
│ │ · sade - basit │
│ │ hat başına uyarı │
│ │ biçimlendirici; │
│ │ │
│ │ · varsayılan - standart │
│ │ biçimlendirici. │
├──────────────────────────────────────────── ──────────────────┤
│-q | --sessizlik │ Dosyalar için rapor çıktısını gizle │
│ │ uyarılar olmadan. │
│ │ │
│ │ · -qq - Çıktıyı bastır │
│ │ uyarılar. │
│ │ │
│ │ · -qqq - Yalnızca çıktı │
│ │ özet. │
├──────────────────────────────────────────── ──────────────────┤
│--kodlar │ Uyarı kodlarını göster. │
├──────────────────────────────────────────── ──────────────────┤
│--aralık │ İlgili sütun aralıklarını göster │
│ │ uyarılara. │
├──────────────────────────────────────────── ──────────────────┤
│--renk yok │ Çıktıyı renklendirmeyin. │
├──────────────────────────────────────────── ──────────────────┤
│-v | --versiyon │ Luacheck ve onun │ sürümünü göster
│ │ bağımlılıklar ve çıkış. │
├──────────────────────────────────────────── ──────────────────┤
│-h | --yardım et │ Yardımı göster ve çık. │
└──────────────────────────────────────────── ──────────────────┘

desenler
CLI seçenekleri --görmezden gelmek, --etkinleştirme ve --bir tek ve ilgili yapılandırma seçenekleri filtrelemeye izin verir
uyarı kodlarında, değişken adlarında veya her ikisinde desen eşleştirmesi kullanan uyarılar. eğer bir desen
eğik çizgi içerir, eğik çizgiden önceki kısım uyarı koduyla eşleşir ve eşleşmelerden sonraki kısım
değişken ismi. Aksi takdirde, bir desen bir harf veya alt çizgi içeriyorsa, eşleşir.
değişken ismi. Aksi takdirde, uyarı koduyla eşleşir. Örneğin:

┌───────────────────────────────────────┐
│Desen │ Eşleşen uyarılar │
├───────────────────────────────────────┤
│4.2 │ │'nin gölgeleme bildirimleri
│ │ argümanlar veya onları yeniden tanımlamak. │
├───────────────────────────────────────┤
│.*_ │ Değişkenlerle ilgili uyarılar │
│ │ ile _ son ek. │
├───────────────────────────────────────┤
│4.2/.*_ │ │ için gölgelendirme bildirimleri
│ │ ile argümanlar _ sonek veya │
│ │ onları yeniden tanımlıyor. │
└───────────────────────────────────────┘

Önceden sabitlenmemişse, değişken adlarıyla eşleşen desenler her iki tarafa sabitlenir ve
uyarı kodlarıyla eşleşen kalıplar, başlangıçlarına sabitlenir. Bu, birinin
uyarıları kategoriye göre filtreleyin (örn. --bir tek 1 odaklanır luaçek küresel ile ilgili uyarılar hakkında).

Setler of standart globaller
CLI seçeneği --stds kullanarak yukarıda açıklanan yerleşik setlerin birleştirilmesine izin verir. +. Örneğin,
--std maksimum eşdeğerdir --std=lua51+lua52+lua53. Önde gelen artı işareti, yeni kümeler ekler
Değiştirmek yerine varsayılan olanı. Örneğin, --std +bastırılmış kontrol etmek için uygundur
kullanan test dosyaları Busted test çerçevesi. Özel global kümeleri şu şekilde tanımlanabilir:
küresel değişkeni mutasyona uğratmak standart yapılandırmada. custom_stds'ye bakın

biçimlendiriciler
CLI seçeneği -- biçimlendirici için özel bir biçimlendirici seçmeye izin verir luaçek çıktı. Bir gelenek
biçimlendirici, üç bağımsız değişkenli bir işlev döndüren bir Lua modülüdür: tarafından döndürülen rapor
luaçek modülü (rapora bakın), dosya adları dizisi ve seçenekler tablosu. Seçenekler şunları içerir:
atanan değerler sessiz, renk, sınır, kodları, aralıkları ve biçimlendirici CLI'deki seçenekler veya
yapılandırma Biçimlendirici işlevi bir dize döndürmelidir.

önbelleğe alma
LuaFileSystem varsa, Luacheck dosyaları kontrol etmenin sonuçlarını önbelleğe alabilir. sonraki
kontroller, yalnızca son kontrolden bu yana değişen dosyalar yeniden kontrol edilecek,
çalışma süresi önemli ölçüde. Seçeneklerin değiştirilmesi (örneğin ek globallerin tanımlanması)
önbelleği geçersiz kıl. Önbelleğe alma, kullanılarak etkinleştirilebilir --önbellek Seçenek veya önbellek yapılandırma
seçenek. kullanma --önbellek argüman veya ayar olmadan önbellek yapılandırma seçeneği gerçek setleri
.luacheckcache önbellek dosyası olarak. Bunu not et --önbellek her zaman kullanılmalıdır luaçek is
çalıştırın, yalnızca ilk çalıştırmada değil.

Kararlı arayüzey için editör eklentileri ve araçlar
Luacheck'in komut satırı arayüzü, küçük sürümler arasında değişebilir. 0.11.0'dan başlayarak
sürüm, aşağıdaki arayüz en az 1.0.0 sürümüne kadar garantilidir ve
Luacheck çıktısını kullanan araçlar tarafından kullanılır, örneğin editör eklentileri.

· Luacheck, kontrol edilen dosyayı içeren dizinden başlatılmalıdır.

· Dosya kullanılarak stdin'den geçirilebilir - bağımsız değişken olarak veya geçici bir dosya kullanarak. Gerçek
dosya adı kullanılarak iletilmelidir --dosya adı seçeneği.

· Düz formatlayıcı kullanılmalıdır. Satır başına bir sayı (uyarı veya hata) verir.

· Kesin hata konumu almak için, --aralık seçeneği kullanılabilir. Her satır gerçek ile başlar
dosya adı (kullanılarak iletildi --dosya adı), bunu takiben : : - :,
nerede sorunun oluştuğu satır numarasıdır ve - is
sorunla ilgili belirteç sütunlarının kapsayıcı aralığı. Numaralandırma 1'den başlar.
--aralık kullanılmaz, bitiş sütunu ve tire yazdırılmaz.

· Uyarı ve hata kodlarını almak, --kodlar seçeneği kullanılabilir. Her satır için alt dize
parantezler arasında, ön ekli üç basamaklı sayı kodu bulunur E hatalar için ve W
uyarılar için. Böyle bir alt dizinin olmaması, önemli bir hatayı gösterir (örneğin, G/Ç hatası).

· Satırın geri kalanı uyarı mesajıdır.

Daha eski Luacheck sürümüyle uyumluluk isteniyorsa, çıktısı luaçek --yardım et olabilir
sürümünü almak için kullanılır. dize içeriyorsa 0. ., Burada var
en az 11 ve yama herhangi bir sayı ise, yukarıda açıklanan arayüz kullanılmalıdır.

YAPILANDIRMA DOSYA

luaçek yapılandırmayı yüklemeye çalışır .luacheckrc geçerli dizindeki dosya. Eğer
bulunamadı, onu ana dizinde arayacak ve bu şekilde devam edecek.
dosya sistemi köküne ulaşır. Yapılandırma yolu kullanılarak ayarlanabilir --yapılandırma seçenek, bu durumda
özyinelemeli yükleme sırasında kullanılacaktır. Yapılandırma yüklemesi kullanılarak devre dışı bırakılabilir --yapılandırma yok
bayrağı.

Config, basitçe tarafından yürütülen bir Lua betiğidir. luaçek. tarafından çeşitli seçenekler ayarlayabilir.
globallere atama veya anahtar olarak seçenek adlarına sahip bir tablo döndürme.

Yapılandırma seçenekleri
┌──────────────────────────────────────────── ──────────────────┐
│Seçenek │ Tip │ Varsayılan değer │
├──────────────────────────────────────────── ──────────────────┤
│renk │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│kodları │ Boole │ yanlış │
└──────────────────────────────────────────── ──────────────────┘

│biçimlendirici │ Dize veya işlev │ "varsayılan" │
├──────────────────────────────────────────── ──────────────────┤
│önbellek │ Boole veya dize │ yanlış │
├──────────────────────────────────────────── ──────────────────┤
│iş fırsatları │ Pozitif tam sayı │ 1 │
├──────────────────────────────────────────── ──────────────────┤
│dışlama_dosyaları │ Dize dizisi │ {} │
├──────────────────────────────────────────── ──────────────────┤
│dahil_dosyalar │ Dizi dizisi │ (Tüm dosyaları dahil et) │
├──────────────────────────────────────────── ──────────────────┤
│global │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│kullanılmayan │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│Yemeği yeniden │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│kullanılmayan_args │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│kullanılmayan_ikinciller │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│öz │ Boole │ gerçek │
├──────────────────────────────────────────── ──────────────────┤
│std │ Dize veya │ kümesi "_G" │
│ │ standart küreseller │ │
├──────────────────────────────────────────── ──────────────────┤
│globaller │ Dize dizisi │ {} │
├──────────────────────────────────────────── ──────────────────┤
│yeni_küreseller │ Dizi dizisi │ (Üzerine yazmayın) │
├──────────────────────────────────────────── ──────────────────┤
│global_oku │ Dize dizisi │ {} │
├──────────────────────────────────────────── ──────────────────┤
│new_read_globals │ Dizi dizisi │ (Üzerine yazmayın) │
├──────────────────────────────────────────── ──────────────────┤
│compat │ Boole │ yanlış │
├──────────────────────────────────────────── ──────────────────┤
│izin_tanımlı │ Boole │ yanlış │
├──────────────────────────────────────────── ──────────────────┤
│izin_tanımlanmış_top │ Boole │ yanlış │
├──────────────────────────────────────────── ──────────────────┤
│modül │ Boole │ yanlış │
├──────────────────────────────────────────── ──────────────────┤
│aldırmamak │ Desen dizisi (bkz. {} │
│ │ desenler) │ │
├──────────────────────────────────────────── ──────────────────┤
│etkinleştirmek │ Desen dizisi │ {} │
├──────────────────────────────────────────── ──────────────────┤
│bir tek │ Desen dizisi │ (Filtreleme) │
├──────────────────────────────────────────── ──────────────────┤
│inline │ Boole │ gerçek │
└──────────────────────────────────────────── ──────────────────┘

yapan bir yapılandırma örneği luaçek yalnızca taşınabilirden küresellerin olduğundan emin olun
Lua 5.1, Lua 5.2, Lua 5.3 ve LuaJIT 2.0'ın kesişimi kullanılır ve devre dışı bırakılır
kullanılmayan argümanların tespiti:

std = "dk"
yoksay = {"212"}

görenek setleri of globaller
std seçeneği, bir tablo kullanarak özel bir standart globaller kümesinin ayarlanmasına izin verir. O tabloda,
string anahtarları globallerdir ve dizi kısmındaki string salt okunur globallerdir.

Ek olarak, global mutasyona uğratılarak özel kümelere adlar verilebilir. standart değişken. İçin
örneğin, kullanırken LPG kütüphane, işlevlerine kısaca kullanarak erişmek mantıklıdır.
küreseller. Bu durumda, aşağıdaki yapılandırma, aşağıdakilerle ilgili yanlış pozitiflerin kaldırılmasına izin verir:
küresel erişim kolayca:

stds.lpeg = "lpeg" gerektirir

yerel lpeg = "lpeg" gerektirir

yerel işlev ayrıştırma1(...)
-- Bu işlev, globaller olarak yalnızca lpeg işlevlerini kullanır.
yerel _ENV = lpeg
-- luacheck: standart lpeg
yerel rakam, boşluk = R "09", S " "
--...
son

yerel işlev ayrıştırma2(...)
-- Bu işlev, standart globallerin yanı sıra lpeg işlevlerini kullanır.
yerel _ENV = setmetatable({}, {__index = function(_, k) return _ENV[k] veya lpeg[k] end})
-- luacheck: standart +lpeg
yerel rakam, boşluk = R "09", S " "
yerel sayı = C(rakam^1) / tonumber
--...
son

dosya başına ve yol başına geçersiz kılmaları
bulunduğu ortam luaçek yapılandırmayı yükler, özel bir global içerir Dosyaları. Ne zaman
bir dosyayı kontrol etmek , luaçek girişlerle ana yapılandırmadaki seçenekleri geçersiz kılar
itibaren Dosyalar[ ] ve Dosyalar[ ], girişleri önce daha kısa yollar için uygular. İçin
örneğin, aşağıdaki yapılandırma, yalnızca içindeki dosyalar için kullanılmayan bağımsız değişkenlerin algılanmasını yeniden etkinleştirir.
kaynak/yön, ama değil src/dir/dosyam.luave kullanılmasına izin verir Busted içindeki küreseller spec /:

std = "dk"
yoksay = {"212"}
dosyalar["src/dir"] = {etkinleştir = {"212"}}
dosyalar["src/dir/myfile.lua"] = {ignore = {"212"}}
dosyalar["spec"] = {std = "+bozuk"}

Bunu not et Dosyaları tablo otomatik canlandırmayı destekler, böylece

dosyalar["dosyam.lua"].ignore = {"212"}

ve

dosyalar["myfile.lua"] = {ignore = {"212"}}

eşdeğerdir.

ÇİZGİDE SEÇENEKLER

Luacheck, satır içi kullanarak bazı seçenekleri doğrudan kontrol edilen dosyalarda ayarlamayı destekler
yapılandırma yorumları Bir satır içi yapılandırma yorumu şununla başlar: kontrol et: etiket,
muhtemelen biraz boşluktan sonra. Yorumun gövdesi virgülle ayrılmış olmalıdır
seçenekler, burada seçenek çağırma, adının yanı sıra boşlukla ayrılmış argümanlardan oluşur. NS
aşağıdaki seçenekler desteklenir:

┌──────────────────────────────────────────── ─────┐
│Seçenek │ Argüman sayısı │
├──────────────────────────────────────────── ─────┤
│küresel │ 0 │
├──────────────────────────────────────────── ─────┤
│kullanılmayan │ 0 │
├──────────────────────────────────────────── ─────┤
│yeniden tanımlanmış │ 0 │
├──────────────────────────────────────────── ─────┤
│kullanılmayan argümanlar │ 0 │
├──────────────────────────────────────────── ─────┤
│kullanılmayan ikincil dosyalar │ 0 │
├──────────────────────────────────────────── ─────┤
│kendi │ 0 │
└──────────────────────────────────────────── ─────┘

│uyum │ 0 │
├──────────────────────────────────────────── ─────┤
│modül │ 0 │
├──────────────────────────────────────────── ─────┤
│tanımlı izin ver │ 0 │
├──────────────────────────────────────────── ─────┤
│tanımlı üste izin ver │ 0 │
├──────────────────────────────────────────── ─────┤
│std │ 1 │
├──────────────────────────────────────────── ─────┤
│küresel │ 0+ │
├──────────────────────────────────────────── ─────┤
│yeni küreseller │ 0+ │
├──────────────────────────────────────────── ─────┤
│küreselleri oku │ 0+ │
├──────────────────────────────────────────── ─────┤
│yeni küresel okumalar │ 0+ │
├──────────────────────────────────────────── ─────┤
│ignore │ 0+ (argümansız her şey │
│ │ yoksayılır) │
├──────────────────────────────────────────── ─────┤
│etkinleştir │ 1+ │
├──────────────────────────────────────────── ─────┤
│sadece │ 1+ │
└──────────────────────────────────────────── ─────┘

Argüman almayan seçeneklere öneki eklenebilir. yok hayır anlamlarını tersine çevirmek için. Örneğin
--luacheck: yok hayır kullanılmayan args kullanılmayan argüman uyarılarını devre dışı bırakır.

Dosyanın satır içi seçeneğinden etkilenen kısmı, nereye yerleştirildiğine bağlıdır. varsa
seçeneği olan satırdaki kod, yalnızca o satır etkilenir; aksi takdirde, her şey kadar
mevcut kapanışın sonu. Özellikle dosyanın üst kısmındaki satır içi seçenekler
hepsini etkiler:

-- luacheck: globals g1 g2, foo'yu yoksay
local foo = g1(g2) -- Hiçbir uyarı yayınlanmadı.

-- Aşağıdaki kullanılmayan işlev bildirilmez.
yerel işlev f() -- luacheck: yoksay
-- luacheck: küreseller g3
g3() -- Uyarı yok.
son

g3() -- Uyarı, g3'ü tanımlayan satır içi seçenek olarak yalnızca f işlevini etkiler.

Satır içi seçenek görünürlük kullanımı üzerinde ayrıntılı kontrol için kontrol et: itmek ve kontrol et:
pop direktifler:

-- luacheck: yoksay foo'ya basın
foo() -- Uyarı yok.
-- luacheck: açılır
foo() -- Uyarı verilir.

Satır içi seçenekler kullanılarak tamamen devre dışı bırakılabilir -- satır içi yok CLI seçeneği veya inline yapılandırma
seçeneği.

LUACHECK MODÜL

kullanım yerel luaçek = gerektirir "luacheck" ithal etmek luaçek modül. şunları içerir:
aşağıdaki işlevler:

· luacheck.get_report(kaynak): Verilen kaynak dizesi, analiz verilerini (bir tablo) döndürür.

· luacheck.process_reports(raporlar, seçenekleri): Bir dizi analiz raporunu işler ve
seçenekleri uygular. raporlar[i] kullanım seçenekleri, seçenekler[i], seçenekler[i][1], seçenekler[i][2], ...
seçenekler olarak, bu sırayla birbirini geçersiz kılar. Seçenekler tablosu, alanları olan bir tablodur
yapılandırma seçeneklerine benzer; seçeneklere bakın. Alan ile analiz raporları ölümcül yok sayılır.
işlem_raporları nihai raporu döndürür, bkz. Report biçim.

· luacheck.check_strings(kaynaklar, seçenekleri): Seçenekleri kullanarak kaynak dizisini kontrol eder, döner
son rapor. Alanlı tablolar ölümcül içinde kaynaklar dizi göz ardı edilir.

· luacheck.check_files(dosyalar, seçenekleri): Seçenekleri kullanarak dosya dizisini kontrol eder, son değeri döndürür
rapor. Dosya adları yerine açık dosya tanıtıcıları iletilebilir, bu durumda bunlar
EOF'ye kadar okuyun ve kapatın.

· luacheck.get_message(sorun): Bir sorun için bir dize mesajı döndürür, bkz. Report biçim.

luacheck._VERSION içinde bir dize olarak Luacheck sürümünü içerir MAJOR.MINOR.YAMA biçimi.

kullanma luaçek bir işlev olarak çağırmaya eşdeğerdir luacheck.check_files.

Report biçim
Nihai rapor, bir dizi dosya raporu artı alanlardır. uyarılar, hataları ve ölümcül
karşılık gelen toplam uyarı, hata ve önemli hata sayısını içerir.

Dosya raporu, bir dizi sorundur (uyarılar veya hatalar). sırasında önemli bir hata meydana gelirse
bir dosyayı kontrol ederken, raporunda ölümcül hata türünü içeren alan.

Bir sorun alanı olan bir tablodur kod türünü belirtir (bkz. uyarılar) ve alanlar hat,
sütun ve end_column uyarının kaynağına işaret ediyor. isim alan adı içerebilir
ilgili değişkenin Bazı türlerin sorunlarının ek alanları da olabilir:

┌─────────────────────────────────────┐
│Kodlar │ Ek alanlar │
├─────────────────────────────────────┤
│011 │ msg alan sözdizimi hatası içeriyor │
│ │ mesajı. │
├─────────────────────────────────────┤
│111 │ modül alan │ olduğunu gösterir
│ │ atama modül olmayan bir │
│ │ global değişken. │
├─────────────────────────────────────┤
│211 │ func alan kullanılmadığını gösterir │
│ │ değişkeni bir fonksiyondur. │
├─────────────────────────────────────┤
│4.. │ önceki_satır ve önceki_sütun alanlar │
│ │ │ konumunu içerir
│ │ üzerine yazılan tanım. │
└─────────────────────────────────────┘

Diğer alanlar dahili nedenlerle mevcut olabilir.

Bu, 0.13.0 sürümü için belgelerdir. Luaçek, için bir linter Lua.

onworks.net hizmetlerini kullanarak luacheck'i çevrimiçi kullanın