Tidyallp – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

Tidyall – Ihr All-in-One-Code-Aufräumen und Validierer

ZUSAMMENFASSUNG

# Erstellen Sie oben in Ihrem Projekt eine Tidyall.ini oder .tidyallrc
#
[PerlTidy]
select = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlCritic]
select = lib/**/*.pm
ignorieren = lib/UtterHack.pm
argv = -Schweregrad 3

# Alle Dateien im aktuellen Projekt verarbeiten,
# Suchen Sie von cwd nach oben nach der Conf-Datei
#
% ordentlichall -a

# Eine oder mehrere bestimmte Dateien verarbeiten,
# Suchen Sie von der ersten Datei nach oben nach der Conf-Datei
#
% Tidyall-Datei [Datei...]

# Verarbeiten Sie ein Verzeichnis rekursiv
#
% Tidyall -r Dir

BESCHREIBUNG

Es gibt viele großartige Code-Aufräumer und Validatoren. „tidyall“ macht sie
über eine einzige einheitliche Schnittstelle verfügbar.

Sie können „tidyall“ auf einer einzelnen Datei oder auf einer gesamten Projekthierarchie ausführen und konfigurieren
welche Aufräum-/Validierungsprogramme auf welche Dateien angewendet werden. „tidyall“ sichert Dateien
und aus Effizienzgründen werden nur Dateien berücksichtigt, die seitdem geändert wurden
zuletzt bearbeitet.

Was ist a aufgeräumter? Was ist a Validator?
A aufgeräumter transformiert eine Datei, um ihr Erscheinungsbild zu verbessern, ohne ihre Semantik zu ändern.
Beispiele hierfür sind perltidy, podtidy und js-beautify
verschönern>.

A Validator analysiert eine Datei auf eine Definition der Korrektheit. Beispiele beinhalten
perlcritic, podchecker und jshinthttp://www.jshint.com/>.

Viele Tidier sind auch Validatoren, z. B. gibt „perltidy“ bei schlecht geformten Dateien einen Fehler aus
Perle.

Um einen Tidier oder Validator mit „tidyall“ verwenden zu können, muss dieser über eine entsprechende Plugin-Klasse verfügen.
normalerweise unter dem Präfix „Code::TidyAll::Plugin::“. Diese Distribution enthält Plugins
für:

· Perl: perlcritic, perltidy, perltidy-sweet

· Pod: Podchecker, Podspell, Podtidy

· Maurer: masontidy

· JavaScript: js-beautify, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: phpks

· Sonstiges: Code::TidyAll::Plugin::SortLines

Informationen zum Erstellen Ihres eigenen Plugins finden Sie unter Code::TidyAll::Plugin.

VERWENDUNG ORDENTLICH

„tidyall“ funktioniert auf Projektbasis, wobei ein Projekt lediglich eine Verzeichnishierarchie von ist
Dateien. SVN- oder Git-Arbeitsverzeichnisse sind typische Beispiele für Projekte.

Die Spitze des Projekts heißt Wurzel Verzeichnis. Im Stammverzeichnis benötigen Sie eine
Konfigurationsdatei mit dem Namen „tidyall.ini“ oder „.tidyallrc“; Es definiert, wie verschiedene Ordnungs- und
Validatoren werden auf die Dateien in Ihrem Projekt angewendet.

„tidyall“ findet Ihr Stammverzeichnis und Ihre Konfigurationsdatei automatisch, je nachdem, wie Sie vorgehen
nennen:

„Tidyall-Datei [Datei...]“
„tidyall“ sucht von der ersten Datei aufwärts nach der conf-Datei.

„tidyall -p/--pipe file“
„tidyall“ sucht von der angegebenen Datei aufwärts nach der conf-Datei.

„tidyall -a/--all“ oder „tidyall -s/--svn“ oder „tidyall -g/--git“
„tidyall“ sucht vom aktuellen Arbeitsverzeichnis aufwärts nach der conf-Datei.

„tidyall -a --root-dir dir“
„tidyall“ erwartet, die Conf-Datei im angegebenen Stammverzeichnis zu finden.

Sie können auch --conf-name übergeben, um den Namen zu ändern, nach dem gesucht wird, oder --conf-file an
Geben Sie einen expliziten Pfad an.

CONFIGURATION

Die Konfigurationsdatei („tidyall.ini“ oder „.tidyallrc“) liegt im Config::INI-Format vor. Hier ist ein
Stichprobe:

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

