pretty package versions

jean85/예쁜 패키지 버전

종속성의 예쁜 버전 문자열을 얻기 위한 작고 독립적인 래퍼입니다.

설치

• 라이브러리에서 이 패키지를 사용하는 경우 ^1.5 || ^2.0 제약 조건으로 요구하는 것이 좋습니다. ^1.5 || ^2.0 , 최종 사용자가 Composer 2로 즉시 업그레이드하도록 제한하지 않고 모든 기능을 얻으려면

설치하려면 Composer를 사용하십시오.

• CLI에서: composer require 'jean85/pretty-package-versions:^1.5 || ^2.0'
• 또는 composer.json 에서 직접:

{
    "require" : {
        "jean85/pretty-package-versions" : " ^1.5 || ^2.0 "
    }
}

호환성

이 패키지는 ocramius/package-versions에 대한 얇은 래퍼로 탄생했습니다. Composer 2의 출현으로 ComposerInstalledVersions 직접 사용할 수 있으므로 더 이상 필요하지 않습니다. 이로 인해 다음 버전 호환성 차트가 생성되었습니다.

pretty-package-versions	작곡가	사용된 종속성
최대 1.2	1.x 전용	ocramius/package-versions
1.3	1.x와 2.x 모두	composer/package-versions-deprecated , ocramius/package-versions 포크
1.4	2.x 전용	없음
1.5+	1.x와 2.x 모두	composer/package-versions-deprecated , ocramius/package-versions 포크
2.0	2.x 전용	없음

즉, 이 패키지를 사용하면 사용자를 특정 Composer 버전에 묶지 않고도 원활한 업그레이드 경로를 통해 예쁜 버전을 얻을 수 있습니다. 1.4 릴리스는 #21의 일부 논의 및 관련 문제로 인해 되돌려졌습니다.

용법

이 패키지는 Jean85PrettyVersions 단일 클래스와 함께 사용해야 합니다. 이 패키지는 다음 예제와 같이 요청된 패키지에 대해 Jean85Version 개체를 반환하는 단일 메서드를 제공합니다.

 use Jean85  PrettyVersions ;

$ version = PrettyVersions:: getVersion ( ' phpunit/phpunit ' );
$ version -> getPrettyVersion (); // '6.0.0'
$ version -> getShortVersion (); // '6.0.0'
$ version -> getVersionWithShortReference (); // '6.0.0@fa5711'

$ version = PrettyVersions:: getVersion ( ' roave/security-advisories ' );
$ version -> getPrettyVersion (); // 'dev-master@7cd88c8'
$ version -> getShortVersion (); // 'dev-master'
$ version -> getVersionWithShortReference (); // 'dev-master@7cd88c8'

Version 클래스에는 __toString() 메서드도 구현되어 있으므로 쉽게 문자열로 캐스팅할 수 있습니다. 결과는 getPrettyVersion() 메서드를 호출하는 것과 동일합니다.

사용 가능한 방법

Jean85Version 클래스에는 다음과 같은 공개 메소드가 있습니다:

• getPrettyVersion(): string : 요청된 패키지가 태그된 버전인 경우 짧은 버전만 반환합니다. 그렇지 않은 경우 getVersionWithShortCommit() 과 동일한 결과를 출력합니다.

• getShortVersion(): string : 패키지 버전만 반환합니다(예: 6.0.0 , v.1.7.0 , 99999-dev 등...)

• getReference(): string 설치된 패키지의 참조(일반적으로 전체 Git 커밋 해시)를 반환합니다.

• getShortReference(): string 참조의 단축 버전을 반환합니다(예: fa5711 ).

• getVersionWithShortReference(): string : 패키지 버전과 참조의 짧은 버전(예: 6.0.0@fa5711 )을 반환합니다.

• getPackageName(): string 원래 패키지 이름을 반환합니다.

• getFullVersion(): string PackageVersionsVersions::getVersion() 과 동일한 값을 반환합니다.

• __toString(): string getPrettyVersion() 과 동일한 결과를 반환합니다.

1.5 이후

1.5 릴리스부터 두 가지 추가 방법을 사용할 수 있습니다.

• PrettyVersions::getRootPackageName 현재(루트) 프로젝트의 패키지 이름을 반환하므로 기본적으로 composer.json 의 name 속성 값입니다. PackageVersionsVersions::ROOT_PACKAGE_NAME 대신 사용되는 호환성 레이어입니다. 이는 일시적인 종속성이며 존재한다고 보장되지 않습니다.
• PrettyVersions::getRootPackageVersion 은 PrettyVersions::getVersion(PrettyVersions::getRootPackageName()) 의 바로가기입니다.

2.0 이전

이름에 reference 있는 메서드는 Composer 2 API에서 검색된 데이터의 의미를 더 잘 반영하기 위해 2.0 릴리스에 도입되었습니다. 동작은 여전히 ​​존재하지만 더 이상 사용되지 않는 이전 메서드와 동일합니다.

새로운 방법	오래되고 더 이상 사용되지 않는 방법
Version::getReference()	Version::getCommitHash()
Version::getShortReference()	Version::getShortCommitHash()
Version::getVersionWithShortReference()	Version::getVersionWithShortCommit()