perlcriticp - Bulutta Çevrimiçi

Program:

ADI

"perlcritic" - Perl kaynağını eleştirmek için komut satırı arayüzü.

SİNOPSİS

perlkritik [-12345 | --acımasız | --acımasız | --sert | --kıç | --nazik]
[--önem numarası | isim] [{-p | --profile} dosyası | --profil yok]
[--top [ sayı ]] [--tema ifadesi] [--desen dahil]
[--desen hariç tut] [{-s | --single-policy} modeli]
[--sadece | --noonly] [--profile-strictness {uyar|ölümcül|sessiz}]
[--kuvvet | --noforce] [--statistics] [--statistics-only]
[--sayım | -C] [--ayrıntılı {sayı | format}] [--allow-unsafe]
[--renk | --nocolor] [--çağrı cihazı] [--sessiz]
[--renk şiddeti-en yüksek renk belirtimi]
[--renk şiddeti-yüksek renk belirtimi]
[--renk şiddeti-orta renk belirtimi]
[--renk şiddeti-düşük renk belirtimi]
[--renk şiddeti-en düşük renk belirtimi]
[--ihlalli dosyalar | -l]
[--ihlal içermeyen dosyalar | -L]
[--program-uzantıları dosya_adı_uzantısı]
{DOSYA | DİZİN | STDIN}

perlcritic --profil-proto

perlcritic { --list | --list-etkin | --list-temalar | --doc desen [...] }

perlcritic { --help | --seçenekler | --adam | --versiyon }

TANIM

"perlcritic" bir Perl kaynak kodu çözümleyicisidir. Bu, yürütülebilir ön uçtur.
Perl::Critic motor; garip, okunması zor, hataya açık veya
kodunuzdaki geleneksel olmayan yapılar. Kuralların çoğu Damian Conway'in kurallarına dayanmaktadır.
kitap Perl En iyi Uygulamaları. Ancak, "perlcritic" değil PBP'yi uygulamakla sınırlıdır ve
Conway ile çelişen kuralları bile destekleyecektir. Tüm kurallar kolayca yapılandırılabilir veya
beğeninize devre dışı bırakıldı.

Bu belge yalnızca bu komutun nasıl kullanılacağını kapsar. Diğer tüm bilgiler için, bu tür
API referansı ve alternatif arayüzler olarak, lütfen Perl::Critic belgelerine bakın
kendisi.

KULLANIM ÖRNEKLER

Tüm kanlı ayrıntılara girmeden önce, aşağıdakileri anlamanıza yardımcı olacak bazı temel kullanım örnekleri:
sen başladın.

# Yalnızca en ciddi ihlalleri bildirin (önem derecesi = 5)
perlcritic YourModule.pm

# Yukarıdakiyle aynı, ancak STDIN'den gelen girişi okuyun
perlkritik

# Dizinin altındaki tüm Perl dosyalarını özyinelemeli olarak işleyin
perlcritic / bazı / dizin

# Biraz daha az ciddi ihlalleri de bildirin (önem derecesi >= 4)
perlcritic -4 YourModule.pm

# Yukarıdakiyle aynı, ancak adlandırılmış önem düzeyi kullanılıyor
perlcritic --stern YourModule.pm

# Önem düzeyine bakılmaksızın tüm ihlalleri bildirin (önem derecesi >= 1)
perlcritic -1 YourModule.pm

# Yukarıdakiyle aynı, ancak adlandırılmış önem düzeyi kullanılıyor
perlcritic --acımasız YourModule.pm

# Yalnızca "Perl En İyi Uygulamaları"ndaki ihlalleri bildirin
perlcritic --tema pbp YourModule.pm

# En ciddi 20 ihlali bildirin (önem derecesi >= 1)
perlcritic --top YourModule.pm

# m/variables/xms ile eşleşen Ek Politika ihlallerini bildirin
perlcritic -- YourModule.pm değişkenlerini içerir

# Varsayılanları başka bir yerden kullanın ~/.perlcriticrc
perlcriticrc --profile projesi/spesifik/perlcriticrc YourModule.pm

ARGÜMANLAR

Argümanlar, analiz etmek istediğiniz dosyaların yollarıdır. Birden fazla dosya belirtebilirsiniz.
Bir argüman bir dizin ise, "perlcritic" aşağıdaki tüm Perl dosyalarını analiz edecektir.
dizin. Herhangi bir argüman belirtilmezse, giriş STDIN'den okunur.

SEÇENEKLER

Seçenek adları benzersiz olarak kısaltılabilir ve tek veya çift olarak belirtilebilir.
tireler ve seçenek değerleri seçenek adından bir boşluk veya '=' ile ayrılabilir (olduğu gibi
Getopt::Uzun). Seçenek adları da büyük/küçük harfe duyarlıdır.

"--profil DOSYA" veya "-p DOSYA"
"Perlcritic"i, arama yerine FILE adlı bir profili kullanmaya yönlendirir.
varsayılan .perlcriticrc geçerli dizindeki veya ana dizininizdeki dosya. Görmek
Daha fazla bilgi için Perl::Critic'te "KONFIGURATION".

"--profil yok"
"Perlcritic"i herhangi bir yapılandırma dosyasını yüklememeye ve böylece varsayılana geri dönmeye yönlendirir
Tüm Politikalar için yapılandırma.

"--şiddet N"
"Perlcritic" öğesini yalnızca "N"den daha yüksek önem derecesine sahip İlkeleri uygulamaya yönlendirir.
Önem değerleri 1 (en az şiddetli) ile 5 (en şiddetli) arasında değişen tam sayılardır. bu
varsayılan 5'tir. Belirli bir "--profil" için "--önem derecesinin" düşürülmesi genellikle
daha fazla ihlal üretir. Bu seçenek için varsayılan değeri,
.perlcriticrc dosya. Ayrıca, herhangi bir Politika için "önem derecesini" yeniden tanımlayabilirsiniz.
.perlcriticrc dosya. Daha fazla bilgi için "KONFIGÜRASYON" bölümüne bakın.