[PerlCritic]
select = lib/**/*.pm
ignorieren = lib/UtterHack.pm lib/OneTime/*.pm
argv = -Schweregrad 3

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

In der Reihenfolge erklären die drei Abschnitte:

· Wenden Sie „PerlTidy“ mit den Einstellungen „-noll -it=2“ auf alle *.pl-, *.pm- und *.t-Dateien an.

· Wenden Sie „PerlCritic“ mit Schweregrad 3 auf alle Perl-Module irgendwo unter „lib/“ an.
außer „lib/UtterHack.pm“.

· Wenden Sie „PodTidy“ mit Standardeinstellungen auf alle *.pm- und *.pod-Dateien unter „lib/“ an.

Standard Konfiguration Elemente
[Klasse] oder [Klassenbeschreibung]
Die Kopfzeile jedes Abschnitts verweist auf ein Tidyall Plugin. Der Name ist automatisch
mit dem Präfix „Code::TidyAll::Plugin::“, es sei denn, es beginnt mit einem „+“, z

; Verwendet Plugin Code::TidyAll::Plugin::PerlTidy
;
[PerlTidy]

; Verwendet das Plugin My::TidyAll::Plugin
;
[+My::TidyAll::Plugin]

Sie können nach dem Kurs auch eine optionale Beschreibung hinzufügen. Die Beschreibung wird sein
ignoriert und nur das erste Wort wird für das Plugin verwendet. Dies ermöglicht Ihnen eine Liste
ein Plugin mehr als einmal, jedes Mal mit unterschiedlicher Konfiguration. Zum Beispiel zwei
verschiedene „PerlCritic“-Konfigurationen:

; Seien Sie brutal gegenüber Bibliotheken
;
[PerlCritic streng]
select = lib/**/*.pm
argv = --brutal

; aber sanft zu Skripten
;
[PerlCritic nachsichtig]
select = bin/**/*.pl
argv = --gentle

Warnung: Wenn Sie dasselbe Plugin einfach zweimal ohne Beschreibung auflisten (oder dasselbe
Beschreibung), einer von ihnen wird stillschweigend ignoriert.

wählen
Ein oder mehrere File::Zglob-Muster, getrennt durch Leerzeichen oder in mehreren Zeilen,
gibt an, welche Dateien ausgewählt werden sollen. Mindestens eine ist erforderlich. z.B

; Alle .t und .pl irgendwo unter bin und t;
; plus alle .pm-Dateien direkt unter lib/Foo und lib/Bar
;
select = {bin,t}/**/*.p[lm]
select = lib/{Foo,Bar}/*.pm

; Alle TXT-Dateien irgendwo im Projekt
;
select = **/*.txt

Das Muster ist relativ zum Stammverzeichnis und sollte keinen führenden Schrägstrich enthalten. Alle
Standard-Glob-Zeichen („*“, „?“, „[]“, „{}“) funktionieren; zusätzlich kann „**“ sein
Wird verwendet, um null oder mehr Verzeichnisse darzustellen. Weitere Informationen finden Sie in der File::Zglob-Dokumentation
Details.

ignorieren
Ein oder mehrere File::Zglob-Muster, getrennt durch Leerzeichen oder in mehreren Zeilen,
Gibt an, welche Dateien ignoriert werden sollen. Dies ist optional und überschreibt „select“. z.B

; Alle .pl-Dateien irgendwo unter bin, außer bin/awful.pl oder irgendwo
; unter bin/tmp
;
select = bin/**/*.pl
ignorieren = bin/awful.pl bin/tmp/**/*.pl

Shebang
Ein oder mehrere Wörter, durch Leerzeichen getrennt oder in mehreren Zeilen, die angeben, welches
Shebang-Zeilen zum Akzeptieren. Dies ist optional und weitere Filter „wählen“ aus. z.B

; Alle Dateien ohne Erweiterung irgendwo unter bin, die ein „perl“ oder enthalten
; „perl5“ Shebang-Zeile.
select = bin/**/*
ignorieren = bin/**/*.*
shebang = perl perl5

only_modes
Eine durch Leerzeichen getrennte Liste von Modi. z.B

only_modes = Test-CLI

Das Plugin wird einzige wird ausgeführt, wenn einer dieser Modi über „-m“ oder an „tidyall“ übergeben wird
"--Modus".

außer_modi
Eine durch Leerzeichen getrennte Liste von Modi. z.B

