tidyallp - 클라우드의 온라인

프로그램:

이름

tidyall - 올인원 코드 정리기 및 유효성 검사기

개요

# 프로젝트 상단에 tidyall.ini 또는 .tidyallrc를 생성합니다.
#
[펄티디]
선택 = **/*.{pl,pm,t}
인수 = -noll -it=2

[펄비평가]
선택 = lib/**/*.pm
무시 = lib/UtterHack.pm
argv = -심각도 3

# 현재 프로젝트의 모든 파일을 처리합니다.
# cwd에서 위쪽으로 conf 파일을 찾습니다.
#
% tidyall -a

# 하나 이상의 특정 파일을 처리합니다.
# 첫 번째 파일에서 위쪽으로 conf 파일을 찾습니다.
#
% 깔끔한 파일 [파일...]

# 디렉터리를 재귀적으로 처리
#
% tidyall -r 디렉토리

기술

세상에는 훌륭한 코드 정리 도구와 유효성 검사 도구가 많이 있습니다. "tidyall"이 그들을 만든다
단일 통합 인터페이스에서 사용할 수 있습니다.

단일 파일이나 전체 프로젝트 계층 구조에서 "tidyall"을 실행하고 구성할 수 있습니다.
어떤 tidiers/validator가 어떤 파일에 적용되는지. "tidyall"은 파일을 백업합니다
효율성을 위해 변경된 파일만 고려합니다.
마지막으로 처리되었습니다.

무엇 a 더 깔끔한? 무엇 a 검증인?
A 더 깔끔한 의미를 변경하지 않고 모양을 개선하기 위해 파일을 변환합니다.
예에는 perltidy, podtidy 및 js-beautify가 포함됩니다.
아름답게>.

A 검증 정확성에 대한 정의를 위해 파일을 분석합니다. 예를 들면 다음과 같습니다
perlcritic, podchecker 및 jshinthttp://www.jshint.com/>.

많은 tidiers는 검증자이기도 합니다. 예를 들어 "perltidy"는 형식이 잘못되면 오류를 발생시킵니다.
펄.

"tidyall"과 함께 tidier 또는 유효성 검사기를 사용하려면 해당 플러그인 클래스가 있어야 합니다.
일반적으로 "Code::TidyAll::Plugin::" 접두사 아래에 있습니다. 이 배포판은 플러그인과 함께 제공됩니다
용 :

· Perl: 펄크리틱, 펄티디, 펄티디-스위트

· 포드: podchecker, podspell, podtidy

· 메이슨(Mason): 벽돌 쌓기

· 자바스크립트: js-beautify, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: phpcs

· 기타: 코드::TidyAll::플러그인::SortLines

자신만의 플러그인을 만드는 방법에 대한 자세한 내용은 Code::TidyAll::Plugin을 참조하세요.

사용 타이디올

"tidyall"은 프로젝트 기반으로 작동합니다. 여기서 프로젝트는 단지 디렉토리 계층 구조일 뿐입니다.
파일. svn 또는 git 작업 디렉토리는 프로젝트의 일반적인 예입니다.

프로젝트의 상단을 뿌리 예배 규칙서. 루트 디렉토리에는 다음이 필요합니다.
"tidyall.ini" 또는 ".tidyallrc"라는 구성 파일; 그것은 다양한 정리 방법을 정의하고
유효성 검사기는 프로젝트의 파일에 적용됩니다.

"tidyall"은 귀하의 루트 디렉터리와 구성 파일을 자동으로 찾습니다.
불러라:

"정돈된 파일 [파일...]"
"tidyall"은 첫 번째 파일부터 위쪽으로 conf 파일을 검색합니다.

"tidyall -p/--파이프 파일"
"tidyall"은 지정된 파일에서 위쪽으로 conf 파일을 검색합니다.

"tidyall -a/--all" 또는 "tidyall -s/--svn" 또는 "tidyall -g/--git"
"tidyall"은 현재 작업 디렉토리에서 위쪽으로 conf 파일을 검색합니다.

"tidyall -a --root-dir 디렉토리"
"tidyall"은 지정된 루트 디렉터리에서 conf 파일을 찾을 것으로 예상합니다.

