tidyallp - Dalam talian di Awan

JADUAL:

NAMA

tidyall - Kod semua-dalam-satu anda lebih kemas dan pengesah

SINOPSIS

# Buat tidyall.ini atau .tidyallrc di bahagian atas projek anda
#
[PerlTidy]
pilih = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlCritic]
pilih = lib/**/*.pm
abaikan = lib/UtterHack.pm
argv = -keterukan 3

# Proses semua fail dalam projek semasa,
# lihat ke atas dari cwd untuk fail conf
#
% kemas -a

# Proses satu atau lebih fail khusus,
# lihat ke atas dari fail pertama untuk fail conf
#
% fail kemas [fail...]

# Proses direktori secara rekursif
#
% tidyall -r dir

DESCRIPTION

Terdapat banyak pengemas dan pengesah kod yang hebat di luar sana. "kemas" membuat mereka
tersedia daripada satu antara muka bersatu.

Anda boleh menjalankan "tidyall" pada satu fail atau pada keseluruhan hierarki projek, dan konfigurasikan
pengemas/pengesah yang mana digunakan pada fail mana. "tidyall" akan menyandarkan fail
terlebih dahulu, dan untuk kecekapan hanya akan mempertimbangkan fail yang telah berubah sejak ia berubah
terakhir diproses.

Apa itu a lebih kemas? Apa itu a pengesah?
A lebih kemas mengubah fail untuk memperbaiki penampilannya tanpa mengubah semantiknya.
Contohnya termasuk perltidy, podtidy dan js-beautify
mencantikkan>.

A validator menganalisis fail untuk beberapa definisi ketepatan. Contohnya termasuk
perlcritic, podchecker dan jshinthttp://www.jshint.com/>.

Ramai pengemas juga merupakan pengesah, contohnya "perltidy" akan membuang ralat pada yang terbentuk dengan teruk
Perl.

Untuk menggunakan tidier atau validator dengan "tidyall" ia mesti mempunyai kelas pemalam yang sepadan,
biasanya di bawah awalan "Kod::TidyAll::Plugin::". Pengedaran ini disertakan dengan pemalam
untuk:

· Perl: perlcritic, perltidy, perltidy-sweet

· Pod: podchecker, podspell, podtidy

· Mason: masontify

· JavaScript: js-beautify, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: phpcs

· Lain-lain: Kod::TidyAll::Plugin::Sortlines

Lihat Kod::TidyAll::Plugin untuk mendapatkan maklumat tentang membuat pemalam anda sendiri.

MENGGUNAKAN KEMAS

"tidyall" berfungsi berdasarkan projek, di mana projek hanyalah hierarki direktori
fail. Direktori kerja svn atau git ialah contoh tipikal projek.

Bahagian atas projek itu dipanggil akar direktori. Dalam direktori akar anda memerlukan a
fail konfigurasi bernama "tidyall.ini" atau ".tidyallrc"; ia mentakrifkan bagaimana pelbagai kemas dan
pengesah akan digunakan pada fail dalam projek anda.

"tidyall" akan mencari direktori root dan fail konfigurasi anda secara automatik bergantung pada cara anda
panggilnya:

"fail kemas [fail...]"
"tidyall" akan mencari ke atas dari fail pertama untuk fail conf.

"fail kemas -p/--paip"
"tidyall" akan mencari ke atas dari fail yang ditentukan untuk fail conf.

"tidyall -a/--all" atau "tidyall -s/--svn" atau "tidyall -g/--git"
"tidyall" akan mencari ke atas dari direktori kerja semasa untuk fail conf.

"kemas -a --root-dir dir"
"tidyall" akan mengharapkan untuk mencari fail conf dalam direktori akar yang ditentukan.

Anda juga boleh menghantar --conf-name untuk menukar nama yang dicari, atau --conf-file kepada
tentukan laluan eksplisit.

CONFIGURATION

Fail konfigurasi ("tidyall.ini" atau ".tidyallrc") berada dalam format Config::INI. Inilah a
contoh:

[PerlTidy]
pilih = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlCritic]
pilih = lib/**/*.pm
abaikan = lib/UtterHack.pm lib/OneTime/*.pm
argv = -keterukan 3

[PodTidy]
pilih = lib/**/*.{pm,pod}

Dalam susunan, tiga bahagian mengisytiharkan:

· Gunakan "PerlTidy" dengan tetapan "-noll -it=2" pada semua fail *.pl, *.pm dan *.t.

· Gunakan "PerlCritic" dengan keterukan 3 pada semua modul Perl di suatu tempat di bawah "lib/",
kecuali untuk "lib/UtterHack.pm".

· Gunakan "PodTidy" dengan tetapan lalai pada semua fail *.pm dan *.pod di bawah "lib/".

Standard konfigurasi unsur-unsur
[kelas] atau [huraian kelas]
Tajuk setiap bahagian merujuk kepada kemas Pasangkan. Nama itu secara automatik
diawali dengan "Kod::TidyAll::Plugin::" melainkan ia bermula dengan '+', cth

; Menggunakan pemalam Kod::TidyAll::Plugin::PerlTidy
;
[PerlTidy]

; Menggunakan pemalam My::TidyAll::Plugin
;
[+Saya::TidyAll::Plugin]

Anda juga boleh memasukkan penerangan pilihan selepas kelas. Penerangan akan menjadi
diabaikan dan hanya perkataan pertama akan digunakan untuk pemalam. Ini membolehkan anda membuat senarai
pemalam lebih daripada sekali, dengan konfigurasi berbeza setiap kali. Sebagai contoh, dua
konfigurasi "PerlCritic" yang berbeza:

; Berlaku kejam di perpustakaan
;
[PerlCritic tegas]
pilih = lib/**/*.pm
argv = --brutal

; tetapi lembut pada skrip
;
[PerlCritic berlembut]
pilih = bin/**/*.pl
argv = --lembut

Amaran: Jika anda hanya menyenaraikan pemalam yang sama dua kali tanpa penerangan (atau pemalam yang sama
penerangan), salah satu daripadanya akan diabaikan secara senyap.

pilih
Satu atau lebih corak Fail::Zglob, dipisahkan oleh ruang putih atau pada berbilang baris,
menunjukkan fail yang hendak dipilih. Sekurang-kurangnya satu diperlukan. cth

; Semua .t dan .pl di suatu tempat di bawah tong dan t;
; serta semua fail .pm terus di bawah lib/Foo dan lib/Bar
;
pilih = {bin,t}/**/*.p[lm]
pilih = lib/{Foo,Bar}/*.pm

; Semua fail .txt di mana-mana dalam projek
;
pilih = **/*.txt

Corak adalah relatif kepada direktori akar dan tidak sepatutnya mempunyai garis miring utama. Semua
aksara glob standard ("*", "?", "[]", "{}") akan berfungsi; sebagai tambahan, "**" boleh
digunakan untuk mewakili sifar atau lebih direktori. Lihat Dokumentasi Fail::Zglob untuk maklumat lanjut
butiran.

mengabaikan
Satu atau lebih corak Fail::Zglob, dipisahkan oleh ruang putih atau pada berbilang baris,
menunjukkan fail mana yang harus diabaikan. Ini adalah pilihan dan menggantikan "pilih". cth

; Semua fail .pl di mana-mana di bawah tong, kecuali bin/awful.pl atau di mana-mana sahaja
; di bawah bin/tmp
;
pilih = bin/**/*.pl
abaikan = bin/awful.pl bin/tmp/**/*.pl

shebang
Satu atau lebih perkataan, dipisahkan oleh ruang putih atau pada berbilang baris, menunjukkan yang mana
garisan shebang untuk diterima. Ini adalah pilihan dan penapis lanjut "pilih". cth

; Semua fail tanpa sambungan di mana-mana di bawah tong yang termasuk "perl" atau
; "perl5" baris shebang.
pilih = bin/**/*
abaikan = bin/**/*.*
shebang = perl perl5

only_modes
Senarai mod, dipisahkan oleh ruang putih. cth

only_modes = ujian cli

Pemalam akan hanyalah jalankan jika salah satu mod ini dihantar ke "kemas" melalui "-m" atau
"--mod".