außer_modes = Commit-Editor

Das Plugin wird nicht wird ausgeführt, wenn einer dieser Modi über „-m“ oder an „tidyall“ übergeben wird
"--Modus".

argv
Viele Plugins (wie Perltidy, Perlcritic und Podtidy) nutzen diese Option
Gibt Argumente an, die an das zugrunde liegende Befehlszeilendienstprogramm übergeben werden sollen.

Gewicht
Dies ist eine Ganzzahl, die zum Sortieren von Plugins verwendet wird. Standardmäßig werden aufgeräumtere Plugins zuerst ausgeführt.
dann Validator-Plugins, wobei jede Gruppe alphabetisch sortiert ist.

PLUGIN BESTELLUNG UND Atomizität

Wenn mehrere Plugins mit einer Datei übereinstimmen, werden Tidier vor den Validatoren angewendet, damit die Validatoren
überprüfen das Endergebnis. Innerhalb dieser beiden Gruppen werden die Plugins angewendet
Alphabetische Reihenfolge nach Plugin-Name/-Beschreibung.

Sie können die Gewichtung jedes Plugins auch explizit festlegen. Ordnungshelfer haben standardmäßig ein Gewicht
von 50 und Validatoren haben eine Gewichtung von 60. Sie können die Gewichtung auf eine beliebige ganze Zahl festlegen
Einfluss darauf, wann das Plugin ausgeführt wird.

Bei der Anwendung mehrerer Plugins geht es um alles oder nichts. Wenn während des Vorgangs ein Fehler auftritt
Durch die Anwendung eines Plugins wird die Datei überhaupt nicht verändert.

BEFEHLSZEILE OPTIONAL

-a, --alle
Verarbeiten Sie alle Dateien. Führt eine rekursive Suche nach allen Dateien in der Projekthierarchie durch,
Beginnend im Stammverzeichnis und verarbeitet jede Datei, die mindestens einem Plugin im entspricht
Konfiguration.

-g, --git
Verarbeiten Sie alle hinzugefügten oder geänderten Dateien im aktuellen Git-Arbeitsverzeichnis.

-h, --Hilfe
Hilfenachricht drucken

-l, --liste
Listen Sie jede Datei zusammen mit der Liste der Plugins auf, mit denen sie übereinstimmt (Dateien ohne Übereinstimmungen).
werden übersprungen). Verarbeitet eigentlich keine Dateien und kümmert sich nicht darum, ob Dateien vorhanden sind
zwischengespeichert. Wird im Allgemeinen mit -a, -g oder -seg verwendet

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

-m, --mode
Optionaler Modus, der beeinflussen kann, welche Plugins ausgeführt werden. Der Standardwert ist „cli“. Siehe „MODI“.

-p Pfad, --pipe Pfad
Lesen Sie den Inhalt von STDIN und schreiben Sie den resultierenden Inhalt in STDOUT. Falls erfolgreich,
Tidyall beendet sich mit dem Status 0. Wenn ein Fehler auftritt, gibt Tidyall die Fehlermeldung an aus
STDERR, Spiegel die Varianten des Eingangssignals: Inhalt ohne Änderungen auf STDOUT umgestellt und mit Status 1 beendet.
Durch die Spiegelung können Sie unabhängig davon sicher an Ihr Ziel weiterleiten
ein Fehler auftritt.

Wenn Sie diese Option angeben, müssen Sie genau einen Dateinamen angeben, relativ oder
absolut, das verwendet wird, um zu bestimmen, welche Plugins angewendet werden sollen und auch wo
Stammverzeichnis und Konfigurationsdatei sind. Die Datei wird nicht wirklich gelesen, und das wird auch der Fall sein
müssen überhaupt existieren.

Diese Option impliziert --no-backups und --no-cache (da es keine tatsächliche Datei gibt) und
--quiet (da wir keine überflüssigen Ausgaben mit dem aufgeräumten Ergebnis vermischen wollen).

# Von STDIN lesen und mit entsprechenden Plugins nach STDOUT schreiben
# für some/path.pl (das nicht existieren muss)
#
% Tidyall --pipe some/path.pl

-r, --rekursiv
Geben Sie rekursiv alle in der Befehlszeile aufgeführten Verzeichnisse ein und verarbeiten Sie alle Dateien
innerhalb. Standardmäßig generieren Verzeichnisse, die in der Befehlszeile gefunden werden, eine
Warnung.