"-5 | -4 | -3 | -2 | -1"
Bunlar, "--severity" seçeneğini ayarlamak için kullanılan sayısal kısayollardır. Örneğin, "-4"
"--önem derecesi 4"e eşdeğerdir. Birden çok kısayol belirtilirse, çoğu
kısıtlayıcı olan kazanır. Açık bir "--ciddilik" seçeneği de verilirse, tüm
kısayol seçenekleri sessizce yoksayılır. NOT: Numaralardan birini koymamaya dikkat edin.
"--top" bayrağından veya "perlcritic"ten hemen sonra önem derecesi kısayol seçenekleri
bunu rapor edilecek ihlallerin sayısı olarak yorumlayın.

"--önem derecesi NAME"
"5" şiddetinin en fazla mı yoksa en az mı olduğunu hatırlamanız zorsa
kısıtlayıcı seviye, daha sonra bu adlandırılmış değerlerden birini kullanabilirsiniz:

ÖNEM ADI ...eşittir... ÖNEMLİLİK NUMARASI
-------------------------------------------------- ------
--ciddilik nazik --şiddet 5
--ciddilik kıç --ciddilik 4
--şiddet sert --şiddet 3
--şiddet acımasız --şiddet 2
--şiddet acımasız --şiddet 1

"--nazik | --kıç | --sert | --zalim | --acımasız"
Bunlar, "--severity" seçeneğini ayarlamak için kısayollar olarak adlandırılır. Örneğin, "--zalim"
"--önem derecesi 2" ile eşdeğerdir. Birden çok kısayol belirtilirse, çoğu
kısıtlayıcı olan kazanır. Açık bir "--ciddilik" seçeneği de verilirse, tüm
kısayol seçenekleri sessizce yoksayılır.

"--tema KURAL"
"Perlcritic"i, yalnızca "KURAL"ı karşılayan temalara sahip İlkeleri uygulamaya yönlendirir.
Temalar, ilgili ilke grupları için rastgele adlardır. temayı birleştirebilirsin
keyfi olarak karmaşık bir "KURAL" oluşturmak için boole operatörlü adlar. Örneğin,
aşağıdakiler yalnızca 'hatalar' VE 'pbp' temasına sahip Politikalar için geçerlidir:

$> perlcritic --theme='bugs && pbp' MyModule.pm

"--severity" seçeneği açıkça belirtilmedikçe, "--theme" ayarının sessizce yapılması,
"--severity" 1 olarak ayarlanır. Bu seçenek için varsayılan değeri şuradan ayarlayabilirsiniz:
senin .perlcriticrc dosya. Daha fazla bilgi için Perl::Critic'te "POLİTİKA TEMALARI"na bakın
temalar hakkında.

"--DESEN dahil"
"/PATTERN/imx" normal ifadesiyle eşleşen ek İlkeler uygulamak için "perlcritic"i yönlendirir.
Profilinizi ve/veya önem düzeyi ayarlarınızı geçici olarak geçersiz kılmak için bu seçeneği kullanın.
komut satırı. Örneğin:

perlcritic --include=düzen my_file.pl

Bu, "perlcritic" in tüm "CodeLayout::*" politikalarını uygulamasına neden olur.
5 varsayılan düzeyinden daha düşük bir önem düzeyi düzeyine sahip veya devre dışı bırakılmış
Cihazınızda .perlcriticrc dosya. Birden çok "--include" seçeneği belirtebilir ve
"--exclude" seçeneğiyle birlikte kullanın. "--exclude" ifadesinin
Bir İlke her iki modelle de eşleştiğinde "--include" yerine öncelik verilir. ayarlayabilirsiniz
bu seçenek için varsayılan değer .perlcriticrc dosyası.

"--DESENİ hariç tut"
"Perlcritic"i, "/PATTERN/imx" normal ifadesiyle eşleşen herhangi bir İlkeyi uygulamamaya yönlendirir.
Profilinizi ve/veya önem düzeyi ayarlarınızı geçici olarak geçersiz kılmak için bu seçeneği kullanın.
komut satırı. Örneğin:

perlcritic --exclude=katı my_file.pl

Bu, "perlcritic"in "RequireUseStrict"i uygulamamasına ve
"ProhibitNoStrict" Politikaları, en yüksek önem düzeyine sahip olmalarına rağmen. Yapabilirsiniz
birden fazla "--exclude" seçeneği belirtin ve bunu aşağıdakilerle birlikte kullanabilirsiniz.
"--dahil" seçeneği. "--exclude" öğesinin, bir
Politika her iki modelle de eşleşir. Bu seçenek için varsayılan değeri,
.perlcriticrc dosyası.

"--single-policy DESEN" veya "-s DESEN"
"Perlcritic"i, normal ifadeyle eşleşen yalnızca bir İlke modülünü uygulamaya yönlendirir
"/PATTERN/ixms" ve diğer tüm Politikaları hariç tutun. Bu seçeneğin önceliği vardır
"--önemlilik", "--tema", "--içerme", "--hariç tutma" ve "--yalnızca" seçenekleri. Örneğin:

perlcritic --single-policy=bilgiler my_file.pl

Bu, "perlcritic" in yalnızca "ProhibitNoWarnings" Politikasını uygulamasına neden olur,
önem düzeyi ayarından bağımsız olarak. Başka hiçbir Politika uygulanmayacaktır.

Bu, birinin niyet edebileceği şeye eşdeğerdir ...

perlcritic --exclude=. --include=bilgiler my_file.pl

... ancak bu işe yaramaz çünkü "--exclude" seçeneği "--include" seçeneğini geçersiz kılar
seçeneği.

Bu seçeneğin eşdeğeri, özel bir profil oluşturularak gerçekleştirilebilir.
yalnızca istenen politikayı içeren ve ardından çalışan ...

perlcritic --profile=özel profil --yalnızca benim_dosyam.pl