kecuali_mod
Senarai mod, dipisahkan oleh ruang putih. cth

except_modes = editor komit

Pemalam akan tidak jalankan jika salah satu mod ini dihantar ke "kemas" melalui "-m" atau
"--mod".

argv
Banyak pemalam (seperti perltidy, perlcritic dan podtidy) menggunakan pilihan ini, yang
menentukan hujah untuk dihantar ke utiliti baris arahan yang mendasari.

berat
Ini ialah integer yang digunakan untuk mengisih pemalam. Secara lalai, pemalam yang lebih kemas dijalankan dahulu,
kemudian pemalam validator, dengan setiap kumpulan diisih mengikut abjad.

PASANGKAN PERINTAH DAN ATOMICITY

Jika berbilang pemalam sepadan dengan fail, pengemasan digunakan sebelum pengesah supaya pengesah
sedang menyemak keputusan akhir. Dalam dua kumpulan tersebut, pemalam digunakan dalam
susunan abjad mengikut nama/huraian pemalam.

Anda juga boleh menetapkan berat setiap pemalam secara eksplisit. Secara lalai, pengemas mempunyai berat
daripada 50 dan pengesah mempunyai berat 60. Anda boleh menetapkan berat kepada mana-mana integer kepada
pengaruh apabila pemalam berjalan.

Aplikasi berbilang pemalam adalah semua-atau-tiada. Jika ralat berlaku semasa
aplikasi mana-mana pemalam, fail itu tidak diubah suai sama sekali.

TALIAN PERINTAH PILIHAN

-a, --semua
Proses semua fail. Adakah carian rekursif untuk semua fail dalam hierarki projek,
bermula pada akar, dan memproses mana-mana fail yang sepadan dengan sekurang-kurangnya satu pemalam dalam
konfigurasi.

-g, --git
Proses semua fail yang ditambah atau diubah suai dalam direktori kerja git semasa.

-h, --bantuan
Cetak mesej bantuan

-l, --senarai
Senaraikan setiap fail bersama-sama dengan senarai pemalam yang sepadan (fail tanpa sebarang padanan
dilangkau). Sebenarnya tidak memproses sebarang fail dan tidak peduli sama ada fail
dicache. Biasanya digunakan dengan -a, -g, atau -seg

% kemas -a -l
lib/CHI.pm (PerlCritic, PerlTidy, PodTidy)
lib/CHI/Benchmarks.pod (PodTidy)
lib/CHI/CacheObject.pm (PerlCritic, PerlTidy, PodTidy)

-m, --mod
Mod pilihan yang boleh menjejaskan pemalam yang dijalankan. Lalai kepada "cli". Lihat "MOD".

-p laluan, --laluan paip
Baca kandungan daripada STDIN dan tulis kandungan yang terhasil ke STDOUT. Jika berjaya,
tidyall keluar dengan status 0. Jika ralat berlaku, tidyall mengeluarkan mesej ralat kepada
STDERR, cermin yang input kandungan ke STDOUT tanpa perubahan, dan keluar dengan status 1.
Pencerminan bermakna anda boleh menghantar paip ke destinasi anda dengan selamat tanpa mengira sama ada
ralat berlaku.

Apabila menentukan pilihan ini, anda mesti menentukan dengan tepat satu nama fail, relatif atau
mutlak, yang akan digunakan untuk menentukan pemalam yang hendak digunakan dan juga di mana
direktori akar dan fail konfigurasi adalah. Fail itu sebenarnya tidak akan dibaca dan dilakukan
perlu malah perlu wujud.

Pilihan ini membayangkan --no-backups dan --no-cache (kerana tiada fail sebenar) dan
--quiet (kerana kita tidak mahu mencampurkan output luar dengan hasil kemas).

# Baca daripada STDIN dan tulis ke STDOUT, dengan pemalam yang sesuai
# untuk beberapa/path.pl (yang tidak perlu wujud)
#
% tidyall --pipe some/path.pl

-r, --rekursif
Masukkan secara rekursif mana-mana direktori yang disenaraikan pada baris arahan dan proses semua fail
dalam. Secara lalai, direktori yang ditemui pada baris arahan akan menjana a
amaran.