-s, --svn
Verarbeiten Sie alle hinzugefügten oder geänderten Dateien im aktuellen SVN-Arbeitsverzeichnis.

-q, --leise
Unterdrücken Sie die Ausgabe mit Ausnahme von Fehlern.

-v, --verbose
Zusätzliche Ausgabe anzeigen.

-I Pfad1, Pfad2,...
Fügen Sie @INC einen oder mehrere Bibliothekspfade hinzu, z. B. -I von Perl. Nützlich, wenn --tidyall-class oder
Plugins befinden sich in einem alternativen lib-Verzeichnis.

--backup-ttl Dauer
Zeitspanne, bevor Sicherungsdateien gelöscht werden können. Kann eine Anzahl von Sekunden oder beliebig sein
Von Time::Duration::Parse erkannter String, z. B. „4h“ oder „1day“. Der Standardwert ist „1h“.

--check-only
Anstatt Dateien tatsächlich aufzuräumen, prüfen Sie, ob jede Datei aufgeräumt ist (d. h. ob sie aufgeräumt ist).
Wenn die Version nicht mit der aktuellen Version übereinstimmt, wird dies als Fehler betrachtet. Dies wird verwendet
durch Test::Code::TidyAll und die SVN- und Git-Pre-Commit-Hooks, um sie beispielsweise durchzusetzen
dass Sie Ihre Akten aufgeräumt haben.

--conf-Datei Weg
Geben Sie den relativen oder absoluten Pfad zur conf-Datei an, anstatt in der Datei danach zu suchen
normaler Weg.

--conf-name Name
Geben Sie einen Namen der Konfigurationsdatei an, nach der anstelle der Standardeinstellungen gesucht werden soll („tidyall.ini“ /
„.tidyallrc“).

--data-dir Weg
Enthält Daten wie Backups und Cache. Standardmäßig ist root_dir/.tidyall.d

--iterationen zählen
Führen Sie jede aufgeräumtere Transformation aus zählen mal. Der Standardwert ist 1.

In einigen Fällen (hoffentlich selten) kann die Ausgabe eines Tidiers anders ausfallen, wenn dies der Fall ist
mehrfach angewendet. Möglicherweise möchten Sie mehrere Iterationen durchführen, um sicherzustellen, dass
Der Inhalt „festigt“ sich in seiner endgültigen, aufgeräumten Form – vor allem, wenn es um Ordnung geht
wird mit einem Versionskontroll-Hook oder einem Test erzwungen. Natürlich wird die Leistung darunter leiden
wenig. Sie sollten diesen Wert selten höher als 2 einstellen müssen.

Dies betrifft nur Tidier, nicht Validatoren; zB perlcritic und jshint würden immer noch
nur einmal ausgeführt werden.

--keine Sicherungen
Sichern Sie die Dateien nicht vor der Verarbeitung.

--no-cache
Letzte Verarbeitungszeiten nicht zwischenspeichern; Verarbeiten Sie jedes Mal alle Dateien. Siehe auch
„--refresh-cache“.

--output-suffix Suffix
Suffix, das einem Dateinamen hinzugefügt werden muss, bevor die geänderte Version ausgegeben wird, z. B. „.tdy“.
Der Standardwert ist „Keine“, was bedeutet, dass die Datei überschrieben wird.

--refresh-cache
Löschen Sie alle vorhandenen Cache-Informationen, bevor Sie jede Datei verarbeiten, und schreiben Sie dann neue Cache-Informationen.
Siehe auch „--no-cache“.

--root-dir
Geben Sie das Stammverzeichnis explizit an. Normalerweise wird dies aus den angegebenen Dateien abgeleitet
oder das aktuelle Arbeitsverzeichnis.

--tidyall-class Klasse
Unterklasse, die anstelle von „Code::TidyAll“ verwendet werden soll.

Angeben Optionen in Konfiguration
Fast jede Befehlszeilenoption kann oben in der Konfigurationsdatei angegeben werden, über dem
Plugin-Abschnitte. Ersetzen Sie Bindestriche durch Unterstriche. z.B

backup_ttl = 4h
Iterationen = 2
Tidyall_class = My::Code::TidyAll

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

...

Wenn an beiden Stellen eine Option übergeben wird, hat die Befehlszeile Vorrang.

EXIT STATUS

„tidyall“ wird mit Status 1 beendet, wenn bei der Verarbeitung von Dateien Fehler aufgetreten sind, und mit Status 0
Andernfalls.

