gci

GCI

GCI, uma ferramenta que controla a ordem de importação de pacotes Go e a torna sempre determinística.

O formato de saída desejado é altamente configurável e permite uma formatação mais personalizada do que goimport .

O GCI considera um bloco de importação baseado em AST conforme abaixo:

 Doc
Name Path Comment

Todos os comentários permanecerão como estavam, exceto os blocos de comentários isolados.

Os blocos de comentários isolados como abaixo:

 import (
  "fmt"
  // this line is isolated comment

  // those lines belong to one
  // isolated comment blocks

  "github.com/daixiang0/gci"
)

GCI divide todos os blocos de importação em seções diferentes, agora suporta seis tipos de seção:

• padrão: vá para importações oficiais, como "fmt"
• personalizado: seção personalizada, use a correspondência completa e a mais longa (corresponda a string completa primeiro, se houver várias correspondências, use a mais longa)
• padrão: todos os blocos de importação restantes
• em branco: coloque as importações em branco juntas em um grupo separado
• dot: Coloque as importações de pontos juntas em um grupo separado
• alias: Coloque as importações de alias juntas em um grupo separado
• localmodule: Coloque as importações de pacotes locais em um grupo separado

A prioridade é padrão > padrão > personalizado > em branco > ponto > alias > módulo local, todas as seções são classificadas em ordem alfabética dentro. Por padrão, as seções em branco, ponto e alias não são usadas e as linhas correspondentes terminam nos outros grupos.

Todos os blocos de importação usam uma TAB( t ) como recuo.

Desde a v0.9.0, o GCI sempre coloca o bloco de importação C como o primeiro.

Observação :

nolint é difícil de lidar no nível da seção, o GCI irá considerá-lo como um único comentário.

Módulo Local

A detecção do módulo local é feita lendo o nome do módulo no arquivo go.mod no diretório onde gci é invocado . Isso significa:

• Este modo funciona quando gci é invocado a partir de uma raiz de módulo (ou seja, diretório contendo go.mod )
• Este modo não funciona com uma configuração de vários módulos, ou seja, quando gci é invocado de um diretório contendo go.work (embora funcionaria se invocado de dentro de um dos módulos no espaço de trabalho)

Instalação

Para baixar e instalar a versão mais recente disponível -

go install github.com/daixiang0/gci@latest

Você também pode especificar uma versão específica, por exemplo:

go install github.com/daixiang0/[email protected]

Uso

Agora o GCI fornece dois métodos de linha de comando, principalmente para compatibilidade com versões anteriores.

Novo estilo

GCI suporta três modos de operação

Observação

Desde a v0.10.0, os sinalizadores -s --section só podem ser usados ​​várias vezes para especificar várias seções. Por exemplo, você poderia usar -s standard,default antes, mas agora você deve usar -s standard -s default . Essa alteração significativa possibilita que o projeto suporte a especificação de vários prefixos personalizados. (Por favor veja abaixo.)

$ 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

Estilo antigo

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.

Observação ::

O estilo antigo é apenas para testes locais, será descontinuado, use o novo estilo, golangci-lint também usa o novo estilo.

Exemplos

Execute gci write -s standard -s default -s "prefix(github.com/daixiang0/gci)" main.go e você lidará com os seguintes casos:

caso simples

 package main
import (
  "golang.org/x/tools"

  "fmt"

  "github.com/daixiang0/gci"
)

para

 package main
import (
    "fmt"

    "golang.org/x/tools"

    "github.com/daixiang0/gci"
)

com apelido

 package main
import (
  "fmt"
  go "github.com/golang"
  "github.com/daixiang0/gci"
)

para

 package main
import (
  "fmt"

  go "github.com/golang"

  "github.com/daixiang0/gci"
)

com agrupamento em branco e ponto ativado

 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"
)

para

 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"
)

com agrupamento de alias ativado

 package main

import (
	testing "github.com/daixiang0/test"
	"fmt"

	g "github.com/golang"

	"github.com/daixiang0/gci"
	"github.com/daixiang0/gci/subtest"
)

para

 package main

import (
	"fmt"

	"github.com/daixiang0/gci"
	"github.com/daixiang0/gci/subtest"

	testing "github.com/daixiang0/test"
	g "github.com/golang"
)

com agrupamento localmodule ativado

Supondo que isso seja executado na raiz deste repositório (ou seja, onde github.com/daixiang0/gci é um módulo local)

 package main

import (
	"os"
	"github.com/daixiang0/gci/cmd/gci"
)

para

 package main

import (
	"os"

	"github.com/daixiang0/gci/cmd/gci"
)

PENDÊNCIA

• Garanta apenas um espaço em branco entre Name e Path em um bloco de importação
• Garanta apenas um espaço em branco entre Path e Comment em um bloco de importação
• Formatar comentários
• Adicione mais casos de teste
• Apoie a conclusão de importações (use goimports primeiro e depois use GCI)
• Otimizar comentários
• Remova a camada do analisador e use totalmente a sintaxe do analisador