tidyallp - Online sa Cloud

PROGRAMA:

NAME

tidyall - Ang iyong all-in-one na code ay mas malinis at validator

SINOPSIS

# Lumikha ng isang tidyall.ini o .tidyallrc sa tuktok ng iyong proyekto
#
[PerlTidy]
piliin ang = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlCritic]
piliin = lib/**/*.pm
huwag pansinin = lib/UtterHack.pm
argv = -kalubhaan 3

# Iproseso ang lahat ng mga file sa kasalukuyang proyekto,
# tumingin pataas mula sa cwd para sa conf file
#
% tidyall -a

# Iproseso ang isa o higit pang partikular na mga file,
# tumingin pataas mula sa unang file para sa conf file
#
% tidyall file [file...]

# Iproseso ang isang direktoryo nang paulit-ulit
#
% tidyall -r dir

DESCRIPTION

Mayroong maraming mga mahusay na tidiers ng code at validators out doon. "tidyall" ang gumagawa sa kanila
magagamit mula sa isang pinag-isang interface.

Maaari mong patakbuhin ang "tidyall" sa isang file o sa isang buong hierarchy ng proyekto, at i-configure
kung aling mga tidiers/validators ang inilalapat sa kung aling mga file. Ang "tidyall" ay magba-back up ng mga file
bago, at para sa kahusayan ay isasaalang-alang lamang ang mga file na nagbago mula noong sila ay
huling naproseso.

Ano ang a mas malinis? Ano ang a validator?
A mas malinis binabago ang isang file upang mapabuti ang hitsura nito nang hindi binabago ang mga semantika nito.
Kasama sa mga halimbawa ang perltidy, podtidy at js-beautify
pagandahin>.

A validator sinusuri ang isang file para sa ilang kahulugan ng kawastuhan. Kasama sa mga halimbawa
perlcritic, podchecker at jshinthttp://www.jshint.com/>.

Maraming taga-ayos ay mga validator din, hal. "perltidy" ay magtapon ng isang error sa masamang nabuo
Perl.

Upang gumamit ng mas malinis o validator na may "tidyall" dapat itong magkaroon ng kaukulang klase ng plugin,
karaniwang nasa ilalim ng prefix na "Code::TidyAll::Plugin::". Ang pamamahagi na ito ay may kasamang mga plugin
para sa:

· Perl: perlcritic, perltidy, perltidy-sweet

· Pod: podchecker, podspell, podtidy

· Mason: masontidy

· JavaScript: js-beautify, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: phpcs

· Misc: Code::TidyAll::Plugin::SortLines

Tingnan ang Code::TidyAll::Plugin para sa impormasyon tungkol sa paggawa ng sarili mong plugin.

GAMIT MAGTIDYALL

Gumagana ang "tidyall" batay sa proyekto, kung saan ang isang proyekto ay isang hierarchy ng direktoryo lamang ng
mga file. Ang svn o git working directory ay karaniwang mga halimbawa ng mga proyekto.

Ang tuktok ng proyekto ay tinatawag na ugat direktoryo. Sa root directory kakailanganin mo ang isang
config file na pinangalanang "tidyall.ini" o ".tidyallrc"; ito ay tumutukoy kung paano iba't-ibang tidiers at
ilalapat ang mga validator sa mga file sa iyong proyekto.

Awtomatikong mahahanap ng "tidyall" ang iyong root directory at config file depende sa kung paano mo
tawagin mo:

"tidyall file [file...]"
Ang "tidyall" ay maghahanap pataas mula sa unang file para sa conf file.

"tidyall -p/--pipe file"
Ang "tidyall" ay maghahanap pataas mula sa tinukoy na file para sa conf file.

"tidyall -a/--all" o "tidyall -s/--svn" o "tidyall -g/--git"
Ang "tidyall" ay maghahanap pataas mula sa kasalukuyang gumaganang direktoryo para sa conf file.

"tidyall -a --root-dir dir"
Aasahan ng "tidyall" na mahanap ang conf file sa tinukoy na root directory.

Maaari mo ring ipasa ang --conf-name upang baguhin ang pangalan na hinahanap, o --conf-file sa
tukuyin ang isang tahasang landas.

Configuration

Ang config file ("tidyall.ini" o ".tidyallrc") ay nasa format na Config::INI. Narito ang isang
halimbawang:

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