-s, --svn
Proses semua fail yang ditambah atau diubah suai dalam direktori kerja svn semasa.

-q, --senyap
Sekat output kecuali ralat.

-v, --verbose
Tunjukkan output tambahan.

-I laluan1, laluan2,...
Tambahkan satu atau lebih laluan pustaka ke @INC, seperti Perl's -I. Berguna jika --tidyall-class atau
pemalam berada dalam direktori lib alternatif.

--sandaran-ttl tempoh
Tempoh masa sebelum fail sandaran boleh dibersihkan. Boleh menjadi beberapa saat atau mana-mana
rentetan yang diiktiraf oleh Masa::Tempoh::Uraikan, cth "4j" atau "1hari". Lalai kepada "1j".

--semak sahaja
Daripada benar-benar mengemas fail, semak sama ada setiap fail dikemaskan (iaitu jika ia kemas
versi adalah sama dengan versi semasanya) dan anggap ia ralat jika tidak. Ini digunakan
oleh Test::Code::TidyAll dan cangkuk prakomit svn dan git, sebagai contoh, untuk menguatkuasakan
bahawa anda telah mengemas fail anda.

--conf-file jalan
Tentukan laluan relatif atau mutlak ke fail conf, bukannya mencarinya dalam fail
cara biasa.

--conf-nama nama
Tentukan nama fail conf untuk dicari dan bukannya lalai ("tidyall.ini" /
".tidyallrc").

--data-dir jalan
Mengandungi data seperti sandaran dan cache. Lalai kepada root_dir/.tidyall.d

--lelaran mengira
Jalankan setiap transformasi yang lebih kemas mengira kali. Lalai ialah 1.

Dalam sesetengah kes (mudah-mudahan jarang berlaku) output daripada yang lebih kemas boleh berbeza jika ia
digunakan beberapa kali. Anda mungkin mahu melakukan berbilang lelaran untuk memastikan
kandungan "mendap" ke dalam bentuk kemas terakhir -- terutamanya jika kekemasan sedang berlaku
dikuatkuasakan dengan cangkuk kawalan versi atau ujian. Sudah tentu, prestasi akan terjejas a
sedikit. Anda sepatutnya jarang perlu menetapkan ini lebih tinggi daripada 2.

Ini hanya memberi kesan kepada pengemas, bukan pengesah; contohnya perlcritic dan jshint akan tetap
hanya dijalankan sekali sahaja.

--tiada-sandaran
Jangan sandarkan fail sebelum diproses.

--tiada-cache
Jangan cache masa terakhir diproses; memproses semua fail setiap masa. Lihat juga
"--refresh-cache".

--keluaran-akhiran akhiran
Akhiran untuk ditambahkan pada nama fail sebelum mengeluarkan versi yang diubah suai, cth ".tdy".
Lalai tiada, yang bermaksud tulis ganti fail.

--refresh-cache
Padamkan sebarang maklumat cache sedia ada sebelum memproses setiap fail, kemudian tulis maklumat cache baharu.
Lihat juga "--no-cache".

--root-dir
Tentukan direktori akar secara eksplisit. Biasanya ini disimpulkan daripada fail yang ditentukan
atau direktori kerja semasa.

--kelas kemas kelas
Subkelas untuk digunakan dan bukannya "Kod::TidyAll".

Menentukan pilihan in konfigurasi
Hampir mana-mana pilihan baris perintah boleh ditentukan di bahagian atas fail konfigurasi, di atas fail
bahagian pemalam. Gantikan sempang dengan garis bawah. cth

backup_ttl = 4j
lelaran = 2
tidyall_class = Saya::Kod::TidyAll

