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"
• กำหนดเอง: ส่วนที่กำหนดเอง ใช้การจับคู่แบบเต็มและยาวที่สุด (จับคู่สตริงทั้งหมดก่อน หากตรงกันหลายรายการ ให้ใช้รายการที่ยาวที่สุด)
• ค่าเริ่มต้น: บล็อกการนำเข้าที่เหลือทั้งหมด
• ว่างเปล่า: รวมการนำเข้าที่ว่างเปล่าไว้ด้วยกันในกลุ่มแยกต่างหาก
• dot: รวมการนำเข้า dot เข้าด้วยกันในกลุ่มแยกต่างหาก
• นามแฝง: รวมการนำเข้านามแฝงเข้าด้วยกันในกลุ่มแยกต่างหาก
• 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"
)

โดยเปิดใช้งานการจัดกลุ่มโมดูลภายในเครื่อง

สมมติว่าสิ่งนี้ทำงานบนรูทของ repo นี้ (เช่นโดยที่ 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)
• เพิ่มประสิทธิภาพความคิดเห็น
• ลบเลเยอร์ตัววิเคราะห์และใช้ไวยากรณ์ตัววิเคราะห์อย่างเต็มที่