--conf-name을 전달하여 검색되는 이름을 변경하거나 --conf-file을 전달하여 변경할 수도 있습니다.
명시적인 경로를 지정하십시오.

구성

구성 파일("tidyall.ini" 또는 ".tidyallrc")은 Config::INI 형식입니다. 여기
견본:

[펄티디]
선택 = **/*.{pl,pm,t}
인수 = -noll -it=2

[펄비평가]
선택 = lib/**/*.pm
무시 = lib/UtterHack.pm lib/OneTime/*.pm
argv = -심각도 3

[팟티디]
선택 = lib/**/*.{pm,pod}

세 섹션에서는 순서대로 다음을 선언합니다.

· 모든 *.pl, *.pm 및 *.t 파일에 "-noll -it=2" 설정으로 "PerlTidy"를 적용합니다.

· "lib/" 아래에 있는 모든 Perl 모듈에 심각도 3의 "PerlCritic"을 적용합니다.
"lib/UtterHack.pm"을 제외하고.

· "lib/" 아래의 모든 *.pm 및 *.pod 파일에 기본 설정으로 "PodTidy"를 적용합니다.

ㅁㄴㅇㄹ 구성 요소
[수업] 또는 [수업 설명]
각 섹션의 헤더는 tidyall을 나타냅니다. 플러그인. 이름이 자동으로
'+'로 시작하지 않는 한 "Code::TidyAll::Plugin::" 접두사가 붙습니다. 예:

; 플러그인 Code::TidyAll::Plugin::PerlTidy 사용
;
[펄티디]

; My::TidyAll::Plugin 플러그인을 사용합니다.
;
[+내::TidyAll::플러그인]

수업 후에 선택적 설명을 포함할 수도 있습니다. 설명은 다음과 같습니다.
무시되고 첫 번째 단어만 플러그인에 사용됩니다. 이를 통해 목록을 만들 수 있습니다.
매번 다른 구성으로 플러그인을 두 번 이상 사용합니다. 예를 들어, 두
다양한 "PerlCritic" 구성:

; 도서관에서 잔인하게 행동하세요
;
[PerlCritic 엄격함]
선택 = lib/**/*.pm
argv = --잔인

; 하지만 대본에는 온화하다
;
[Perl비평가 관대함]
선택 = bin/**/*.pl
argv = --부드러운

경고: 설명 없이 동일한 플러그인을 두 번 나열하는 경우(또는 동일한
설명) 그 중 하나는 자동으로 무시됩니다.

고르다
공백이나 여러 줄로 구분된 하나 이상의 File::Zglob 패턴,
선택할 파일을 나타냅니다. 하나 이상이 필요합니다. 예를 들어

; 모든 .t 및 .pl은 bin 및 t 아래 어딘가에 있습니다.
; lib/Foo 및 lib/Bar 바로 아래에 있는 모든 .pm 파일
;
선택 = {bin,t}/**/*.p[lm]
선택 = lib/{Foo,Bar}/*.pm

; 프로젝트의 모든 .txt 파일
;
선택 = **/*.txt

패턴은 루트 디렉터리를 기준으로 하며 앞에 슬래시가 없어야 합니다. 모두
표준 glob 문자("*", "?", "[]", "{}")가 작동합니다. 또한 "**"는 다음과 같습니다.
XNUMX개 이상의 디렉터리를 나타내는 데 사용됩니다. 자세한 내용은 File::Zglob 문서를 참조하세요.
세부.

무시
공백이나 여러 줄로 구분된 하나 이상의 File::Zglob 패턴,
무시할 파일을 나타냅니다. 이는 선택 사항이며 "select"보다 우선합니다. 예를 들어

; bin/awful.pl 또는 모든 위치를 제외하고 bin 아래의 모든 .pl 파일
; bin/tmp 아래
;
선택 = bin/**/*.pl
무시 = bin/awful.pl bin/tmp/**/*.pl

오두막
공백이나 여러 줄로 구분된 하나 이상의 단어로,
수락 할 shebang 라인. 이는 선택 사항이며 추가 필터는 "선택"입니다. 예를 들어

; "perl" 또는 "perl"을 포함하는 bin 아래 확장자가 없는 모든 파일
; "perl5" 셰뱅 라인.
선택 = 빈/**/*
무시 = bin/**/*.*
셔뱅 = 펄 perl5

