tidyallp — online w chmurze

PROGRAM:

IMIĘ

tidyall — Twój wszechstronny program do porządkowania i sprawdzania poprawności kodu

STRESZCZENIE

# Utwórz tidyall.ini lub .tidyallrc na górze swojego projektu
#
[Perłowy porządek]
wybierz = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlKrytyk]
wybierz = lib/**/*.pm
zignoruj ​​= lib/UtterHack.pm
argv = -powaga 3

# Przetwórz wszystkie pliki w bieżącym projekcie,
# spójrz w górę z cwd na plik conf
#
% porządek -a

# Przetwarzaj jeden lub więcej określonych plików,
# spójrz w górę z pierwszego pliku na plik conf
#
% uporządkowany plik [plik...]

# Przetwarzaj katalog rekurencyjnie
#
% tidyall -r reż

OPIS

Istnieje wiele świetnych narzędzi do porządkowania kodu i walidatorów. „tidyall” je tworzy
dostępne z jednego ujednoliconego interfejsu.

Możesz uruchomić „tidyall” na pojedynczym pliku lub na całej hierarchii projektu i skonfigurować
które porządki/walidatory są stosowane do których plików. „tidyall” wykona kopię zapasową plików
wcześniej, a dla wydajności uwzględni tylko pliki, które uległy zmianie od czasu ich wprowadzenia
ostatnio przetwarzane.

Co znajduje się w a czyściej? Co znajduje się w a walidator?
A porządek przekształca plik tak, aby poprawić jego wygląd bez zmiany jego semantyki.
Przykłady obejmują perltidy, podtidy i js-beautify
upiększyć>.

A walidator analizuje plik pod kątem definicji poprawności. Przykłady obejmują
perlcritic, podchecker i jshinthttp://www.jshint.com/>.

Wiele porządków jest również walidatorami, np. „perltidy” zgłosi błąd w przypadku źle sformułowanego
Perła.

Aby użyć porządkowego lub walidatora z „tidyall”, musi on mieć odpowiednią klasę wtyczki,
zwykle pod prefiksem „Code::TidyAll::Plugin::”. Ta dystrybucja zawiera wtyczki
do:

· Perl: perlcritic, perltidy, perltidy-słodki

· Pod: podchecker, podspell, podtidy

· Mason: masoneria

· JavaScript: js-upiększanie, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: phppcs

· Różne: Code::TidyAll::Plugin::SortLines

Zobacz Code::TidyAll::Plugin, aby uzyskać informacje na temat tworzenia własnej wtyczki.

ZA POMOCĄ PORZĄDEK

„tidyall” działa na zasadzie projektu, gdzie projekt jest tylko hierarchią katalogów
akta. Katalogi robocze svn lub git to typowe przykłady projektów.

Górna część projektu to tzw korzeń katalog. W katalogu głównym będziesz potrzebować pliku
plik konfiguracyjny o nazwie „tidyall.ini” lub „.tidyallrc”; określa, w jaki sposób różne porządki i
walidatory zostaną zastosowane do plików w Twoim projekcie.

„tidyall” automatycznie znajdzie twój katalog główny i plik konfiguracyjny, w zależności od tego, jak ty
nazwać:

„uporządkuj cały plik [plik...]”
„tidyall” wyszuka w górę od pierwszego pliku plik conf.

"tidyall -p/--plik potoku"
„tidyall” wyszuka w górę od określonego pliku plik conf.

"tidyall -a/--all" lub "tidyall -s/--svn" lub "tidyall -g/--git"
„tidyall” wyszuka w górę z bieżącego katalogu roboczego plik conf.

"tidyall -a --root-dir dir"
„tidyall” będzie oczekiwał znalezienia pliku conf w określonym katalogu głównym.

Możesz także przekazać --conf-name, aby zmienić szukaną nazwę, lub --conf-file
podaj wyraźną ścieżkę.

KONFIGURACJA

Plik konfiguracyjny („tidyall.ini” lub „.tidyallrc”) jest w formacie Config::INI. Tutaj jest
próba:

[Perłowy porządek]
wybierz = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlKrytyk]
wybierz = lib/**/*.pm
zignoruj ​​= lib/UtterHack.pm lib/OneTime/*.pm
argv = -powaga 3

[PodSprzątanie]
wybierz = lib/**/*.{pm,pod}