"--üst [N]"
"Perlcritic"i, her dosyada yalnızca en üstteki "N" Politika ihlallerini, derecelendirilmiş olarak bildirmeye yönlendirir
ciddiyetlerine göre. "N" belirtilmemişse, varsayılan olarak 20'dir.
seçeneği (veya kısayollardan biri) açıkça belirtilmemiştir, "--top" seçeneği şu anlama gelir:
minimum önem derecesinin "1" (yani "acımasız") olduğunu. Kullanıcılar yeniden tanımlayabilir
herhangi bir Politika için önem derecesi .perlcriticrc dosya. Daha fazlası için "KONFIGÜRASYON" bölümüne bakın
bilgi. Bu seçenek için varsayılan değeri, .perlcriticrc
dosya. NOT: Önem derecesi kısayol seçeneklerinden birini hemen koymamaya dikkat edin.
"--top" işaretinden sonra veya "perlcritic" bunu ihlal sayısı olarak yorumlayacaktır.
rapor etmek.

"--Kuvvet"
"Perlcritic"i, kaynaktaki sihirli "## eleştirmen yok" açıklamalarını yok saymaya yönlendirir
kod. Daha fazla bilgi için "KURALLARI BÜKME" bölümüne bakın. için varsayılan değeri ayarlayabilirsiniz.
bu seçenek sizin .perlcriticrc dosyası.

"--İstatistik"
Taranan kod ve tespit edilen ihlaller hakkında birkaç istatistiğe neden olur.
diğer çıktılardan sonra rapor edilir.

"--yalnızca istatistikler"
"--statistics" seçeneği gibi, ancak normal çıktıyı bastırır ve yalnızca
istatistikleri.

"--verbose N | FORMAT"
İhlallerin bildirilmesi için ayrıntı düzeyini veya biçimini ayarlar. Bir sayı ("N") verilmişse,
"perlcritic", aşağıda açıklanan önceden tanımlanmış biçimlerden birini kullanarak ihlalleri bildirir.
Bir dize ("FORMAT") verilirse, gerçek bir biçim belirtimi olarak yorumlanır.
"--verbose" seçeneği belirtilmemişse, varsayılan olarak 4 veya 5'tir.
"perlcritic" için argüman olarak birden fazla dosyanın verilip verilmediği. ayarlayabilirsiniz
bu seçenek için varsayılan değer .perlcriticrc dosyası.

Ayrıntı Biçimi Belirtimi
----------- ------------------------------------------ ----------------
1 "%f:%l:%c:%m\n",
2 "%f: (%l:%c) %m\n",
3 "%m %f satırında %l\n",
4 "%m %l satırında, %c sütununda. %e. (Önem: %s)\n",
5 "%f: %m %l satırında, %c sütununda. %e. (Önem: %s)\n",
6 "%m %l satırında, '%r' yakınında. (Önem derecesi: %s)\n",
7 "%f: %m '%r' yakınında %l satırında. (Önem derecesi: %s)\n",
8 "[%p] %m %l satırında, %c sütununda. (Önem: %s)\n",
9 "[%p] %m, %l satırında, '%r' yakınında. (Önem derecesi: %s)\n",
10 "%m %l satırında, %c sütununda.\n %p (Önem: %s)\n%d\n",
11 "%m, %l satırında, '%r' yakınında.\n %p (Önem: %s)\n%d\n"

Biçimler, yola benzer değişmez ve kaçış karakterlerinin bir birleşimidir.
"sprintf" çalışır. Biçimlendirmenin tam açıklaması için String::Format'a bakın
yetenekler. Geçerli kaçış karakterleri şunlardır:

kaçış anlamı
------- ------------------------------------------- -----------------
%c İhlalin gerçekleştiği sütun numarası
%d İhlalin tam tanısal tartışması
%e PBP'de ihlal açıklaması veya sayfa numaraları
%F Yalnızca ihlalin meydana geldiği dosyanın adı.
%f İhlalin meydana geldiği dosyanın yolu.
%l İhlalin gerçekleştiği satır numarası
%m İhlalin kısa açıklaması
%P İhlali oluşturan İlke modülünün tam adı
%p Perl::Critic::Policy:: öneki olmadan Politikanın Adı
%r İhlale neden olan kaynak kod dizisi
%C İhlale neden olan PPI::Element sınıfı
%s İhlalin önem düzeyi

Bu biçimlerin amacı, metin düzenleyicilerle bazı uyumluluklar sağlamaktır.
belirli türdeki girdileri ayrıştırmak için bir arayüze sahiptir. için "EDİTÖR ENTEGRASYONU"na bakın.
Bununla ilgili daha fazla bilgi.

"--liste"
Üzerinde bulunan tüm Perl::Critic::Policy modüllerinin yoğun bir listesini görüntüler.
bu makine. Bu seçenek listeler herşey Politikalarınız ne olursa olsun .perlcriticrc or
komut satırı seçenekleri. Her İlke için ad, varsayılan önem derecesi ve varsayılan temalar
gösterilir.

"--list etkin"
Tüm Perl::Critic::Policy modüllerinin yoğun bir listesini görüntüler. olur be
Bu komutla bir dosyayı gerçekten eleştirecekseniz, zorunlu kılındı. Bu
karmaşık bir komut oluşturduğunuzda veya komutunuzu değiştirdiğinizde kullanışlıdır. .perlcriticrc
dosya ve tam olarak hangi İlkelerin uygulanacağını (ya da uygulanmayacağını) görmek istiyorsunuz.
duruma göre uygulanır). Her İlke için ad, varsayılan önem derecesi ve varsayılan
temalar gösteriliyor.

"--liste-temaları"
Perl::Critic::Policy modüllerinin bulunan tüm temalarının bir listesini görüntüler
bu makinede.

"--profil-proto"
Üzerinde bulunan tüm Perl::Critic::Policy modüllerinin genişletilmiş bir listesini görüntüler.
bu makine. Her İlke için ad, varsayılan önem derecesi ve varsayılan temalar
İlkenin desteklediği ek parametrelerin adlarının yanı sıra gösterilir. bu
biçiminiz için bir prototip olarak uygundur. .perlcriticrc dosyası.

"--bir tek"
Perlcritic'i yalnızca belgenizde açıkça belirtilen Politikaları uygulamaya yönlendirir.
.perlcriticrc dosya. Bu, Politikaların yalnızca küçük bir alt kümesini kullanmak istiyorsanız kullanışlıdır.
diğerlerini devre dışı bırakmak zorunda kalmadan. Bunun için varsayılan değeri ayarlayabilirsiniz.
seçeneğinde .perlcriticrc dosyası.

