netjesallp - Online in de cloud

PROGRAMMA:

NAAM

netjesall - Uw alles-in-één code-opruimer en validator

KORTE INHOUD

# Maak een netjesall.ini of .tidyallrc bovenaan uw project
#
[PerlTidy]
selecteer = **/*.{pl,pm,t}
argv = -noll -it=2

[PerlCritic]
selecteer = lib/**/*.pm
negeren = lib/UtterHack.pm
argv = -ernst 3

# Verwerk alle bestanden in het huidige project,
# kijk omhoog vanuit cwd voor conf-bestand
#
% netjes alles -a

# Verwerk een of meer specifieke bestanden,
# kijk omhoog vanaf het eerste bestand voor conf-bestand
#
% netjesalle bestand [bestand...]

# Verwerk een directory recursief
#
% netjesall -r map

PRODUCTBESCHRIJVING

Er zijn veel geweldige code-opruimers en validators beschikbaar. "tidyall" maakt ze
beschikbaar via één uniforme interface.

U kunt "tidyall" uitvoeren op een enkel bestand of op een hele projecthiërarchie en configureren
welke opruimers/validators op welke bestanden worden toegepast. "tidyall" maakt een back-up van bestanden
vooraf, en zal voor de efficiëntie alleen rekening houden met bestanden die sindsdien zijn gewijzigd
laatst verwerkt.

Wat is a netter? Wat is a validator?
A netter transformeert een bestand om het uiterlijk ervan te verbeteren zonder de semantiek ervan te veranderen.
Voorbeelden hiervan zijn perltidy, podtidy en js-beautify
verfraaien>.

A validator analyseert een bestand voor een definitie van correctheid. Voorbeelden zijn onder meer
perlcritic, podchecker en jshinthttp://www.jshint.com/>.

Veel opruimers zijn ook validators, bijvoorbeeld "perltidy" zal een fout opleveren bij slecht gevormde bestanden
Parel.

Om een ​​tidier of validator met "tidyall" te gebruiken, moet deze een overeenkomstige plug-inklasse hebben,
meestal onder het voorvoegsel "Code::TidyAll::Plugin::". Deze distributie wordt geleverd met plug-ins
voor:

· Perl: perlkritisch, perltidy, perltidy-zoet

· Pod: podchecker, podspell, podtidy

· Metselaar: metselwerk

· JavaScript: js-verfraaiing, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: PHP

· Diversen: Code::TidyAll::Plugin::SortLines

Zie Code::TidyAll::Plugin voor informatie over het maken van uw eigen plug-in.

GEBRUIK MAKEND VAN ALLES OPNIEUW

"tidyall" werkt op projectbasis, waarbij een project slechts een directoryhiërarchie is
bestanden. svn- of git-werkmappen zijn typische voorbeelden van projecten.

De bovenkant van het project heet de wortel directory. In de hoofdmap heb je een
configuratiebestand met de naam "tidyall.ini" of ".tidyallrc"; het definieert hoe verschillende opruimers en
validators worden toegepast op de bestanden in uw project.

"tidyall" zal uw hoofdmap en configuratiebestand automatisch vinden, afhankelijk van hoe u dat doet
noem het:

"opgeruimd bestand [bestand...]"
"tidyall" zal vanaf het eerste bestand naar boven zoeken naar het conf-bestand.

"tidyall -p/--pipe-bestand"
"tidyall" zal vanuit het opgegeven bestand naar boven zoeken naar het conf-bestand.

"tidyall -a/--all" of "tidyall -s/--svn" of "tidyall -g/--git"
"tidyall" zal vanuit de huidige werkmap naar boven zoeken naar het conf-bestand.

"tidyall -a --root-dir dir"
"tidyall" verwacht het conf-bestand in de opgegeven hoofdmap te vinden.

U kunt ook --conf-name doorgeven om de naam waarnaar wordt gezocht te wijzigen, of --conf-file naar
geef een expliciet pad op.

CONFIGURATIE

Het configuratiebestand ("tidyall.ini" of ".tidyallrc") heeft de indeling Config::INI. Hier is een
monster:

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