[PerlCritic]
piliin = lib/**/*.pm
huwag pansinin = lib/UtterHack.pm lib/OneTime/*.pm
argv = -kalubhaan 3

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

Sa pagkakasunud-sunod, ipinapahayag ng tatlong seksyon:

· Ilapat ang "PerlTidy" na may mga setting na "-noll -it=2" sa lahat ng *.pl, *.pm, at *.t file.

· Ilapat ang "PerlCritic" na may kalubhaan 3 sa lahat ng Perl module sa isang lugar sa ilalim ng "lib/",
maliban sa "lib/UtterHack.pm".

· Ilapat ang "PodTidy" na may mga default na setting sa lahat ng *.pm at *.pod file sa ilalim ng "lib/".

pamantayan configuration mga elemento
[class] o [class description]
Ang header ng bawat seksyon ay tumutukoy sa isang maayos isaksak. Ang pangalan ay awtomatikong
prefixed na may "Code::TidyAll::Plugin::" maliban kung ito ay nagsisimula sa isang '+', hal.

; Gumagamit ng plugin Code::TidyAll::Plugin::PerlTidy
;
[PerlTidy]

; Gumagamit ng plugin My::TidyAll::Plugin
;
[+My::TidyAll::Plugin]

Maaari ka ring magsama ng opsyonal na paglalarawan pagkatapos ng klase. Ang paglalarawan ay magiging
hindi pinansin at ang unang salita lang ang gagamitin para sa plugin. Ito ay nagbibigay-daan sa iyo sa isang listahan
isang plugin nang higit sa isang beses, na may iba't ibang configuration sa bawat pagkakataon. Halimbawa, dalawa
iba't ibang mga pagsasaayos ng "PerlCritic":

; Maging brutal sa mga aklatan
;
[Mahigpit ang PerlCritic]
piliin = lib/**/*.pm
argv = --brutal

; ngunit malumanay sa mga script
;
[PerlCritic maluwag sa loob]
piliin = bin/**/*.pl
argv = --magiliw

Babala: Kung ililista mo lang ang parehong plugin nang dalawang beses nang walang paglalarawan (o pareho
paglalarawan), ang isa sa kanila ay tahimik na hindi papansinin.

piliin
Isa o higit pang File::Zglob pattern, na pinaghihiwalay ng whitespace o sa maraming linya,
na nagpapahiwatig kung aling mga file ang pipiliin. Hindi bababa sa isa ang kailangan. hal

; Lahat ng .t at .pl sa isang lugar sa ilalim ng bin at t;
; kasama ang lahat ng .pm na file nang direkta sa ilalim ng lib/Foo at lib/Bar
;
piliin = {bin,t}/**/*.p[lm]
piliin = lib/{Foo,Bar}/*.pm

; Lahat ng .txt file saanman sa proyekto
;
piliin ang = **/*.txt

Ang pattern ay nauugnay sa root directory at hindi dapat magkaroon ng leading slash. Lahat
gagana ang mga karaniwang glob na character ("*", "?", "[]", "{}"); bilang karagdagan, ang "**" ay maaaring
ginamit upang kumatawan sa zero o higit pang mga direktoryo. Tingnan ang File::Zglob na dokumentasyon para sa higit pa
mga detalye.

huwag pansinin
Isa o higit pang File::Zglob pattern, na pinaghihiwalay ng whitespace o sa maraming linya,
na nagpapahiwatig kung aling mga file ang hindi dapat pansinin. Ito ay opsyonal at ino-override ang "piliin". hal

; Lahat ng .pl file kahit saan sa ilalim ng bin, maliban sa bin/awful.pl o kahit saan
; sa ilalim ng bin/tmp
;
piliin = bin/**/*.pl
huwag pansinin = bin/awful.pl bin/tmp/**/*.pl

shebang
Isa o higit pang mga salita, na pinaghihiwalay ng whitespace o sa maraming linya, na nagsasaad kung alin
shebang lines para tanggapin. Ito ay opsyonal at ang karagdagang mga filter ay "piliin". hal

; Lahat ng mga file na walang extension kahit saan sa ilalim ng bin na may kasamang "perl" o
; "perl5" shebang line.
piliin = bin/**/*
huwag pansinin = bin/**/*.*
shebang = perl perl5

only_modes
Isang listahan ng mga mode, na pinaghihiwalay ng whitespace. hal