W kolejności trzy sekcje deklarują:

· Zastosuj "PerlTidy" z ustawieniami "-noll -it=2" do wszystkich plików *.pl, *.pm i *.t.

· Zastosuj „PerlCritic” z ważnością 3 do wszystkich modułów Perla gdzieś poniżej „lib/”,
z wyjątkiem „lib/UtterHack.pm”.

· Zastosuj "PodTidy" z domyślnymi ustawieniami do wszystkich plików *.pm i *.pod pod "lib/".

Standard konfiguracja Elementy
[klasa] lub [opis klasy]
Nagłówek każdej sekcji odnosi się do tidyall wtyczka. Nazwa jest automatycznie
z prefiksem „Code::TidyAll::Plugin::”, chyba że zaczyna się od „+”, np.

; Używa wtyczki Code::TidyAll::Plugin::PerlTidy
;
[Perłowy porządek]

; Używa wtyczki My::TidyAll::Plugin
;
[+My::TidyAll::Wtyczka]

Możesz również dołączyć opcjonalny opis po zajęciach. Opis będzie
ignorowane i dla wtyczki zostanie użyte tylko pierwsze słowo. To pozwala na listę
plugin więcej niż jeden raz, za każdym razem z inną konfiguracją. Na przykład dwa
różne konfiguracje „PerlCritic”:

; Bądź brutalny wobec bibliotek
;
[PerlCritic ścisłe]
wybierz = lib/**/*.pm
argv = --brutalne

; ale delikatny dla skryptów
;
[PerlCritic pobłażliwy]
wybierz = bin/**/*.pl
argv = --delikatny

Ostrzeżenie: Jeśli po prostu wymienisz tę samą wtyczkę dwa razy bez opisu (lub ten sam
opis), jeden z nich zostanie po cichu zignorowany.

wybierać
Jeden lub więcej wzorców File::Zglob, oddzielonych białymi znakami lub w wielu wierszach,
wskazując, które pliki wybrać. Wymagany jest co najmniej jeden. np

; Wszystkie .t i .pl gdzieś pod bin i t;
; plus wszystkie pliki .pm bezpośrednio w lib/Foo i lib/Bar
;
wybierz = {bin,t}/**/*.p[lm]
wybierz = lib/{Foo,Bar}/*.pm

; Wszystkie pliki .txt w dowolnym miejscu w projekcie
;
wybierz = **/*.txt

Wzorzec odnosi się do katalogu głównego i nie powinien mieć wiodącego ukośnika. Wszystko
standardowe znaki globalne ("*", "?", "[]", "{}") będą działać; ponadto „**” może być
używany do reprezentowania zera lub więcej katalogów. Więcej informacji można znaleźć w dokumentacji File::Zglob
detale.

ignorować
Jeden lub więcej wzorców File::Zglob, oddzielonych białymi znakami lub w wielu wierszach,
wskazując, które pliki należy zignorować. Jest to opcjonalne i zastępuje „wybierz”. np

; Wszystkie pliki .pl w dowolnym miejscu w bin, z wyjątkiem bin/awful.pl lub gdziekolwiek
; pod bin/tmp
;
wybierz = bin/**/*.pl
zignoruj ​​= bin/awful.pl bin/tmp/**/*.pl

szulernia
Jedno lub więcej słów oddzielonych odstępami lub w wielu wierszach, wskazujące które
Shebang linie do zaakceptowania. Jest to opcjonalne i dalsze filtry „wybierz”. np

; Wszystkie pliki bez rozszerzenia w dowolnym miejscu w koszu, które zawierają „perl” lub
; linia Shebang „perl5”.
wybierz = kosz/**/*
ignoruj ​​= kosz/**/*.*
shebang = perl perl5

tylko_tryby
Lista trybów oddzielonych białymi znakami. np

only_modes = testuj cli

Wtyczka będzie tylko uruchom, jeśli jeden z tych trybów zostanie przekazany do „tidyall” przez „-m” lub
"--tryb".

tryby_oprócz_
Lista trybów oddzielonych białymi znakami. np

tryby_wyjątków = edytor zatwierdzeń