"--profile-strictness {uyar|ölümcül|sessiz}"
Perlcritic'e bir sistemde bulunan belirli kurtarılabilir sorunların nasıl tedavi edileceğini yönlendirir. .perlcriticrc
veya "--profile" seçeneği ile belirtilen dosya. Geçerli değerler "uyar" (varsayılan),
"ölümcül" ve "sessiz". Örneğin, perlcritic normalde yalnızca profiller hakkında uyarır
mevcut olmayan Politikalara atıfta bulunur, ancak bu seçenek bu durumu ölümcül hale getirebilir. Sen
bu seçenek için varsayılan değeri ayarlayabilirsiniz. .perlcriticrc dosyası.

"--saymak"
"-C"
Her dosya için yalnızca ihlal sayısını görüntüleyin. Hızlı bir şekilde almak için bu özelliği kullanın
büyük bir kod yığınının en çok dikkat gerektirebileceği yeri ele alın.

"--Safari"
"Perl Best Practice" alıntılarını bölüm numaraları olarak rapor edin
<http://safari.oreilly.com> asıl kitabın sayfa numaraları yerine. NOT: Bu
özellik henüz uygulanmadı.

"--color" =item "--color"
Bu seçenek, bir tty'ye çıktı alırken açıktır. Ayarlandığında, Önem Derecesi 5 ve 4 renklidir
sırasıyla kırmızı ve sarı. Renklendirme yalnızca Term::ANSIColor
yüklüdür ve yalnızca Windows dışı ortamlarda çalışır. Bu anahtarı reddet
rengi devre dışı bırakın. Bu seçenek için varsayılan değeri, .perlcriticrc
dosyası.

"--çağrı cihazı PAGER_COMMAND_STRING"
Ayarlanırsa, perlcritic çıktısını verilen PAGER_COMMAND_STRING'e yönlendirir. Yapabilirsiniz
içinde bu seçenek için varsayılan değeri ayarlayın. .perlcriticrc dosyası.

Çağrı cihazının ayarlanması varsayılan olarak rengi kapatır. rengi açmanız gerekecek
açıkça. Renk istiyorsanız, muhtemelen çağrı cihazınıza şunu da söylemek isteyeceksiniz:
ham karakterleri göster. "Daha az" ve "daha fazla" için -R anahtarını kullanın.

"--renk şiddeti-en yüksek COLOR_SPECIFICATION"
En yüksek önemdeki ihlaller için kullanılacak rengi Term::ANSIColor olarak belirtir
renk özellikleri. "--renk-önem derecesi-en yüksek" olarak da belirtilebilir,
"--renk-önem derecesi-5" veya "--renk-önem derecesi-5".

"--renk şiddeti-yüksek COLOR_SPECIFICATION"
Yüksek önem dereceli ihlaller için kullanılacak rengi Term::ANSIColor olarak belirtir
renk özellikleri. "--renk-önem derecesi-yüksek" olarak da belirtilebilir,
"--renk-önem derecesi-4" veya "--renk-önem derecesi-4".

"--renk şiddeti-orta COLOR_SPECIFICATION"
Orta önemdeki ihlaller için kullanılacak rengi Term::ANSIColor olarak belirtir
renk özellikleri. "--renk-önem derecesi-orta" olarak da belirtilebilir,
"--renk-önem derecesi-3" veya "--renk-önem derecesi-3".

"--renk şiddeti-düşük COLOR_SPECIFICATION"
Düşük önemdeki ihlaller için kullanılacak rengi Term::ANSIColor rengi olarak belirtir
Şartname. "--renk-önem derecesi-düşük" olarak da belirtilebilir,
"--renk-önem derecesi-2" veya "--renk-önem derecesi-2".

"--renk şiddeti-en düşük COLOR_SPECIFICATION"
En düşük önemdeki ihlaller için kullanılacak rengi Term::ANSIColor olarak belirtir.
renk özellikleri. "--renk-önem derecesi-en düşük" olarak da belirtilebilir,
"--renk-önem derecesi-1" veya "--renk-önem derecesi-1".

"--ihlalli dosyalar"
Yalnızca ihlal içeren dosyaların adlarını görüntüleyin. ile bu özelliği kullanın
--single-policy belirli bir politikanın ihlallerini içeren dosyaları bulmak için. Ayrıca olabilir
"--l" olarak belirtilir.

"--ihlalleri olmayan dosyalar"
Yalnızca ihlal içermeyen dosyaların adlarını görüntüleyin. ile bu özelliği kullanın
--single-policy, belirli bir politikanın ihlallerini içermeyen dosyaları bulmak için. Olabilmek
"--L" olarak da belirtilmelidir.

"--program-uzantıları dosya_adı_uzantısı"
"Perlcritic"e, adları verilen dosya adı uzantısıyla biten dosyalara şu şekilde davranmasını söyleyin:
programlar, modüller olarak değil. Eğer bir lider '.' isteniyorsa açıkça belirtilmelidir,
Evliliğin bona fide bir evlilik olduğu şu belgeler ile ispatlanabilir:

--program-uzantıları .pl

Eşleştirme büyük/küçük harfe duyarlıdır ve seçenek, istediğiniz kadar belirtilebilir.
istenen, örneğin

--program-uzantıları .pl --program-uzantıları .cgi

Yukarıdakiler, dosya adı uzantılarından alıntı yapılarak da yapılabilir:

--program-uzantıları '.pl .cgi'

Adı '.PL' ile biten dosyalar her zaman program olarak kabul edilecektir.

"--doc DESEN"
"m/PATTERN/ixms" ile eşleşen tüm Perl::Critic::Policy modülleri için perldoc'u görüntüler.
İlke modülleri oldukça uzun isimlere sahip olma eğiliminde olduğundan, bu sadece daha fazlasını sağlar.
"perldoc" gibi bir şey söylemenin uygun yolu
Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseH eredocTerminator"
Komut istemi.