only_modes = pagsubok cli

Ang plugin ay lamang tumakbo kung ang isa sa mga mode na ito ay ipinasa sa "tidyall" sa pamamagitan ng "-m" o
"--mode".

maliban sa_mga mode
Isang listahan ng mga mode, na pinaghihiwalay ng whitespace. hal

except_modes = gumawa ng editor

Ang plugin ay hindi tumakbo kung ang isa sa mga mode na ito ay ipinasa sa "tidyall" sa pamamagitan ng "-m" o
"--mode".

argv
Maraming mga plugin (tulad ng perltidy, perlcritic at podtidy) ang gumagamit ng opsyong ito, na
tumutukoy sa mga argumentong ipapasa sa pinagbabatayan na command-line utility.

timbang
Ito ay isang integer na ginagamit upang pagbukud-bukurin ang mga plugin. Bilang default, ang mas maayos na mga plugin ay tumatakbo muna,
pagkatapos ay mga validator plugin, na ang bawat pangkat ay pinagsunod-sunod ayon sa alpabeto.

ISAKSAK ORDER AT ATOMICITY

Kung maraming plugin ang tumugma sa isang file, ang mga tidier ay inilalapat bago ang mga validator upang ang mga validator
sinusuri ang huling resulta. Sa loob ng dalawang pangkat na iyon, inilalapat ang mga plugin
alpabetikong pagkakasunud-sunod ayon sa pangalan/paglalarawan ng plugin.

Maaari mo ring tahasang itakda ang bigat ng bawat plugin. Bilang default, ang tidiers ay may timbang
ng 50 at ang mga validator ay may timbang na 60. Maaari mong itakda ang timbang sa anumang integer sa
impluwensya kapag tumatakbo ang plugin.

Ang application ng maramihang mga plugin ay lahat-o-wala. Kung may naganap na error sa panahon ng
application ng anumang plugin, ang file ay hindi nabago sa lahat.

COMMAND-LINE Opsyon

-a, --lahat
Iproseso ang lahat ng mga file. Gumagawa ng isang recursive na paghahanap para sa lahat ng mga file sa hierarchy ng proyekto,
simula sa ugat, at pinoproseso ang anumang file na tumutugma sa kahit isang plugin sa
pagsasaayos.

-g, --git
Iproseso ang lahat ng idinagdag o binagong mga file sa kasalukuyang git working directory.

-h, --tulong
Mag-print ng mensahe ng tulong

-l, --listahan
Ilista ang bawat file kasama ang listahan ng mga plugin na katugma nito (mga file na walang anumang tugma
ay nilaktawan). Hindi aktwal na nagpoproseso ng anumang mga file at walang pakialam kung ang mga file ay
naka-cache. Karaniwang ginagamit sa -a, -g, o -seg

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

-m, --mode
Opsyonal na mode na maaaring makaapekto kung aling mga plugin ang tumatakbo. Default sa "cli". Tingnan ang "MODES".

-p landas, --pipe path
Basahin ang nilalaman mula sa STDIN at isulat ang nagresultang nilalaman sa STDOUT. Kung matagumpay,
paglabas ng tidyall na may status na 0. Kung may naganap na error, ilalabas ng tidyall ang mensahe ng error sa
STDERR, mirrors ang input nilalaman sa STDOUT na walang pagbabago, at lalabas na may status 1.
Ang pag-mirror ay nangangahulugan na maaari mong ligtas na mag-pipe sa iyong patutunguhan kahit na
isang error ang nangyayari.

Kapag tinukoy ang opsyong ito dapat mong tukuyin ang eksaktong isang filename, kamag-anak o
absolute, na gagamitin upang matukoy kung aling mga plugin ang ilalapat at kung saan din ang
root directory at configuration file ay. Hindi talaga mababasa at mababasa ang file
kailangan kahit kailangan na umiral.

Ang pagpipiliang ito ay nagpapahiwatig --no-backups at --no-cache (dahil walang aktwal na file) at
--tahimik (dahil hindi namin gustong paghaluin ang extraneous na output sa naayos na resulta).

# Magbasa mula sa STDIN at sumulat sa STDOUT, na may naaangkop na mga plugin
# para sa ilang/path.pl (na hindi kailangang umiral)
#
% tidyall --pipe some/path.pl