Wtyczka będzie nie uruchom, jeśli jeden z tych trybów zostanie przekazany do „tidyall” przez „-m” lub
"--tryb".

argumentacja
Wiele wtyczek (takich jak perltidy, perlcritic i podtidy) korzysta z tej opcji
określa argumenty, które mają zostać przekazane do bazowego narzędzia wiersza poleceń.

waga
Jest to liczba całkowita używana do sortowania wtyczek. Domyślnie najpierw uruchamiane są bardziej uporządkowane wtyczki,
następnie wtyczki walidatora, z każdą grupą posortowaną alfabetycznie.

PODŁĄCZ ZAMÓWIENIE ROLNICZE ATOMICZNOŚĆ

Jeśli wiele wtyczek pasuje do pliku, porządki są stosowane przed walidatorami, dzięki czemu walidatory
sprawdzają końcowy wynik. W ramach tych dwóch grup stosowane są wtyczki
kolejność alfabetyczna według nazwy/opisu wtyczki.

Możesz także jawnie ustawić wagę każdej wtyczki. Domyślnie porządki mają wagę
50, a walidatory mają wagę 60. Możesz ustawić wagę na dowolną liczbę całkowitą do
wpływ na działanie wtyczki.

Zastosowanie wielu wtyczek to „wszystko albo nic”. W przypadku wystąpienia błędu podczas
zastosowanie jakiejkolwiek wtyczki, plik nie jest w ogóle modyfikowany.

WIERSZ POLECEŃ OPCJE

-a, --wszystko
Przetwarzaj wszystkie pliki. Wykonuje rekurencyjne wyszukiwanie wszystkich plików w hierarchii projektu,
zaczynając od katalogu głównego i przetwarza dowolny plik, który pasuje do co najmniej jednej wtyczki w
konfiguracja.

-g, --git
Przetwórz wszystkie dodane lub zmodyfikowane pliki w bieżącym katalogu roboczym git.

-h, --pomoc
Wydrukuj wiadomość pomocy

-l, --lista
Wypisz każdy plik wraz z listą wtyczek, które pasują (pliki bez żadnych dopasowań
są pomijane). W rzeczywistości nie przetwarza żadnych plików i nie dba o to, czy pliki są
buforowane. Zwykle używane z -a, -g lub -seg

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

-m, --tryb
Tryb opcjonalny, który może wpływać na uruchamiane wtyczki. Domyślnie „cli”. Patrz „TRYBY”.

-p ścieżka, --pipe ścieżka
Odczytaj zawartość ze STDIN i zapisz wynikową zawartość na STDOUT. Jeśli się powiedzie,
tidyall kończy działanie ze statusem 0. Jeśli wystąpi błąd, tidyall wysyła komunikat o błędzie do
STDERR, lusterka dotychczasowy wkład zawartość na STDOUT bez zmian i wychodzi ze statusem 1.
Dublowanie oznacza, że ​​możesz bezpiecznie potokować do miejsca docelowego, niezależnie od tego, czy
wystąpi błąd.

Określając tę ​​opcję, musisz podać dokładnie jedną nazwę pliku, względną lub
absolutny, który zostanie użyty do określenia, które wtyczki zastosować, a także gdzie
katalog główny i plik konfiguracyjny są. Plik nie zostanie w rzeczywistości odczytany i tak się stanie
muszą nawet istnieć.

Ta opcja implikuje --no-backups i --no-cache (ponieważ nie ma rzeczywistego pliku) i
--quiet (ponieważ nie chcemy mieszać zbędnych danych wyjściowych z uporządkowanym wynikiem).

# Czytaj ze STDIN i zapisuj na STDOUT, z odpowiednimi wtyczkami
# dla some/path.pl (które nie muszą istnieć)
#
% tidyall --pipe Some/path.pl

-r, --rekurencyjne
Rekurencyjnie wprowadź dowolne katalogi wymienione w wierszu poleceń i przetwórz wszystkie pliki
w. Domyślnie katalogi napotkane w wierszu poleceń będą generować plik
ostrzeżenie.

-s, --svn
Przetwórz wszystkie dodane lub zmodyfikowane pliki w bieżącym katalogu roboczym svn.

-q, --cichy
Pomiń dane wyjściowe z wyjątkiem błędów.