"--izin ver-güvensiz"
Bu seçenek, olarak işaretlenmiş İlkelerin kullanımına izin vermek için "perlcritic"i yönlendirir.
"güvensiz". Güvenli Olmayan Politikalar, derleme ve yürütme yoluyla riskli işlemlere neden olabilir.
analiz ettikleri kod. Çekirdek Perl::Critic ile gelen tüm İlkeler
dağıtım güvenlidir. Ancak, aşağıdakiler gibi üçüncü taraf Politikaları
Perl::Critic::Dynamic dağıtım güvenli değildir. "Güvenliğin" fahri olduğuna dikkat edin -- eğer
Bir Politika yazarı, bir Politikayı güvenli olarak işaretler, bu, kötü olmayacağının garantisi değildir
eşyalar. If sen değil mi güven senin Politikaları ve the kod sen vardır analiz, sonra do değil
kullanım Re-Tweet anahtar.

"--sessizlik"
Hiçbir ihlal bulunmadığında "kaynak OK" mesajını bastırın.

"--Yardım"
"-?"
"-H"
Seçeneklerin ve çıkışların kısa bir özetini görüntüler.

"--seçenekler"
Seçeneklerin ve çıkışların açıklamalarını görüntüler. Bu çıktı uzun olmakla birlikte,
"--man" çıktısının uzunluğuna yakın hiçbir yerde.

"--adam"
"Perlcritic" kılavuzunun tamamını görüntüler ve çıkar.

"--versiyon"
"-V"
"Perlcritic"in sürüm numarasını görüntüler ve çıkar.

YAPILANDIRMA

Perl::Critic için ayarların çoğu ve Politika modüllerinin her biri tarafından kontrol edilebilir.
bir yapılandırma dosyası. Varsayılan yapılandırma dosyası denir .perlcriticrc.
"perlcritic" bu dosyayı önce geçerli dizinde, sonra da evinizde arayacaktır.
dizin. Alternatif olarak, "PERLCRITIC" ortam değişkenini açıkça
başka bir konumdaki farklı bir dosyaya işaret edin. Bu dosyalardan hiçbiri yoksa ve
Komut satırında "--profile" seçeneği verilmezse, tüm Politikalar ile yüklenecektir.
onların varsayılan yapılandırması.

Yapılandırma dosyasının formatı, anahtar içeren bir dizi INI tarzı bloktur.
"=" ile ayrılmış değer çiftleri. Yorumlar "#" ile başlamalı ve bir
ayrı bir satır veya isterseniz isim-değer çiftlerinden sonra.

Perlcritic için varsayılan ayarlar belirlenebilir önce the ilk adlı engellemek. Her Ticaretçi İçin Mükemmellik
örneğin, bunlardan herhangi birini veya tümünü sayfanızın en üstüne koyarak .perlcriticrc dosya ayarlayacaktır
karşılık gelen komut satırı bağımsız değişkeni için varsayılan değer.

önem = 3 #Tamsayı veya adlandırılmış düzey
sadece = 1 #Sıfır veya Bir
kuvvet = 0 #Sıfır veya Bir
ayrıntılı = 4 #Tamsayı veya biçim özelliği
top = 50 #A pozitif tam sayı
tema = (pbp + güvenlik) * hatalar #A tema ifadesi
include = NamingConventions ClassHierarchies #Boşlukla ayrılmış liste
hariç tut = Değişkenler Modüller::RequirePackage #Boşlukla ayrılmış liste

Yapılandırma dosyasının geri kalanı şuna benzer bir dizi bloktan oluşur:

[Perl::Eleştirmen::Politika::Kategori::PolitikaAdı]
önem = 1
set_themes = bilgi çubuğu
add_themes = baz
arg1 = değer1
arg2 = değer2

"Perl::Critic::Policy::Category::PolicyName", aşağıdakileri uygulayan bir modülün tam adıdır.
politika. Perl::Critic ile dağıtılan İlke modülleri şu şekilde gruplandırılmıştır:
Damian Conway'in kitabındaki içindekiler tablosuna göre kategoriler Perl En iyi Uygulamaları.
Kısaca, modül adının 'Perl::Critic::Policy' bölümünü atlayabilirsiniz.

"önem derecesi", Politikaya atamak istediğiniz önem düzeyidir. Tüm Politika
modüller, 1 (en az ciddi) ile 5 (en fazla) arasında değişen bir varsayılan önem derecesi değeriyle tanımlanır.
şiddetli). Ancak, varsayılan önem derecesine katılmayabilir ve ona bir değer vermeyi seçebilirsiniz.
kendi kodlama felsefenize göre daha yüksek veya daha düşük önem derecesi. "Şiddet" ayarını yapabilirsiniz
1'den 5'e kadar bir tam sayıya veya eşdeğer adlardan birini kullanın:

ÖNEM ADI ...eşittir... ÖNEMLİLİK NUMARASI
-------------------------------------------------- -
nazik 5
kıç 4
sert 3
zalim 2
acımasız 1

"set_themes", İlke için temayı ayarlar ve varsayılan temasını geçersiz kılar. Argüman
bir veya daha fazla boşlukla ayrılmış alfasayısal sözcüklerden oluşan bir dizedir. Temalar durum-
duyarsız. Daha fazla bilgi için "POLİTİKA TEMALARI"na bakın.

"add_themes", bu Politika için varsayılan temalara eklenir. Argüman bir dizedir
bir veya daha fazla boşlukla ayrılmış kelime. Temalar büyük/küçük harfe duyarlı değildir. "POLİTİKA TEMALARI"na bakın
daha fazla bilgi için.

Kalan anahtar/değer çiftleri, ana bilgisayara aktarılacak yapılandırma parametreleridir.
bu Politikanın kurucusu. Çoğu İlke modülünün yapıcıları desteklemez
argümanlar ve bunu yapanların makul varsayılanları olmalıdır. belgelerine bakın
daha fazla ayrıntı için uygun İlke modülü.