[PerlCritic]
selecteer = lib/**/*.pm
negeren = lib/UtterHack.pm lib/OneTime/*.pm
argv = -ernst 3

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

In volgorde verklaren de drie secties:

· Pas "PerlTidy" toe met de instellingen "-noll -it=2" op alle *.pl-, *.pm- en *.t-bestanden.

· Pas "PerlCritic" met ernst 3 toe op alle Perl-modules ergens onder "lib/",
behalve "lib/UtterHack.pm".

· Pas "PodTidy" met standaardinstellingen toe op alle *.pm- en *.pod-bestanden onder "lib/".

Standaard configuratie geeft je de mogelijkheid
[klasse] of [klassebeschrijving]
De kop van elke sectie verwijst naar een netjesalles inpluggen. De naam is automatisch
voorafgegaan door "Code::TidyAll::Plugin::" tenzij het begint met een '+', bijvoorbeeld

; Gebruikt plug-in Code::TidyAll::Plugin::PerlTidy
;
[PerlTidy]

; Gebruikt plug-in Mijn::TidyAll::Plugin
;
[+Mijn::TidyAll::Plugin]

Je kunt ook een optionele beschrijving toevoegen na de les. De beschrijving zal zijn
genegeerd en alleen het eerste woord wordt gebruikt voor de plug-in. Hiermee kunt u een lijst maken
een plug-in meerdere keren gebruiken, met elke keer een andere configuratie. Twee bijvoorbeeld
verschillende "PerlCritic"-configuraties:

; Wees wreed tegen bibliotheken
;
[PerlCritic strikt]
selecteer = lib/**/*.pm
argv = --brutaal

; maar zacht voor scripts
;
[PerlCritic mild]
selecteer = bin/**/*.pl
argv = --zachtaardig

Waarschuwing: als u dezelfde plug-in twee keer vermeldt zonder beschrijving (of hetzelfde
beschrijving), zal een van hen stilzwijgend worden genegeerd.

kiezen
Een of meer File::Zglob-patronen, gescheiden door witruimte of op meerdere regels,
geeft aan welke bestanden moeten worden geselecteerd. Er is minimaal één vereist. bijv

; Alle .t en .pl ergens onder bin en t;
; plus alle .pm-bestanden direct onder lib/Foo en lib/Bar
;
selecteer = {bin,t}/**/*.p[lm]
selecteer = lib/{Foo,Bar}/*.pm

; Alle .txt-bestanden waar dan ook in het project
;
selecteer = **/*.txt

Het patroon is relatief ten opzichte van de hoofdmap en mag geen voorafgaande schuine streep hebben. Alle
standaard glob-tekens ("*", "?", "[]", "{}") zullen werken; bovendien kan "**" zijn
gebruikt om nul of meer mappen weer te geven. Zie File::Zglob-documentatie voor meer informatie
details.

negeren
Een of meer File::Zglob-patronen, gescheiden door witruimte of op meerdere regels,
geeft aan welke bestanden moeten worden genegeerd. Dit is optioneel en heeft voorrang op 'selecteren'. bijv

; Alle .pl-bestanden waar dan ook onder bin, behalve bin/awful.pl of waar dan ook
; onder bin/tmp
;
selecteer = bin/**/*.pl
negeren = bin/verschrikkelijk.pl bin/tmp/**/*.pl

keet
Een of meer woorden, gescheiden door witruimte of op meerdere regels, die aangeven welke
shebang-regels om te accepteren. Dit is optioneel en filtert verder op "selecteren". bijv

; Alle bestanden zonder extensie ergens onder bin die een "perl" of
; "perl5" shebang-regel.
selecteer = bak/**/*
negeren = bin/**/*.*
shebang = perl perl5

alleen_modes
Een lijst met modi, gescheiden door witruimte. bijv

only_modes = testcli

De plug-in zal Slechts uitvoeren als een van deze modi wordt doorgegeven aan "tidyall" via "-m" of
"--modus".

behalve_modi
Een lijst met modi, gescheiden door witruimte. bijv