[PerlTidy]
pilih = **/*.{pl,pm,t}
argv = -noll -it=2

...

Jika pilihan diluluskan di kedua-dua tempat, baris arahan diutamakan.

EXIT STATUS

"tidyall" akan keluar dengan status 1 jika sebarang ralat berlaku semasa memproses fail, dan 0
sebaliknya.

MODUL

Anda boleh menggunakan tidyall dalam beberapa konteks yang berbeza, dan anda mungkin tidak mahu menjalankan semua
pemalam dalam kesemuanya.

Anda boleh menghantar mod kepada kemas melalui "-m" atau "--mode", dan kemudian nyatakan bahawa pemalam tertentu
hanya boleh dijalankan dalam mod tertentu (melalui "only_modes") atau harus dijalankan dalam semua kecuali tertentu
mod (melalui "except_modes").

Contoh mod:

· "cli" - apabila menggunakan tidyall secara eksplisit daripada baris arahan tanpa mod yang ditentukan

· "editor" - apabila memohon daripada editor

· "komit" - apabila menggunakan cangkuk komit seperti Code::TidyAll::SVN::Precommit atau
Kod::TidyAll::Git::Prakomit

· "ujian" - apabila menggunakan Test::Code::TidyAll

Sekarang memandangkan perlcritic agak memakan masa, anda mungkin hanya mahu menjalankannya semasa ujian
dan seruan baris perintah yang jelas:

[PerlCritic]
pilih = lib/**/*.pm
only_modes = ujian cli
...

Atau anda boleh menentukan bahawa ia dijalankan dalam semua mod kecuali editor:

[PerlCritic]
pilih = lib/**/*.pm
except_modes = editor
...

Jika anda tidak menentukan "only_modes" atau "except_modes" untuk pemalam, maka ia akan sentiasa
berjalan.

TERAKHIR DIPROSES CACHE

"tidyall" menjejaki setiap tandatangan fail selepas ia terakhir diproses. Pada seterusnya
berjalan, ia hanya akan memproses fail jika tandatangannya telah berubah. Cache disimpan dalam fail
di bawah dir data.

Anda boleh memaksa muat semula cache dengan "--refresh-cache", atau mematikan tingkah laku
sepenuhnya dengan "--no-cache".

SANDARAN

"tidyall" akan membuat sandaran setiap fail sebelum mengubah suainya. Sandaran bercap masa disimpan dalam a
hierarki direktori berasingan di bawah dir data.

Fail sandaran lama akan dibersihkan secara automatik sebagai sebahagian daripada "kemas" berjalan sekali-sekala. The
tempoh yang dinyatakan dalam "--backup-ttl" menunjukkan kedua-dua jumlah minimum masa sandaran
hendaklah disimpan, dan kekerapan pembersihan harus dijalankan. Ia boleh dinyatakan sebagai "30m"
atau "4 jam" atau mana-mana rentetan yang boleh diterima oleh Time::Duration::Parse. Ia lalai kepada "1j" (1
jam).

Anda boleh mematikan sandaran dengan "--no-backups".

"HILANG" PREREQS

Pengedaran "Kod::TidyAll" dengan sengaja tidak bergantung pada prasyarat yang diperlukan
setiap pemalam. Ini bermakna jika anda ingin menggunakan perltidy, anda mesti memasang
Perl::Modul kemas secara manual.

BERKAITAN TOOLS

· dll/editors/tidyall.el
tidyall/master/etc/editors/tidyall.el> and etc/editors/tidyall.vim

dalam pengedaran ini mengandungi arahan Emacs dan Vim untuk menjalankan "kemas" pada
penimbal semasa. Anda boleh menetapkan ini pada ketukan kekunci pilihan anda (cth ctrl-t atau
,t).

· Kod::TidyAll::SVN::Precommit melaksanakan cangkuk prakomit subversi yang menyemak sama ada
semua fail dikemaskan dan sah mengikut "tidyall", dan menolak komit jika tidak.

· Kod::TidyAll::Git::Prakomit dan Kod::TidyAll::Git::Prerima melaksanakan git pra-
komit dan pra-terima cangkuk, masing-masing, yang memeriksa sama ada semua fail dikemaskan dan
sah mengikut "kemas".

· Ujian::Kod::TidyAll ialah perpustakaan ujian untuk menyemak sama ada semua fail dalam projek anda
berada dalam keadaan kemas dan sah.

DIKENALI BUANG

· Belum berfungsi pada Windows

Gunakan tidyallp dalam talian menggunakan perkhidmatan onworks.net