Главная страница>Связанные с программированием>Другой исходный код
Скачать

GCI

GCI — инструмент, который контролирует порядок импорта пакетов Go и делает его всегда детерминированным.

Желаемый выходной формат легко настраивается и допускает больше настраиваемого форматирования, чем 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 разделяет все блоки импорта на разные разделы, теперь поддерживает шесть типов разделов:

  • стандарт: официальный импорт, например "fmt"
  • custom: пользовательский раздел, используйте полное и самое длинное совпадение (сначала сопоставьте полную строку, если совпадений несколько, используйте самое длинное)
  • по умолчанию: все остальные блоки импорта.
  • пусто: поместите пустые импортированные файлы в отдельную группу.
  • точка: поместить импорт точек в отдельную группу.
  • псевдоним: поместите импорт псевдонимов в отдельную группу.
  • localmodule: поместите импорт из локальных пакетов в отдельную группу.

Приоритет стандартный > по умолчанию > пользовательский > пустой > точка > псевдоним > локальный модуль, все разделы внутри сортируются по алфавиту. По умолчанию разделы пустые, точечные и псевдонимы не используются, а соответствующие строки попадают в другие группы.

Все блоки импорта используют один TAB( t ) в качестве отступа.

Начиная с версии 0.9.0, GCI всегда ставит блок импорта C первым.

Примечание :

nolint сложно обрабатывать на уровне раздела, GCI будет рассматривать его как один комментарий.

ЛокальныйМодуль

Обнаружение локального модуля осуществляется путем чтения имени модуля из файла go.mod в каталоге, где вызывается gci . Это означает:

  • Этот режим работает, когда gci вызывается из корня модуля (т.е. каталога, содержащего go.mod ).
  • Этот режим не работает при настройке нескольких модулей, т. е. когда gci вызывается из каталога, содержащего go.work (хотя он будет работать, если его вызвать из одного из модулей в рабочей области).

Установка

Чтобы загрузить и установить самую последнюю доступную версию: 

go install github.com/daixiang0/gci@latest

Вы также можете указать конкретную версию, например: 

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

Использование

Теперь GCI предоставляет два метода командной строки, в основном для обратной совместимости.

Новый стиль

GCI поддерживает три режима работы

Примечание

Начиная с версии 0.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"
)

TODO

  • Обеспечьте наличие только одного пробела между Name и Path в блоке импорта.
  • Обеспечьте наличие только одного пробела между Path и Comment в блоке импорта.
  • Форматирование комментариев
  • Добавить больше тестовых случаев
  • Поддержка завершения импорта (сначала используйте goimports , а затем GCI)
  • Оптимизация комментариев
  • Удалите слой анализатора и полностью используйте синтаксис анализатора.
Расширять
Дополнительная информация
Рекомендуем вам
Связанные новости Все