Belirli bir İlke için önem derecesini yeniden tanımlamak yerine, bir İlkeyi tamamen devre dışı bırakabilirsiniz.
yapılandırma dosyanızdaki modülün adının başına bir '-' ekleyerek. Bu şekilde,
İlke, komut satırında verilen "--severity" ne olursa olsun asla yüklenmeyecektir.

Basit bir yapılandırma şöyle görünebilir:

#------------------------------------------------ -------------
# Bunların gerçekten önemli olduğunu düşünüyorum, bu yüzden her zaman onları yükleyin

[TestingAndDebugging::RequireUseStrict]
önem = 5

[Testleme ve Hata Ayıklama::RequireUseWarnings]
önem = 5

#------------------------------------------------ -------------
# Bunların daha az önemli olduğunu düşünüyorum, bu yüzden yalnızca sorulduğunda yükle

[Değişkenler::ProhibitPackageVars]
önem = 2

[ControlStructures::ProhibitPostfixControls]
izin ver = if # olmadığı sürece Özel yapılandırmam
ciddiyet = zalim # "ciddilik = 2" ile aynı

#------------------------------------------------ -------------
# Bu politikalara özel bir tema verin. sadece aktif edebilirim
# bu politikalar "perlcritic --theme 'larry || curly'" diyerek

[Modüller::RequireFilenameMatchesPackage]
add_themes = larry

[TestingAndDebugging::RequireTestLabels]
add_themes = kıvırcık moe

#------------------------------------------------ -------------
# Bunlara hiç katılmıyorum, o yüzden asla yüklemeyin

[-Adlandırma Kuralları::Büyük Harf]
[-ValuesAndExpressions::ProhibitMagicNumbers]

#------------------------------------------------ -------------
# Diğer tüm Politikalar için varsayılan önem derecesini kabul ediyorum,
# bu nedenle onlar için ek yapılandırma gerekmez.

Tamsayıya sahip Perl::Critic dağıtımında bulunan tüm ilkelerin
parametreler, Perl sayısal değişmezlerinde olduğu gibi, değerlerinde alt çizgi ("_") kabul eder. İçin
örnek,

[ValuesAndExpressions::RequireNumberSeparators]
min_değer = 1_000

Ek yapılandırma örnekleri için bkz. perlcriticrc Bu dosyada bulunan dosya
örnekler Bu dağıtımın dizini.

Damian Conway'in kendi Perl::Critic konfigürasyonu da bu dağıtıma şu şekilde dahil edilmiştir:
örnekler/perlcriticrc-conway.

L' POLİTİKALAR

Perl::Critic ile çok sayıda İlke modülü dağıtılır. onlar tarif edilir
kısaca Perl::Critic::PolicySummary belgesinde ve daha ayrıntılı olarak
bireysel modüllerin kendileri. Herkes için perldoc'u görmek için "perlcritic --doc PATTERN" deyin
"m/PATTERN/ixms" normal ifadesiyle eşleşen ilke modülleri

CPAN'da bir dizi ek politika dağıtımı vardır. Perl::Eleştirel ise
istediğiniz bir politika içermiyorsa, birileri zaten yazmış olabilir. Bkz.
ALSO", bu dağıtımların bazılarının bir listesi için Perl::Critic'te.

POLİTİKA TEMALAR

Her Politika bir veya daha fazla "tema" ile tanımlanır. Temalar keyfi oluşturmak için kullanılabilir
Politika grupları. Seçim için alternatif bir mekanizma sağlamaları amaçlanmıştır.
tercih ettiğiniz İlkeler kümesi. Örneğin, belirli bir diziyi devre dışı bırakmak isteyebilirsiniz.
Test programlarını analiz ederken politikalar. Tersine, yalnızca belirli bir seçeneği etkinleştirmek isteyebilirsiniz.
modülleri analiz ederken İlkelerin alt kümesi.

Perl::Critic ile birlikte gelen İlkeler aşağıdaki temalara ayrılmıştır.
Bu sadece bazı temel mantıksal gruplamaları sağlama girişimimizdir. icat etmekte özgürsünüz
ihtiyaçlarınıza uygun yeni temalar.

TEMA AÇIKLAMASI
-------------------------------------------------- ----------------------
çekirdek Perl::Critic ile birlikte gelen tüm politikalar
Doğrudan "Perl En İyi Uygulamalarından" gelen pbp Politikaları
Hataları önleyen veya ortaya çıkaran politikalar
CERT'in önerdiği certrec Politikaları
certrule CERT'nin kuralları dikkate aldığı politikalar
Kodun uzun vadeli sağlığını etkileyen bakım ilkeleri
Sadece yüzeysel bir etkiye sahip kozmetik Politikalar
Karmaşıklık Özellikle kod karmaşıklığıyla ilgili politikalar
Güvenlik sorunlarıyla ilgili güvenlik politikaları
test programlarına özel politikalar

Mevcut tüm politikaların ve mevcut temaların bir listesini almak için "perlcritic --list" deyin.
her biri ile ilişkili. Ayrıca herhangi bir Politikanın temasını da değiştirebilirsiniz.
.perlcriticrc dosya. Bununla ilgili daha fazla bilgi için "KONFIGURASYON" bölümüne bakın.

"--theme" komut satırı seçeneğini kullanarak, keyfi olarak karmaşık bir kural oluşturabilirsiniz.
hangi Politikaların uygulanacağını belirler. Öncelik, normal Perl koduyla aynıdır ve siz
önceliği zorlamak için parantez de kullanabilir. Desteklenen operatörler şunlardır:

Operatör Alternatif Örneği
-------------------------------------------------- ---------------
&& ve 'pbp && çekirdek'
|| veya 'pbp || (hatalar && güvenlik)'
! 'pbp && ! (taşınabilirlik || karmaşıklık)'

Tema adları büyük/küçük harfe duyarsızdır. "--theme" boş bir dizeye ayarlanmışsa,
tüm Politikaları doğru olarak değerlendirir.

BÜKME L' KURALLAR

Perl::Critic kodunuza katı bir yaklaşım getiriyor: ya uyarsınız ya da uymazsınız. İçinde
gerçek dünyada, kodlamaya tam olarak uymak her zaman pratik (hatta mümkün) değildir.
standartlar. Bu gibi durumlarda, bilerek ve isteyerek ihlal ettiğinizi göstermek akıllıca olacaktır.
standartlar ve bunu yapmak için bir Lanet İyi Nedeniniz (DGR) var.