except_modes = commit-editor

De plug-in zal niet uitvoeren als een van deze modi wordt doorgegeven aan "tidyall" via "-m" of
"--modus".

argv
Veel plug-ins (zoals perltidy, perlcritic en podtidy) maken gebruik van deze optie
specificeert argumenten die moeten worden doorgegeven aan het onderliggende opdrachtregelprogramma.

gewicht
Dit is een geheel getal dat wordt gebruikt om plug-ins te sorteren. Standaard worden nettere plug-ins als eerste uitgevoerd,
vervolgens validatorplug-ins, waarbij elke groep alfabetisch gesorteerd is.

INPLUGGEN BESTELLEN EN ATOMICITEIT

Als meerdere plug-ins overeenkomen met een bestand, worden er opruimingen vóór validators toegepast, zodat validators
controleren het eindresultaat. Binnen deze twee groepen worden de plug-ins toegepast
alfabetische volgorde op plug-innaam/beschrijving.

U kunt ook expliciet het gewicht van elke plug-in instellen. Standaard hebben opruimers een gewicht
van 50 en validators hebben een gewicht van 60. U kunt het gewicht instellen op elk geheel getal
invloed wanneer de plug-in wordt uitgevoerd.

Het toepassen van meerdere plugins is alles of niets. Als er een fout optreedt tijdens het
toepassing van een plug-in, het bestand wordt helemaal niet gewijzigd.

OPDRACHTREGEL OPTIES

-a, --allemaal
Verwerk alle bestanden. Zoekt recursief naar alle bestanden in de projecthiërarchie,
beginnend bij de root, en verwerkt elk bestand dat overeenkomt met ten minste één plug-in in de
configuratie.

-g, --git
Verwerk alle toegevoegde of gewijzigde bestanden in de huidige git-werkmap.

-h, --hulp
Help-bericht afdrukken

-l, --lijst
Geef elk bestand weer samen met de lijst met plug-ins waarmee het overeenkomt (bestanden zonder overeenkomsten
worden overgeslagen). Verwerkt feitelijk geen bestanden en het maakt niet uit of bestanden dat wel zijn
in de cache opgeslagen. Over het algemeen gebruikt met -a, -g of -seg

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

-m, --modus
Optionele modus die van invloed kan zijn op welke plug-ins worden uitgevoerd. Standaard ingesteld op "cli". Zie "MODI".

-p pad, --pipe pad
Lees inhoud van STDIN en schrijf de resulterende inhoud naar STDOUT. Indien succesvol,
Tidall sluit af met de status 0. Als er een fout optreedt, stuurt TidAll de foutmelding naar
STDERR, spiegels de invoer content naar STDOUT zonder wijzigingen, en sluit af met status 1.
Door de spiegeling kunt u ongeacht of u veilig naar uw bestemming kunt pijpen
er treedt een fout op.

Wanneer u deze optie opgeeft, moet u precies één bestandsnaam, relatief of
absoluut, dat zal worden gebruikt om te bepalen welke plug-ins moeten worden toegepast en ook waar de
hoofdmap en configuratiebestand zijn. Het bestand wordt niet daadwerkelijk gelezen, maar dat gebeurt wel
moeten zelfs bestaan.

Deze optie impliceert --no-backups en --no-cache (aangezien er geen daadwerkelijk bestand is) en
--quiet (aangezien we geen externe uitvoer willen combineren met het opgeruimde resultaat).

# Lees van STDIN en schrijf naar STDOUT, met de juiste plug-ins
# voor sommige/path.pl (die niet hoeft te bestaan)
#
% netjesall --pipe some/path.pl

-r, --recursief
Voer recursief alle mappen in die op de opdrachtregel staan ​​vermeld en verwerk alle bestanden
binnenin. Standaard genereren mappen die op de opdrachtregel worden aangetroffen een
waarschuwing.

-s, --svn
Verwerk alle toegevoegde of gewijzigde bestanden in de huidige svn-werkmap.

-q, --stil
Onderdruk de uitvoer, behalve bij fouten.