-v, --pełne
Pokaż dodatkowe wyjście.

-I ścieżka1, ścieżka2,...
Dodaj jedną lub więcej ścieżek bibliotek do @INC, na przykład -I Perla. Przydatne, jeśli --tidyall-class lub
wtyczki znajdują się w alternatywnym katalogu lib.

--backup-ttl czas trwania
Czas, po którym można wyczyścić pliki kopii zapasowych. Może to być liczba sekund lub dowolna
ciąg rozpoznawany przez Time::Duration::Parse, np. "4h" lub "1day". Domyślnie „1h”.

--tylko do sprawdzenia
Zamiast porządkować pliki, sprawdź, czy każdy plik jest uporządkowany (tj
wersja jest równa aktualnej wersji) i uważa to za błąd, jeśli nie. To jest używane
przez Test::Code::TidyAll oraz haki przed zatwierdzeniem svn i git, na przykład, aby wymusić
że uporządkowałeś swoje pliki.

--plik-konf ścieżka
Określ względną lub bezwzględną ścieżkę do pliku conf, zamiast szukać go w pliku
Zwykły sposób.

--conf nazwa Nazwa
Określ nazwę pliku conf do wyszukania zamiast wartości domyślnych („tidyall.ini” /
".tidyallrc").

--katalog danych ścieżka
Zawiera dane, takie jak kopie zapasowe i pamięć podręczna. Domyślnie katalog_główny/.tidyall.d

--iteracje liczyć
Uruchom każdą bardziej uporządkowaną transformację liczyć czasy. Wartość domyślna to 1.

W niektórych przypadkach (mam nadzieję, że rzadkich) wynik uporządkowania może być inny, jeśli tak jest
stosowane wielokrotnie. Możesz chcieć wykonać wiele iteracji, aby upewnić się, że
treść „ustala się” w ostatecznej, uporządkowanej formie — zwłaszcza jeśli chodzi o porządek
wymuszone za pomocą haka kontroli wersji lub testu. Oczywiście wydajność ucierpi
mały. Rzadko trzeba ustawiać tę wartość na wyższą niż 2.

Dotyczy to tylko sprzątaczy, a nie walidatorów; np. perlcritic i jshint nadal
uruchomić tylko raz.

--brak kopii zapasowych
Nie twórz kopii zapasowych plików przed przetworzeniem.

--brak pamięci podręcznej
Nie przechowuj w pamięci podręcznej czasów ostatniego przetwarzania; przetwarzać wszystkie pliki za każdym razem. Zobacz też
"--odśwież-pamięć podręczną".

--sufiks-wyjścia przyrostek
Przyrostek do dodania do nazwy pliku przed wyświetleniem zmodyfikowanej wersji, np. ".tdy".
Wartość domyślna to none, co oznacza nadpisanie pliku.

--odśwież pamięć podręczną
Wymaż wszelkie istniejące informacje o pamięci podręcznej przed przetworzeniem każdego pliku, a następnie zapisz nowe informacje o pamięci podręcznej.
Zobacz także „--no-cache”.

-- katalog główny
Określ katalog główny jawnie. Zwykle jest to wywnioskowane z określonych plików
lub bieżący katalog roboczy.

--tidyall-klasa klasa
Podklasa do użycia zamiast „Code::TidyAll”.

Określanie Opcje in konfiguracja
Prawie każdą opcję wiersza poleceń można określić na górze pliku konfiguracyjnego, nad plikiem
sekcje wtyczek. Zastąp myślniki podkreśleniami. np

kopia zapasowa_ttl = 4h
iteracje = 2
tidyall_class = Mój::Code::TidyAll