Bu durumlara yardımcı olmak için Perl::Critic'i belirli satırları yoksaymaya veya
ek açıklamaları kullanarak kod blokları:

'LegacyLibaray1.pl' gerektirir; ## eleştirmen yok
'LegacyLibrary2.pl' gerektirir; ## eleştirmen yok

$elementim için (@list) {

## eleştirmen yok

$foo = ""; #'ProhibitEmptyQuotes'u İhlal Ediyor
$barf = bar() ise $foo; #'ProhibitPostfixKontrollerini' İhlal Ediyor
#Biraz daha kötü kod...

## eleştirmeni kullan

#Bazı iyi kodlar...
birşeyler yap($_);
}

"## eleştirmen yok" ek açıklamaları, Perl::Critic'i kalan kod satırlarını yok saymaya yönlendirir
"## kullanım eleştirmeni" ek açıklaması bulunana kadar. "## eleştirmen yok" ek açıklaması açıksa
kod ifadesi ile aynı satırdaysa, yalnızca bu kod satırı gözden kaçırılır. Direkt olarak
perlcritic "## eleştirmen yok" ek açıklamalarını yoksaymak için "--force" seçeneğini kullanın.

Çıplak bir "## eleştirmen yok" ek açıklaması, tüm etkin İlkeleri devre dışı bırakır. devre dışı bırakmak isterseniz
yalnızca belirli Politikalar için yaptığınız gibi, Politika adlarının bir listesini argüman olarak ekleyin.
"katı yok" veya "uyarı yok" pragması. Örneğin, bu
Blok sonuna kadar "ProhibitEmptyQuotes" ve "ProhibitPostfixControls" politikaları veya
sonraki "## kritik kullan" ek açıklamasına kadar (hangisi önce gelirse):

## eleştirmen yok (EmptyQuotes, PostfixControls);

# Artık ValuesAndExpressions::ProhibitEmptyQuotes'tan muaf
$foo = "";

# Şimdi ControlStructures::ProhibitPostfixControls'den muaf
$barf = bar() ise $foo;

# Hala ValuesAndExpression::RequireNumberSeparators'a tabi
$long_int = 10000000000;

Politika adları, "## eleştirmen yok" argümanlarıyla normal olarak eşleştirildiğinden
İlke adlarını kısaltabilir veya tüm bir İlke ailesini devre dışı bırakabilirsiniz.
tek çekimde şöyle:

## eleştirmen yok (Adlandırma Kuralları)

# Artık NamingConventions::Capitalization'dan muaf
benim $camelHumpVar = 'foo';

# Artık NamingConventions::Capitalization'dan muaf
alt deveHumpSub {}

Argüman listesi parantez içine alınmalı ve bir veya daha fazla virgül içermelidir.
ayrılmış barewords (yani tırnak kullanmayın). "## eleştirmen yok" ek açıklamaları şunlar olabilir:
iç içe yerleştirilmiş ve bir iç açıklama ile adlandırılan İlkeler, bunlarla birlikte devre dışı bırakılacaktır.
zaten bir dış açıklamayı devre dışı bıraktı.

"Subroutines::ProhibitExcessComplexity" gibi bazı İlkeler tüm bir blok için geçerlidir.
kod. Bu gibi durumlarda, ihlalin olduğu satırda "## eleştirmen yok" ifadesi görünmelidir.
bildirildi. Örneğin:

alt karmaşık_işlev { ## eleştirmen yok (ProhibitExcessComplexity)
# Kodunuz burada...
}

"Documentation::RequirePodSections" gibi bazı İlkeler belgenin tamamı için geçerlidir.
hangi vaka ihlalleri 1. satırda rapor edilir. Ancak dosya bir shebang satırı gerektiriyorsa,
dosyanın ilk satırına "## eleştirmen yok" koymak imkansız. Bu bilinen bir
sınırlama ve gelecekteki bir sürümde ele alınacaktır. Geçici bir çözüm olarak, devre dışı bırakabilirsiniz
etkilenen politikalar komut satırında veya .perlcriticrc dosya. Ama dikkat et
bu analizi etkileyecek herşey dosyaları.

Bu özelliği akıllıca kullanın. "## eleştirmen yok" mümkün olan en küçük kapsamda kullanılmalı veya
yalnızca bireysel kod satırlarında. Ve her zaman hakkında mümkün olduğunca spesifik olmalısınız.
hangi politikaları devre dışı bırakmak istediğinizi (yani asla "## eleştirmen yok" ifadesini asla kullanmayın). Eğer
Perl::Critic kodunuz hakkında şikayet ediyor, başvurmadan önce uyumlu bir çözüm bulmaya çalışın
bu özelliğe.

EDİTÖR ENTEGRASYON

Kullanım kolaylığı için, "perlcritic" favori metin düzenleyicinizle entegre edilebilir. bu
"perlcritic"in çıktı biçimlendirme yetenekleri, özellikle
"emacs" ve "vim" gibi düzenleyicilerde bulunan "grep" veya "derleme" modları. Bu modlarda,
keyfi bir komut çalıştırabilirsiniz ve düzenleyici çıktıyı etkileşimli bir
üzerine tıklayabileceğiniz ve ilgili kod satırına atlayabileceğiniz arabellek.

Perl::Critic ekibi, Perl-Critic'i kendi programlarıyla entegre etmeye yardımcı olan herkese teşekkür eder.
favori editör Özellikle katkılarınız Perl-Critic'i kullanışlı ve
Her türden Perl geliştiricileri için kullanıcı dostu bir araç. Zorluğunuzu içtenlikle takdir ediyoruz
çalışır.

EMACS
Joshua ben Jore, üzerinde perlcritic çalıştırmanıza izin veren emacs için küçük bir mod yazdı.
geçerli bölge veya arabellek. İsteğe bağlı olarak çalıştırabilir veya çalışacak şekilde yapılandırabilirsiniz.
arabelleği kaydettiğinizde otomatik olarak. Çıktı, sıcak bağlantılı bir derleyicide görünür
tampon. Kod ve kurulum talimatları şurada bulunabilir: özüt rehber
bu dağıtımın içinde.