-v, --uitgebreid
Toon extra output.

-I pad1,pad2,...
Voeg een of meer bibliotheekpaden toe aan @INC, zoals Perl's -I. Handig als --tidyall-class of
plug-ins bevinden zich in een alternatieve lib-map.

--back-up-ttl duur
Tijdsduur voordat back-upbestanden kunnen worden gewist. Kan een aantal seconden zijn, of wat dan ook
tekenreeks herkend door Tijd::Duur::Parse, bijvoorbeeld "4h" of "1day". Standaard ingesteld op "1 uur".

--alleen-controleren
In plaats van bestanden daadwerkelijk op te ruimen, controleert u of elk bestand is opgeruimd (dat wil zeggen of het is opgeruimd
versie gelijk is aan de huidige versie) en beschouw het als een fout als dat niet het geval is. Dit wordt gebruikt
door Test::Code::TidyAll en de svn en git pre-commit hooks, bijvoorbeeld om af te dwingen
dat u uw bestanden heeft opgeruimd.

--conf-bestand pad
Geef het relatieve of absolute pad op naar het configuratiebestand, in plaats van ernaar te zoeken in het
gebruikelijke manier.

--conf-naam naam
Geef een conf-bestandsnaam op waarnaar moet worden gezocht in plaats van de standaardwaarden ("tidyall.ini" /
".tidyallrc").

--data-dir pad
Bevat gegevens zoals back-ups en cache. Standaard ingesteld op root_dir/.tidyall.d

--iteraties tellen
Voer elke nettere transformatie uit tellen keer. Standaard is 1.

In sommige gevallen (hopelijk zeldzaam) kan de uitvoer van een opruimer anders zijn als dat zo is
meerdere keren toegepast. Mogelijk wilt u meerdere iteraties uitvoeren om er zeker van te zijn dat de
de inhoud ' nestelt zich ' in zijn uiteindelijke opgeruimde vorm - vooral als de netheid aanwezig is
afgedwongen met een versiebeheerhook of een test. Uiteraard zullen de prestaties eronder lijden
klein. U hoeft dit zelden hoger dan 2 in te stellen.

Dit heeft alleen gevolgen voor opruimers, niet voor validators; bijvoorbeeld perlcritic en jshint zouden dat nog steeds doen
slechts één keer worden uitgevoerd.

--geen-back-ups
Maak geen back-up van bestanden voordat u deze verwerkt.

--geen cache
Bewaar de laatst verwerkte tijden niet in de cache; verwerk alle bestanden elke keer. Zie ook
"--ververs-cache".

--uitvoer-achtervoegsel achtervoegsel
Achtervoegsel dat aan een bestandsnaam moet worden toegevoegd voordat de gewijzigde versie wordt uitgevoerd, bijvoorbeeld ".tdy".
De standaardinstelling is geen, wat betekent dat het bestand wordt overschreven.

--vernieuwen-cache
Wis alle bestaande cache-informatie voordat u elk bestand verwerkt en schrijf vervolgens nieuwe cache-informatie.
Zie ook "--geen cache".

--root-dir
Geef de hoofdmap expliciet op. Meestal wordt dit afgeleid uit de opgegeven bestanden
of de huidige werkmap.

--tidyall-klasse klasse
Subklasse die moet worden gebruikt in plaats van "Code::TidyAll".

opgeven opties in configuratie
Bijna elke opdrachtregeloptie kan bovenaan het configuratiebestand worden opgegeven, boven de
plug-in secties. Vervang streepjes door onderstrepingstekens. bijv

backup_ttl = 4 uur
iteraties = 2
netjesall_class = Mijn::Code::TidyAll

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

...

Als een optie op beide plaatsen wordt doorgegeven, heeft de opdrachtregel voorrang.

EXIT STATUS

"tidyall" wordt afgesloten met status 1 als er fouten zijn opgetreden tijdens het verwerken van bestanden, en 0
anders.

MODES

U kunt opschonen in een aantal verschillende contexten gebruiken, maar het kan zijn dat u niet alles wilt uitvoeren
plug-ins in allemaal.

