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"
• مخصص: قسم مخصص، استخدم التطابق الكامل والأطول (طابق السلسلة الكاملة أولاً، إذا كانت هناك تطابقات متعددة، استخدم أطولها)
• الافتراضي: جميع كتل الاستيراد المتبقية
• فارغ: ضع الواردات الفارغة معًا في مجموعة منفصلة
• النقطة: قم بتجميع الواردات النقطية معًا في مجموعة منفصلة
• الاسم المستعار: قم بتجميع عمليات استيراد الاسم المستعار معًا في مجموعة منفصلة
• localmodule: ضع الواردات من الحزم المحلية في مجموعة منفصلة

الأولوية هي القياسية > الافتراضية > المخصصة > الفارغة > نقطة > الاسم المستعار > الوحدة المحلية، ويتم فرز جميع الأقسام أبجديًا بالداخل. افتراضيًا، لا يتم استخدام الأقسام الفارغة والنقطة والاسم المستعار، وينتهي الأمر بالأسطر المقابلة في المجموعات الأخرى.

تستخدم كافة كتل الاستيراد علامة TAB( t ) واحدة كمسافة بادئة.

منذ الإصدار 0.9.0، تضع GCI دائمًا كتلة استيراد C كأول كتلة.

ملحوظة :

من الصعب التعامل مع nolint على مستوى القسم، وسوف تعتبره GCI بمثابة تعليق واحد.

LocalModule

يتم اكتشاف الوحدة المحلية من خلال قراءة اسم الوحدة من ملف 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"
)

المهام

• تأكد من وجود فراغ واحد فقط بين Name Path في كتلة الاستيراد
• تأكد من وجود فراغ واحد فقط بين Path Comment في كتلة الاستيراد
• تنسيق التعليقات
• أضف المزيد من حالات الاختبار
• دعم إكمال الواردات (يرجى استخدام goimports أولاً ثم استخدام GCI)
• تحسين التعليقات
• قم بإزالة طبقة المحلل واستخدم بناء جملة المحلل بشكل كامل