전용 모드
공백으로 구분된 모드 목록입니다. 예를 들어

only_modes = 테스트 CLI

플러그인은 만 이러한 모드 중 하나가 "-m"을 통해 "tidyall"로 전달되면 실행됩니다.
"--방법".

제외_모드
공백으로 구분된 모드 목록입니다. 예를 들어

Except_modes = 커밋 편집기

플러그인은 지원 이러한 모드 중 하나가 "-m"을 통해 "tidyall"로 전달되면 실행됩니다.
"--방법".

인수
많은 플러그인(예: perltidy, perlcritic 및 podtidy)이 이 옵션을 사용합니다.
기본 명령줄 유틸리티에 전달할 인수를 지정합니다.

무게
플러그인을 정렬하는 데 사용되는 정수입니다. 기본적으로 tidier 플러그인이 먼저 실행됩니다.
그런 다음 각 그룹이 알파벳순으로 정렬된 유효성 검사기 플러그인입니다.

플러그인 주문 및 원자성

여러 플러그인이 파일과 일치하는 경우 유효성 검사기보다 tidiers가 적용되어 유효성 검사기가
최종 결과를 확인 중입니다. 이 두 그룹 내에서 플러그인은 다음과 같이 적용됩니다.
플러그인 이름/설명의 알파벳 순서입니다.

각 플러그인의 가중치를 명시적으로 설정할 수도 있습니다. 기본적으로 tidier에는 가중치가 있습니다.
50이고 유효성 검사기의 가중치는 60입니다. 가중치를 정수로 설정할 수 있습니다.
플러그인이 실행될 때 영향을 미칩니다.

여러 플러그인을 적용하는 것은 전부 아니면 전무입니다. 진행 중 오류가 발생한 경우
플러그인을 적용해도 파일은 전혀 수정되지 않습니다.

명령줄 옵션

-a, --모두
모든 파일을 처리합니다. 프로젝트 계층 구조의 모든 파일을 재귀적으로 검색합니다.
루트에서 시작하여 적어도 하나의 플러그인과 일치하는 모든 파일을 처리합니다.
구성.

-g, --git
현재 git 작업 디렉터리에 추가되거나 수정된 ​​모든 파일을 처리합니다.

-h, --도움말
도움말 메시지 인쇄

-l, --목록
일치하는 플러그인 목록과 함께 각 파일을 나열합니다(일치하는 파일이 없는 파일).
건너뜁니다). 실제로 어떤 파일도 처리하지 않으며 파일이 처리되었는지 여부는 신경 쓰지 않습니다.
캐시되었습니다. 일반적으로 -a, -g 또는 -seg와 함께 사용됩니다.

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

-m, --모드
실행되는 플러그인에 영향을 줄 수 있는 선택적 모드입니다. 기본값은 "cli"입니다. "모드"를 참조하세요.

-p 경로, --파이프 경로
STDIN에서 콘텐츠를 읽고 결과 콘텐츠를 STDOUT에 씁니다. 성공하면,
tidyall은 상태 0으로 종료됩니다. 오류가 발생하면 tidyall은 다음으로 오류 메시지를 출력합니다.
STDERR, 거울 전에, 입력 함유량 변경 사항 없이 STDOUT으로 변경되고 상태 1로 종료됩니다.
미러링은 여부에 관계없이 목적지까지 안전하게 파이프할 수 있음을 의미합니다.
오류가 발생합니다.

이 옵션을 지정할 때 상대 또는 파일 이름 중 정확히 하나의 파일 이름을 지정해야 합니다.
절대적이며 적용할 플러그인과 적용할 플러그인을 결정하는 데 사용됩니다.
루트 디렉터리와 구성 파일은 다음과 같습니다. 파일은 실제로 읽히지 않으며 읽혀집니다.
심지어 존재할 필요도 있습니다.

이 옵션은 --no-backups 및 --no-cache(실제 파일이 없기 때문에)를 의미하며
--quiet (외부 출력과 정리된 결과를 혼합하고 싶지 않기 때문에).

# 적절한 플러그인을 사용하여 STDIN에서 읽고 STDOUT에 씁니다.
# some/path.pl의 경우(존재할 필요는 없음)
#
% tidyall --pipe some/path.pl