-r, --recursive
Recursively ipasok ang anumang mga direktoryo na nakalista sa command-line at iproseso ang lahat ng mga file
sa loob ng. Bilang default, ang mga direktoryo na nakatagpo sa command-line ay bubuo ng a
babala.

-s, --svn
Iproseso ang lahat ng idinagdag o binagong mga file sa kasalukuyang svn working directory.

-q, --tahimik
Pigilan ang output maliban sa mga error.

-v, --verbose
Magpakita ng karagdagang output.

-I landas1, landas2,...
Magdagdag ng isa o higit pang mga path ng library sa @INC, tulad ng -I ni Perl. Kapaki-pakinabang kung --tidyall-class o
ang mga plugin ay nasa isang alternatibong direktoryo ng lib.

--backup-ttl tagal
Tagal ng oras bago ma-purge ang mga backup na file. Maaaring ilang segundo o anuman
string na kinikilala ng Time::Duration::Parse, hal. "4h" o "1day". Default sa "1h".

--check-lamang
Sa halip na aktwal na ayusin ang mga file, suriin kung ang bawat file ay inayos (ibig sabihin, kung ito ay inayos
ang bersyon ay katumbas ng kasalukuyang bersyon nito) at ituring itong isang error kung hindi. Ito ay ginagamit
sa pamamagitan ng Pagsubok::Code::TidyAll at ang svn at git pre-commit hook, halimbawa, upang ipatupad
na inayos mo ang iyong mga file.

--conf-file landas
Tukuyin ang kamag-anak o ganap na landas sa conf file, sa halip na hanapin ito sa
karaniwang paraan.

--conf-pangalan pangalan
Tumukoy ng conf file name na hahanapin sa halip na ang mga default ("tidyall.ini" /
".tidyallrc").

--data-dir landas
Naglalaman ng data tulad ng mga backup at cache. Default sa root_dir/.tidyall.d

--mga pag-ulit bilangin
Patakbuhin ang bawat mas malinis na pagbabago bilangin beses. Ang default ay 1.

Sa ilang mga kaso (sana ay bihira) ang output mula sa isang mas malinis ay maaaring iba kung ito ay
inilapat nang maraming beses. Maaaring gusto mong magsagawa ng maraming pag-ulit upang matiyak na ang
content "settles" into its final tidied form -- lalo na kung ang pagiging malinis
ipinapatupad gamit ang version-control hook o isang pagsubok. Siyempre, magdurusa ang pagganap a
maliit. Dapat ay bihirang kailanganin mong itakda ito nang mas mataas sa 2.

Nakakaapekto lamang ito sa mga mas malinis, hindi mga validator; hal perlcritic at jshint gusto pa rin
isang beses lang tatakbo.

--walang-backup
Huwag i-backup ang mga file bago iproseso.

--walang-cache
Huwag i-cache ang mga huling oras na naproseso; iproseso ang lahat ng mga file sa bawat oras. Tingnan din
"--refresh-cache".

--output-suffix suffix
Suffix na idaragdag sa isang filename bago i-output ang binagong bersyon, hal. ".tdy".
Ang default ay wala, na nangangahulugang i-overwrite ang file.

--refresh-cache
Burahin ang anumang umiiral na impormasyon sa cache bago iproseso ang bawat file, pagkatapos ay magsulat ng bagong impormasyon sa cache.
Tingnan din ang "--no-cache".

--ugat-dir
Tahasang tukuyin ang root directory. Kadalasan ito ay hinuha mula sa mga tinukoy na file
o ang kasalukuyang gumaganang direktoryo.

--tidyall-class klase
Subclass na gagamitin sa halip na "Code::TidyAll".

Tinutukoy pagpipilian in configuration
Halos anumang command-line na opsyon ay maaaring tukuyin sa tuktok ng config file, sa itaas ng
mga seksyon ng plugin. Palitan ang mga gitling ng mga salungguhit. hal

backup_ttl = 4h
mga pag-ulit = 2
tidyall_class = My::Code::TidyAll

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

...

Kung ang isang opsyon ay ipinasa sa parehong mga lugar, ang command-line ay mauuna.

EXIT STATUS

Ang "tidyall" ay lalabas na may status 1 kung may anumang mga error na naganap habang pinoproseso ang mga file, at 0
kung hindi man.

mode