[Perłowy porządek]
wybierz = **/*.{pl,pm,t}
argv = -noll -it=2

...

Jeśli opcja jest przekazywana w obu miejscach, pierwszeństwo ma linia poleceń.

EXIT STATUS

„tidyall” zakończy działanie ze statusem 1, jeśli wystąpiły błędy podczas przetwarzania plików, oraz 0
Inaczej.

TRYBY

Możesz używać tidyall w wielu różnych kontekstach i możesz nie chcieć uruchamiać wszystkich
wtyczki we wszystkich.

Możesz przekazać tryb do tidyall za pomocą „-m” lub „--mode”, a następnie określić, że niektóre wtyczki
powinien być uruchamiany tylko w niektórych trybach (poprzez „only_modes”) lub powinien być uruchamiany we wszystkich oprócz niektórych
tryby (poprzez „except_modes”).

Przykładowe tryby:

· "cli" - podczas jawnego wywoływania tidyall z wiersza poleceń bez określonego trybu

· „edytor” – przy wywołaniu z poziomu edytora

· „commit” – przy użyciu haka zatwierdzającego, takiego jak Code::TidyAll::SVN::Precommit lub
Code::TidyAll::Git::Wstępne zatwierdzenie

· "test" - przy użyciu Test::Code::TidyAll

Teraz, ponieważ perlcritic jest trochę czasochłonny, możesz chcieć uruchamiać go tylko podczas testów
i jawne wywołanie wiersza poleceń:

[PerlKrytyk]
wybierz = lib/**/*.pm
only_modes = testuj cli
...

Lub możesz określić, że ma być uruchamiany we wszystkich trybach z wyjątkiem Edytor:

[PerlKrytyk]
wybierz = lib/**/*.pm
tryby_wyjątku = edytor
...

Jeśli nie określisz „only_modes” ani „except_modes” dla wtyczki, zawsze tak będzie
uruchomić.

OSTATNIE PRZETWARZANE CACHE

„tidyall” śledzi podpis każdego pliku po jego ostatnim przetworzeniu. Na kolejnych
uruchomi się, przetworzy plik tylko wtedy, gdy zmienił się jego podpis. Pamięć podręczna jest przechowywana w plikach
pod kier.danych.

Możesz wymusić odświeżenie pamięci podręcznej za pomocą „--refresh-cache” lub wyłączyć to zachowanie
całkowicie z „--no-cache”.

KOPIE ZAPASOWE

„tidyall” wykona kopię zapasową każdego pliku przed jego modyfikacją. Kopie zapasowe ze znacznikiem czasu są przechowywane w formacie
osobna hierarchia katalogów w katalogu danych.

Stare pliki kopii zapasowych zostaną automatycznie wyczyszczone w ramach okazjonalnych „porządków”. The
czas trwania określony w „--backup-ttl” wskazuje zarówno minimalną ilość czasu tworzenia kopii zapasowych
powinna być zachowana, a częstotliwość czyszczenia powinna być ustalona. Może być określony jako „30m”
lub „4 godziny” lub dowolny ciąg akceptowany przez Time::Duration::Parse. Domyślnie jest to „1h” (1
godzina).

Możesz wyłączyć kopie zapasowe za pomocą „--no-backups”.

"ZAGINIONY" WYMAGANIA WSTĘPNE

Dystrybucja „Code::TidyAll” celowo nie zależy od wymagań wstępnych
każdą wtyczkę. Oznacza to, że jeśli chcesz używać perltidy, musisz zainstalować
Perl::Uporządkuj moduł ręcznie.

DOTYCZY TOOLS

· etc/editors/tidyall.el
tidyall/master/etc/editors/tidyall.el> i etc/editors/tidyall.vim

w tej dystrybucji zawiera polecenia Emacsa i Vima do uruchamiania „tidyall” na
bieżący bufor. Możesz przypisać to do wybranego naciśnięcia klawisza (np. ctrl-t lub
,T).

· Code::TidyAll::SVN::Precommit implementuje hak przed zatwierdzeniem Subversion, który sprawdza, czy
wszystkie pliki są uporządkowane i ważne zgodnie z „tidyall” i odrzuca zatwierdzenie, jeśli nie.

· Code::TidyAll::Git::Precommit i Code::TidyAll::Git::Prereceive zaimplementuj git pre-
odpowiednio commit i pre-receive hooki, które sprawdzają, czy wszystkie pliki są uporządkowane i
ważne zgodnie z „tidyall”.

· Test::Code::TidyAll to biblioteka testowa, która sprawdza, czy wszystkie pliki w twoim projekcie
są w uporządkowanym i aktualnym stanie.

ZNANE ROBAKI

· Nie działa jeszcze w systemie Windows

Korzystaj z tidyallp online za pomocą usług onworks.net