MODI

Sie können Tidyall in verschiedenen Kontexten verwenden und möchten möglicherweise nicht alle ausführen
Plugins in allen.

Sie können über „-m“ oder „--mode“ einen Modus an Tidyall übergeben und dann bestimmte Plugins angeben
sollte nur in bestimmten Modi (über „only_modes“) oder in allen außer bestimmten Modi ausgeführt werden
Modi (über „exclusive_modes“).

Beispiele für Modi:

· „cli“ – wenn Tidyall explizit über die Befehlszeile aufgerufen wird, ohne dass ein Modus angegeben ist

· „Editor“ – beim Aufruf aus einem Editor

· „commit“ – bei Verwendung eines Commit-Hooks wie Code::TidyAll::SVN::Precommit oder
Code::TidyAll::Git::Precommit

· „test“ – bei Verwendung von Test::Code::TidyAll

Da Perlcritic etwas zeitaufwändig ist, möchten Sie es vielleicht nur während Tests ausführen
und expliziter Befehlszeilenaufruf:

[PerlCritic]
select = lib/**/*.pm
only_modes = Test-CLI
...

Oder Sie können festlegen, dass es in allen Modi ausgeführt wird ausgeschlossen der Editor:

[PerlCritic]
select = lib/**/*.pm
außer_modes = Editor
...

Wenn Sie für ein Plugin weder „only_modes“ noch „exclusive_modes“ angeben, wird dies immer der Fall sein
laufen.

ZULETZT VERARBEITET CACHE

„tidyall“ verfolgt die Signatur jeder Datei nach der letzten Verarbeitung. Im Anschluss
ausgeführt wird, wird eine Datei nur dann verarbeitet, wenn sich ihre Signatur geändert hat. Der Cache wird in Dateien gespeichert
unter dem Datenverzeichnis.

Sie können eine Aktualisierung des Caches mit „--refresh-cache“ erzwingen oder das Verhalten deaktivieren
komplett mit „--no-cache“.

Backups

„tidyall“ sichert jede Datei, bevor sie geändert wird. Die zeitgestempelten Backups werden in einem gespeichert
Separate Verzeichnishierarchie unter dem Datenverzeichnis.

Alte Sicherungsdateien werden im Rahmen gelegentlicher „Tidyall“-Läufe automatisch gelöscht. Der
Die in „--backup-ttl“ angegebene Dauer gibt sowohl die Mindestdauer der Sicherungen an
sollte beibehalten werden, und die Häufigkeit, mit der Bereinigungen ausgeführt werden sollten. Es kann als „30 m“ angegeben werden.
oder „4 Stunden“ oder eine beliebige Zeichenfolge, die für Time::Duration::Parse akzeptabel ist. Der Standardwert ist „1h“ (1
Stunde).

Sie können Backups mit „--no-backups“ deaktivieren.

"FEHLEN" VORAUSSETZUNGEN

Die „Code::TidyAll“-Distribution basiert bewusst nicht auf den erforderlichen Voraussetzungen
jedes Plugin. Das bedeutet, dass Sie, wenn Sie Perltidy verwenden möchten, das installieren müssen
Perl::Tidy-Modul manuell.

VERBINDUNG TOOLS

· etc/editors/tidyall.el
Tidyall/master/etc/editors/tidyall.el> und etc/editors/tidyall.vim

In dieser Distribution sind Emacs- und Vim-Befehle zum Ausführen von „tidyall“ enthalten
aktueller Puffer. Sie können dies einem Tastendruck Ihrer Wahl zuweisen (z. B. Strg-T oder
,T).

· Code::TidyAll::SVN::Precommit implementiert einen Subversion-Pre-Commit-Hook, der prüft, ob
alle Dateien sind gemäß „tidyall“ aufgeräumt und gültig, andernfalls wird das Commit abgelehnt.

· Code::TidyAll::Git::Precommit und Code::TidyAll::Git::Prereceive implementieren Git Pre-
Commit- bzw. Pre-Receive-Hooks, die prüfen, ob alle Dateien aufgeräumt sind und
gültig laut „tidyall“.

· Test::Code::TidyAll ist eine Testbibliothek, um alle Dateien in Ihrem Projekt zu überprüfen
sind in einem aufgeräumten und gültigen Zustand.

BEKANNT Fehler

· Funktioniert noch nicht unter Windows

Nutzen Sie Tidyallp online über die Dienste von onworks.net