-r, --재귀
명령줄에 나열된 디렉터리를 반복적으로 입력하고 모든 파일을 처리합니다.
이내에. 기본적으로 명령줄에서 발견된 디렉터리는
경고.

-s, --svn
현재 svn 작업 디렉토리에 추가되거나 수정된 ​​모든 파일을 처리합니다.

-q, --조용한
오류를 제외한 출력을 억제합니다.

-v, --자세한
추가 출력을 표시합니다.

-I 경로1, 경로2,...
Perl의 -I처럼 @INC에 하나 이상의 라이브러리 경로를 추가합니다. --tidyall-class 또는
플러그인은 대체 lib 디렉토리에 있습니다.

--백업-ttl 지속
백업 파일을 제거할 수 있을 때까지의 시간입니다. 몇 초 또는 그 이상일 수 있습니다.
Time::Duration::Parse로 인식되는 문자열(예: "4h" 또는 "1day"). 기본값은 "1시간"입니다.

--체크 전용
실제로 파일을 정리하는 대신, 각 파일이 정리되었는지 확인하십시오(즉, 정리되었는지 확인하십시오).
버전은 현재 버전과 동일합니다.) 그렇지 않은 경우 오류로 간주합니다. 이것은 사용됩니다
예를 들어 Test::Code::TidyAll 및 svn 및 git 사전 커밋 후크를 사용하여
당신이 파일을 정리했다고요.

--conf 파일 통로
conf 파일에서 검색하는 대신 상대 또는 절대 경로를 지정하십시오.
평소 방법.

--conf-이름 name
기본값 대신 검색할 conf 파일 이름을 지정하십시오("tidyall.ini" /
".tidyallrc").

--데이터 디렉토리 통로
백업 및 캐시와 같은 데이터가 포함되어 있습니다. 기본값은 root_dir/.tidyall.d입니다.

--반복 계산
각각의 깔끔한 변환 실행 계산 타임스. 기본값은 1입니다.

어떤 경우에는(희귀하게도) tidier의 출력이 다를 수 있습니다.
여러 번 적용되었습니다. 여러 번 반복하여 다음을 확인하는 것이 좋습니다.
콘텐츠가 최종 정돈된 형태로 "안착"됩니다. 특히 정돈이 잘 되어 있는 경우에는 더욱 그렇습니다.
버전 제어 후크 또는 테스트를 통해 시행됩니다. 물론 성능은 저하될 것입니다.
작은. 이 값을 2보다 높게 설정할 필요는 거의 없습니다.

이는 유효성 검사기가 아닌 Tidiers에만 영향을 미칩니다. 예를 들어 perlcritic과 jshint는 여전히
한 번만 실행됩니다.

--백업 없음
처리하기 전에 파일을 백업하지 마십시오.

--캐시 없음
마지막으로 처리된 시간을 캐시하지 마세요. 매번 모든 파일을 처리합니다. 또한보십시오
"--새로 고침-캐시".

--출력 접미사 접미사
수정된 버전을 출력하기 전에 파일 이름에 추가하는 접미사입니다(예: ".tdy").
기본값은 없음입니다. 이는 파일을 덮어쓴다는 의미입니다.

--새로 고침-캐시
각 파일을 처리하기 전에 기존 캐시 정보를 모두 지운 다음 새 캐시 정보를 작성하세요.
"--no-cache"도 참조하세요.

--루트 디렉토리
루트 디렉터리를 명시적으로 지정합니다. 일반적으로 이는 지정된 파일에서 추론됩니다.
또는 현재 작업 디렉토리.

--tidyall-클래스 수업
"Code::TidyAll" 대신 사용할 하위 클래스입니다.

지정 옵션 in 구성
거의 모든 명령줄 옵션은 구성 파일 상단,
플러그인 섹션. 대시를 밑줄로 바꾸세요. 예를 들어

backup_ttl = 4시간
반복 = 2
tidyall_class = 내::코드::TidyAll

