Go 패키지 가져오기 순서를 제어하고 이를 항상 결정적으로 만드는 도구인 GCI입니다.
원하는 출력 형식은 고도로 구성 가능하며 goimport
보다 더 많은 사용자 정의 형식을 허용합니다.
GCI는 다음과 같이 AST 기반의 가져오기 차단을 고려합니다.
Doc
Name Path Comment
격리된 주석 블록을 제외하고 모든 주석은 그대로 유지됩니다.
격리된 주석은 아래와 같이 차단됩니다.
import (
"fmt"
// this line is isolated comment
// those lines belong to one
// isolated comment blocks
"github.com/daixiang0/gci"
)
GCI는 모든 가져오기 블록을 여러 섹션으로 분할하며 이제 6가지 섹션 유형을 지원합니다.
우선 순위는 표준 > 기본값 > 사용자 정의 > 공백 > 점 > 별칭 > 로컬 모듈이며 모든 섹션은 내부에서 알파벳순으로 정렬됩니다. 기본적으로 공백, 점 및 별칭 섹션은 사용되지 않으며 해당 줄은 다른 그룹에 포함됩니다.
모든 가져오기 블록은 들여쓰기로 하나의 탭( t
)을 사용합니다.
v0.9.0부터 GCI는 항상 C 가져오기 블록을 첫 번째로 배치합니다.
메모 :
nolint
섹션 수준에서 처리하기 어렵습니다. GCI는 이를 단일 주석으로 간주합니다.
로컬 모듈 감지는 gci
호출되는 디렉토리 의 go.mod
파일에서 모듈 이름을 읽어 수행됩니다. 이는 다음을 의미합니다.
gci
모듈 루트(예: go.mod
포함된 디렉토리)에서 호출될 때 작동합니다.go.work
포함된 디렉토리에서 gci
호출하는 경우(작업공간의 모듈 중 하나에서 호출하면 작동하지만) 사용 가능한 가장 높은 릴리스 버전을 다운로드하여 설치하려면 -
go install github.com/daixiang0/gci@latest
다음과 같이 특정 버전을 지정할 수도 있습니다.
go install github.com/daixiang0/[email protected]
이제 GCI는 주로 이전 버전과의 호환성을 위해 두 가지 명령줄 방법을 제공합니다.
GCI는 세 가지 작동 모드를 지원합니다.
메모
v0.10.0부터
-s
및--section
플래그는 여러 섹션을 지정하기 위해 여러 번만 사용할 수 있습니다. 예를 들어 이전에는-s standard,default
사용할 수 있었지만 이제는-s standard -s default
사용해야 합니다. 이러한 주요 변경 사항을 통해 프로젝트는 여러 사용자 지정 접두사 지정을 지원할 수 있습니다. (아래를 참조해 주세요.)
$ gci print -h
Print outputs the formatted file. If you want to apply the changes to a file use write instead !
Usage:
gci print path... [flags]
Aliases:
print, output
Flags:
--custom-order Enable custom order of sections
-d, --debug Enables debug output from the formatter
-h, --help help for print
-s, --section stringArray Sections define how inputs will be processed. Section names are case-insensitive and may contain parameters in (). The section order is standard > default > custom > blank > dot > alias > localmodule. The default value is [standard,default].
standard - standard section that Go provides officially, like " fmt "
Prefix(github.com/daixiang0) - custom section, groups all imports with the specified Prefix. Imports will be matched to the longest Prefix. Multiple custom prefixes may be provided, they will be rendered as distinct sections separated by newline. You can regroup multiple prefixes by separating them with comma: Prefix(github.com/daixiang0,gitlab.com/daixiang0,daixiang0)
default - default section, contains all rest imports
blank - blank section, contains all blank imports.
dot - dot section, contains all dot imports. (default [standard,default])
alias - alias section, contains all alias imports.
localmodule: localmodule section, contains all imports from local packages
--skip-generated Skip generated files
--skip-vendor Skip files inside vendor directory
$ gci write -h
Write modifies the specified files in-place
Usage:
gci write path... [flags]
Aliases:
write, overwrite
Flags:
--custom-order Enable custom order of sections
-d, --debug Enables debug output from the formatter
-h, --help help for write
-s, --section stringArray Sections define how inputs will be processed. Section names are case-insensitive and may contain parameters in (). The section order is standard > default > custom > blank > dot > alias > localmodule. The default value is [standard,default].
standard - standard section that Go provides officially, like " fmt "
Prefix(github.com/daixiang0) - custom section, groups all imports with the specified Prefix. Imports will be matched to the longest Prefix. Multiple custom prefixes may be provided, they will be rendered as distinct sections separated by newline. You can regroup multiple prefixes by separating them with comma: Prefix(github.com/daixiang0,gitlab.com/daixiang0,daixiang0)
default - default section, contains all rest imports
blank - blank section, contains all blank imports.
dot - dot section, contains all dot imports. (default [standard,default])
alias - alias section, contains all alias imports.
localmodule: localmodule section, contains all imports from local packages
--skip-generated Skip generated files
--skip-vendor Skip files inside vendor directory
$ gci list -h
Prints the filenames that need to be formatted. If you want to show the diff use diff instead, and if you want to apply the changes use write instead
Usage:
gci list path... [flags]
Flags:
--custom-order Enable custom order of sections
-d, --debug Enables debug output from the formatter
-h, --help help for list
-s, --section stringArray Sections define how inputs will be processed. Section names are case-insensitive and may contain parameters in (). The section order is standard > default > custom > blank > dot > alias > localmodule. The default value is [standard,default].
standard - standard section that Go provides officially, like " fmt "
Prefix(github.com/daixiang0) - custom section, groups all imports with the specified Prefix. Imports will be matched to the longest Prefix. Multiple custom prefixes may be provided, they will be rendered as distinct sections separated by newline. You can regroup multiple prefixes by separating them with comma: Prefix(github.com/daixiang0,gitlab.com/daixiang0,daixiang0)
default - default section, contains all rest imports
blank - blank section, contains all blank imports.
dot - dot section, contains all dot imports. (default [standard,default])
alias - alias section, contains all alias imports.
localmodule: localmodule section, contains all imports from local packages
--skip-generated Skip generated files
--skip-vendor Skip files inside vendor directory
$ gci diff -h
Diff prints a patch in the style of the diff tool that contains the required changes to the file to make it adhere to the specified formatting.
Usage:
gci diff path... [flags]
Flags:
--custom-order Enable custom order of sections
-d, --debug Enables debug output from the formatter
-h, --help help for diff
-s, --section stringArray Sections define how inputs will be processed. Section names are case-insensitive and may contain parameters in (). The section order is standard > default > custom > blank > dot > alias > localmodule. The default value is [standard,default].
standard - standard section that Go provides officially, like " fmt "
Prefix(github.com/daixiang0) - custom section, groups all imports with the specified Prefix. Imports will be matched to the longest Prefix. Multiple custom prefixes may be provided, they will be rendered as distinct sections separated by newline. You can regroup multiple prefixes by separating them with comma: Prefix(github.com/daixiang0,gitlab.com/daixiang0,daixiang0)
default - default section, contains all rest imports
blank - blank section, contains all blank imports.
dot - dot section, contains all dot imports. (default [standard,default])
alias - alias section, contains all alias imports.
localmodule: localmodule section, contains all imports from local packages
--skip-generated Skip generated files
--skip-vendor Skip files inside vendor directory
Gci enables automatic formatting of imports in a deterministic manner
If you want to integrate this as part of your CI take a look at golangci-lint.
Usage:
gci [-diff | -w rite] [--local localPackageURLs] path... [flags]
gci [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
diff Prints a git style diff to STDOUT
help Help about any command
list Prints filenames that need to be formatted to STDOUT
print Outputs the formatted file to STDOUT
write Formats the specified files in-place
Flags:
-d, --diff display diffs instead of rewriting files
-h, --help help for gci
-l, --local strings put imports beginning with this string after 3rd-party packages, separate imports by comma
-v, --version version for gci
-w, --write write result to (source) file instead of stdout
Use " gci [command] --help " for more information about a command.
메모 ::
이전 스타일은 로컬 테스트에만 사용되며 더 이상 사용되지 않습니다. 새 스타일을 사용하세요. golangci-lint
도 새 스타일을 사용합니다.
gci write -s standard -s default -s "prefix(github.com/daixiang0/gci)" main.go
실행하면 다음 사례를 처리하게 됩니다.
package main
import (
"golang.org/x/tools"
"fmt"
"github.com/daixiang0/gci"
)
에게
package main
import (
"fmt"
"golang.org/x/tools"
"github.com/daixiang0/gci"
)
package main
import (
"fmt"
go "github.com/golang"
"github.com/daixiang0/gci"
)
에게
package main
import (
"fmt"
go "github.com/golang"
"github.com/daixiang0/gci"
)
package main
import (
"fmt"
go "github.com/golang"
_ "github.com/golang/blank"
. "github.com/golang/dot"
"github.com/daixiang0/gci"
_ "github.com/daixiang0/gci/blank"
. "github.com/daixiang0/gci/dot"
)
에게
package main
import (
"fmt"
go "github.com/golang"
"github.com/daixiang0/gci"
_ "github.com/daixiang0/gci/blank"
_ "github.com/golang/blank"
. "github.com/daixiang0/gci/dot"
. "github.com/golang/dot"
)
package main
import (
testing "github.com/daixiang0/test"
"fmt"
g "github.com/golang"
"github.com/daixiang0/gci"
"github.com/daixiang0/gci/subtest"
)
에게
package main
import (
"fmt"
"github.com/daixiang0/gci"
"github.com/daixiang0/gci/subtest"
testing "github.com/daixiang0/test"
g "github.com/golang"
)
이것이 이 저장소의 루트에서 실행된다고 가정합니다(예: github.com/daixiang0/gci
로컬 모듈인 경우).
package main
import (
"os"
"github.com/daixiang0/gci/cmd/gci"
)
에게
package main
import (
"os"
"github.com/daixiang0/gci/cmd/gci"
)
Name
과 Path
사이에 하나만 공백으로 두십시오.Path
와 Comment
사이에 공백 하나만 확인하세요.goimports
사용한 다음 GCI를 사용하세요)