U kunt via "-m" of "--mode" een modus doorgeven aan ridall, en vervolgens bepaalde plug-ins specificeren
mag alleen in bepaalde modi worden uitgevoerd (via "only_modes") of moet in alle modi worden uitgevoerd, behalve in bepaalde
modi (via "except_modes").

Voorbeelden van modi:

· "cli" - wanneer netjesall expliciet wordt aangeroepen vanaf de opdrachtregel zonder dat er een modus is opgegeven

· "editor" - bij het aanroepen vanuit een editor

· "commit" - bij gebruik van een commit hook zoals Code::TidyAll::SVN::Precommit of
Code::TidyAll::Git::Precommit

· "test" - bij gebruik van Test::Code::TidyAll

Omdat perlcritic een beetje tijdrovend is, wil je het misschien alleen tijdens tests uitvoeren
en expliciete opdrachtregelaanroep:

[PerlCritic]
selecteer = lib/**/*.pm
only_modes = testcli
...

Of u kunt opgeven dat het in alle modi moet worden uitgevoerd behalve de bewerker:

[PerlCritic]
selecteer = lib/**/*.pm
behalve_modes = editor
...

Als u noch "only_modes" noch "except_modes" opgeeft voor een plug-in, dan zal dit altijd zo zijn
rennen.

LAATSTE VERWERKT CACHE

"tidyall" houdt de handtekening van elk bestand bij nadat het voor het laatst is verwerkt. Op volgende
wordt uitgevoerd, zal het een bestand alleen verwerken als de handtekening ervan is gewijzigd. De cache wordt bewaard in bestanden
onder de gegevensdirectory.

U kunt het vernieuwen van de cache forceren met "--refresh-cache", of het gedrag uitschakelen
geheel met "--no-cache".

BACK-UPS

"tidyall" maakt een back-up van elk bestand voordat het wordt gewijzigd. De back-ups met tijdstempel worden bewaard in een
afzonderlijke maphiërarchie onder de gegevensmap.

Oude back-upbestanden worden automatisch verwijderd als onderdeel van incidentele "opruimacties". De
de duur gespecificeerd in "--backup-ttl" geeft zowel de minimale hoeveelheid tijd voor back-ups aan
moeten worden aangehouden, en de frequentie waarmee zuiveringen moeten worden uitgevoerd. Het kan worden gespecificeerd als "30m"
of "4 uur" of een willekeurige tekenreeks die acceptabel is voor Tijd::Duur::Parse. De standaardwaarde is "1h" (1
uur).

U kunt back-ups uitschakelen met "--no-backups".

"MISSEND" VOORVEREISTEN

De distributie "Code::TidyAll" is opzettelijk niet afhankelijk van de vereisten die daarvoor nodig zijn
elke plug-in. Dit betekent dat als u de perltidy wilt gebruiken, u de
Perl::Module handmatig opruimen.

VERBAND TOOLS

· etc/editors/tidyall.el
netjesall/master/etc/editors/tidyall.el> en etc/editors/tidyall.vim

in deze distributie bevat Emacs- en Vim-opdrachten voor het uitvoeren van "tidyall" op de
huidige buffer. U kunt dit toewijzen aan de toetsaanslag van uw keuze (bijvoorbeeld ctrl-t of
,T).

· Code::TidyAll::SVN::Precommit implementeert een subversion pre-commit hook die controleert of
alle bestanden zijn opgeruimd en geldig volgens "tidyall", en weigeren de commit als dat niet het geval is.

· Code::TidyAll::Git::Precommit en Code::TidyAll::Git::Prereceive implementeer git pre-
commit en pre-receive hooks die respectievelijk controleren of alle bestanden zijn opgeruimd en
geldig volgens "tidyall".

· Test::Code::TidyAll is een testbibliotheek om te controleren of alle bestanden in uw project aanwezig zijn
zich in een opgeruimde en geldige staat bevinden.

BEKENDE BUGS

· Werkt nog niet op Windows

Gebruik opgeruimdallp online met behulp van onworks.net-services