[펄티디]
선택 = **/*.{pl,pm,t}
인수 = -noll -it=2

...

옵션이 두 위치 모두에서 전달되면 명령줄이 우선 적용됩니다.

EXIT 지위

"tidyall"은 파일을 처리하는 동안 오류가 발생하면 상태 1로 종료되고 0으로 종료됩니다.
그렇지 않으면.

모드

다양한 상황에서 tidyall을 사용할 수 있지만 모두 실행하고 싶지 않을 수도 있습니다.
그들 모두에 플러그인이 있습니다.

"-m" 또는 "--mode"를 통해 tidyall에 모드를 전달한 다음 특정 플러그인을 지정할 수 있습니다.
특정 모드에서만 실행해야 하거나("only_modes"를 통해) 특정 모드를 제외한 모든 모드에서 실행해야 합니다.
모드("Exception_modes"를 통해).

모드의 예:

· "cli" - 지정된 모드 없이 명령줄에서 tidyall을 명시적으로 호출할 때

· "editor" - 편집기에서 호출할 때

· "commit" - Code::TidyAll::SVN::Precommit과 같은 커밋 후크를 사용하는 경우 또는
코드::TidyAll::Git::사전 커밋

· "test" - Test::Code::TidyAll을 사용하는 경우

이제 perlcritic은 약간의 시간이 걸리기 때문에 테스트 중에만 실행하고 싶을 수도 있습니다.
명시적인 명령줄 호출:

[펄비평가]
선택 = lib/**/*.pm
only_modes = 테스트 CLI
...

또는 모든 모드에서 실행되도록 지정할 수도 있습니다. 외 편집자:

[펄비평가]
선택 = lib/**/*.pm
Except_modes = 편집자
...

플러그인에 대해 "only_modes"나 "Exception_modes"를 모두 지정하지 않으면 항상
실행합니다.

마지막 처리됨 은닉처

"tidyall"은 마지막으로 처리된 후 각 파일의 서명을 추적합니다. 후속
실행되면 서명이 변경된 경우에만 파일을 처리합니다. 캐시는 파일에 보관됩니다.
데이터 디렉토리 아래에 있습니다.

"--refresh-cache"를 사용하여 캐시를 강제로 새로 고치거나 동작을 끌 수 있습니다
완전히 "--no-cache"로 처리됩니다.

백업

"tidyall"은 각 파일을 수정하기 전에 백업합니다. 타임스탬프가 지정된 백업은
데이터 디렉토리 아래에 별도의 디렉토리 계층 구조가 있습니다.

가끔 "정리" 실행의 일부로 오래된 백업 파일이 자동으로 제거됩니다. 그만큼
"--backup-ttl"에 지정된 기간은 최소 백업 시간을 나타냅니다.
유지해야 하며 제거 빈도를 실행해야 합니다. "30m"로 지정할 수 있습니다.
또는 "4시간" 또는 Time::Duration::Parse에 허용되는 문자열입니다. 기본값은 "1h"(1
시).

"--no-backups"를 사용하여 백업을 끌 수 있습니다.

"없어진" 전제조건

"Code::TidyAll" 배포판은 의도적으로 다음에 필요한 전제조건에 의존하지 않습니다.
각 플러그인. 이는 Perltidy를 사용하려면 다음을 설치해야 함을 의미합니다.
Perl::모듈을 수동으로 정리합니다.

관련 도구

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

이 배포판에는 "tidyall"을 실행하기 위한 Emacs 및 Vim 명령이 포함되어 있습니다.
현재 버퍼. 이를 원하는 키 입력에 할당할 수 있습니다(예: ctrl-t 또는
,티).

· Code::TidyAll::SVN::Precommit은 다음을 확인하는 Subversion 사전 커밋 후크를 구현합니다.
모든 파일은 "tidyall"에 따라 정리되고 유효하며 그렇지 않은 경우 커밋을 거부합니다.

· Code::TidyAll::Git::Precommit 및 Code::TidyAll::Git::Prereceive는 git pre-를 구현합니다.
모든 파일이 정리되었는지 확인하는 커밋 및 사전 수신 후크
"tidyall"에 따라 유효합니다.

· Test::Code::TidyAll은 프로젝트의 모든 파일이 제대로 작동하는지 확인하는 테스트 라이브러리입니다.
정돈되고 유효한 상태입니다.

KNOWN 버그

· Windows에서는 아직 작동하지 않습니다.

onworks.net 서비스를 사용하여 온라인으로 tidyallp를 사용하세요.