Maaari mong gamitin ang tidyall sa maraming magkakaibang konteksto, at maaaring hindi mo gustong patakbuhin ang lahat
mga plugin sa lahat ng mga ito.

Maaari kang magpasa ng mode para mag-ayos sa pamamagitan ng "-m" o "--mode", at pagkatapos ay tukuyin ang ilang partikular na plugin.
dapat lang tumakbo sa ilang partikular na mode (sa pamamagitan ng "only_modes") o dapat na tumakbo sa lahat maliban sa tiyak
mga mode (sa pamamagitan ng "except_modes").

Mga halimbawa ng mga mode:

· "cli" - kapag tahasan ang pag-invoke ng tidyall mula sa command-line na walang tinukoy na mode

· "editor" - kapag tumatawag mula sa isang editor

· "commit" - kapag gumagamit ng commit hook tulad ng Code::TidyAll::SVN::Precommit o
Code::TidyAll::Git::Precommit

· "test" - kapag gumagamit ng Test::Code::TidyAll

Ngayon dahil medyo nakakaubos ng oras ang perlcritic, maaaring gusto mo lang itong patakbuhin sa panahon ng mga pagsubok
at tahasang command-line invocation:

[PerlCritic]
piliin = lib/**/*.pm
only_modes = pagsubok cli
...

O maaari mong tukuyin na ito ay tatakbo sa lahat ng mga mode maliban Ang tagaayos:

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

Kung hindi mo tinukoy ang alinman sa "only_modes" o "except_modes" para sa isang plugin, ito ay palaging
tumakbo.

HULING NAPROSESO CACHE

Sinusubaybayan ng "tidyall" ang pirma ng bawat file pagkatapos itong huling maproseso. Sa kasunod
tumatakbo, magpoproseso lamang ito ng file kung nagbago ang lagda nito. Ang cache ay pinananatili sa mga file
sa ilalim ng data dir.

Maaari mong pilitin ang pag-refresh ng cache gamit ang "--refresh-cache", o i-off ang gawi
ganap na may "--no-cache".

MGA BACKUP

I-backup ng "tidyall" ang bawat file bago ito baguhin. Ang mga timestamped backup ay pinananatili sa a
hiwalay na hierarchy ng direktoryo sa ilalim ng dir ng data.

Awtomatikong pupunuin ang mga lumang backup na file bilang bahagi ng paminsan-minsang "tidyall" na pagtakbo. Ang
Ang tagal na tinukoy sa "--backup-ttl" ay nagpapahiwatig ng parehong minimum na dami ng oras ng pag-backup
dapat panatilihin, at ang dalas ng paglilinis ay dapat patakbuhin. Ito ay maaaring tukuyin bilang "30m"
o "4 na oras" o anumang string na katanggap-tanggap sa Time::Duration::Parse. Nagde-default ito sa "1h" (1
oras).

Maaari mong i-off ang mga backup gamit ang "--no-backups".

"NAWALA" PREREQS

Ang pamamahagi ng "Code::TidyAll" ay sadyang hindi nakadepende sa mga kinakailangan para sa
bawat plugin. Nangangahulugan ito na kung gusto mong gamitin ang perltidy, dapat mong i-install ang
Perl::Manu-manong linisin ang module.

ΣΧΕΤΙΖΕΤΑΙ TOOL

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

sa pamamahagi na ito ay naglalaman ng mga Emac at Vim na utos para sa pagpapatakbo ng "tidyall" sa
kasalukuyang buffer. Maaari mong italaga ito sa keystroke na iyong pinili (hal. ctrl-t o
,t).

· Code::TidyAll::SVN::Precommit ay nagpapatupad ng subversion pre-commit hook na tumitingin kung
lahat ng mga file ay inayos at wasto ayon sa "tidyall", at tinatanggihan ang commit kung hindi.

· Code::TidyAll::Git::Precommit at Code::TidyAll::Git::Prereceive implement git pre-
commit at pre-receive hook, ayon sa pagkakabanggit, na tumitingin kung ang lahat ng mga file ay inayos at
wasto ayon sa "tidyall".

· Test::Code::TidyAll ay isang testing library upang suriin kung ang lahat ng mga file sa iyong proyekto
ay nasa maayos at wastong estado.

KILALA TUMBOK

· Hindi pa gumagana sa Windows

Gumamit ng tidyallp online gamit ang mga serbisyo ng onworks.net