VIM
Scott Peshak yayınladı perlchecker.vimolan
<http://www.vim.org/scripts/script.php?script_id=1731>.

gVIM
Fritz Mehner kısa süre önce fantastik gVIM eklentisine "perlcritic" desteği ekledi. İçinde
Çok Perlish bir IDE sağlamaya ek olarak, Fritz'in eklentisi tek tıklamayla erişim sağlar.
"perlcritic" ve diğer birçok faydalı yardımcı program. Ve hepsi sorunsuz bir şekilde entegre edilmiştir
editör. Tamamlamak için http: içindeki "/lug.fh-swf.de/vim /vim-perl/screenshots-en.html" bölümüne bakın
detaylar.

EPİK
EPIC, Eclipse platformuna dayalı açık kaynaklı bir Perl IDE'dir. Özellikler söz dizimini içerir
vurgulama, anında sözdizimi kontrolü, içerik yardımı, kod tamamlama, perldoc desteği,
Perl::Tidy ile kaynak biçimlendirme, kod şablonları, bir normal ifade düzenleme aracı ve
Perl hata ayıklayıcı ile entegrasyon. EPIC'in son sürümlerinde ayrıca yerleşik desteğe sahiptir
Perl :: Eleştirmen için. En az bir Perl::Critic katılımcısı EPIC'e yemin ediyor. git
<http://e-p-i-c.sourceforge.net> EPIC hakkında daha fazla bilgi için.

BBDüzenle
Josh Clark, BBEdit için mükemmel bir Perl-Critic eklentisi üretti. Görmek
<http://globalmoxie.com/projects/bbedit-perl-critic/index.shtml> indirmek için,
kurulum ve kullanım talimatları. Apple kullanıcıları sevinirler!

Komodo
Komodo, Perl ve diğer birkaç dinamik dil için tescilli bir IDE'dir. İçinde başlayan
5.1.1 sürümünde, Perl::Critic'iniz varsa Komodo'nun Perl-Critic için yerleşik desteği vardır.
ve eleştiri modülleri kuruldu. Komodo'nun ücretsiz deneme kopyaları şu adresten edinilebilir:
ActiveState web sitesindehttp://www.activestate.com>.

ActivePerl
ActivePerl, Perl'i yapılandırmak ve çalıştırmak için çok kaygan bir grafik arabirim içerir.
Eleştirmen "perlcritic-gui" olarak adlandırılır. ActivePerl'in ücretsiz bir topluluk sürümü edinilebilir
adresindeki ActiveState web sitesindenhttp://www.activestate.com>.

EXIT DURUMU

"Perlcritic"in kendisinde herhangi bir hata varsa, durum == 1 ile çıkar. Hata yoksa,
ancak "perlcritic", kaynak kodunuzda Politika ihlalleri bulur, status == ile çıkar.
hata yok ve ihlal bulunamadı, durum == 0 olan çıkışlar.

L' Perl::Eleştirmen FELSEFE

Kodlama standartları son derece kişisel ve oldukça özneldir. Perl::Critic'in amacı
bir dizi en iyi uygulamayla uyumlu kod yazmanıza yardımcı olmaktır. bizim birincil
amaç bu uygulamaların ne olduğunu dikte etmek değil,
başkaları tarafından keşfedilen uygulamalar. Sonuç olarak, kuralları siz koyarsınız -- Perl::Critic
tutarlılığı teşvik etmek için sadece bir araçtır. olduğunu düşündüğünüz bir politika varsa
önemli olan veya gözden kaçırdığımız, katkılarınız için çok minnettar oluruz veya
Perl::Critic'e kendi özel ilkelerinizi yükleyebilirsiniz.

UZATILMAK L' KRİTİK

Perl::Critic'in modüler tasarımı, yeni İlkelerin eklenmesini kolaylaştırmayı amaçlamaktadır.
ÜFE hakkında biraz bilgi sahibi olmanız gerekecek, ancak çoğu Politika modülü güzel
basit ve yalnızca yaklaşık 20 satır kod gerektirir. Lütfen bkz
Perl::Critic::DEVELOPER dosyası adım adım bu dağıtıma dahil edilmiştir.
yeni İlke modüllerinin nasıl oluşturulacağının gösterilmesi.

Herhangi bir yeni İlke modülü geliştirirseniz, bunları " adresine göndermekten çekinmeyin.[e-posta korumalı]>"
ve onları Perl::Critic dağıtımına koymayı düşünmekten mutlu olacağım. ya da eğer
Perl::Critic projesinde doğrudan çalışmak istiyorsanız, şu adresten depomuzu çatallayabilirsiniz:
http:'de "/github.com/Perl- Critic/Perl- Critic.git".

Perl::Critic ekibi de kiralanabilir. Kuruluşunuzun kendi kodlaması varsa
yerel yönergelerinizi uygulamak için özel Politikalar oluşturabiliriz. ya da senin
kod tabanı belirli bir kusur modeline eğilimlidir, yardımcı olacak İlkeler tasarlayabiliriz
bu pahalı kusurları yakalarsın önce üretime geçerler. ile ihtiyaçlarınızı görüşmek için
Perl::Eleştirmen ekibi, iletişime geçmeniz yeterli "[e-posta korumalı]>".

İLETİŞİM L' GELİŞME TAKIM

Posta listesine abone olmanız önerilir; mesaj gönder
<mailto:[e-posta korumalı]>. İstenmeyen e-postaları önlemek için şunları yapmanız gerekebilir:
mesaj göndermeye izin verilmeden önce Tigris.org'da bir kullanıcı hesabına kaydolun
mail listesi. adresindeki posta listesi arşivlerine de bakın.
<http://perlcritic.tigris.org/servlets/SummarizeList?listName=kullanıcılar>. En az bir üye
geliştirme ekibinin çoğu genellikle ve
Perl::Critic'i Twitter'da şu adresten takip edebilirsiniz: .

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