Git Product home page Git Product logo

gci's Introduction

GCI

GCI, a tool that control golang package import order and make it always deterministic.

It handles empty lines more smartly than goimport does.

Download

$ go get github.com/daixiang0/gci

Usage

$ gci -h
usage: gci [flags] [path ...]
  -d	display diffs instead of rewriting files
  -local string
    	put imports beginning with this string after 3rd-party packages, only support one string
  -w	write result to (source) file instead of stdout

Examples

Run gci -w -local github.com/daixiang0/gci main.go and you will handle following cases.

simple case

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

  "fmt"

  "github.com/daixiang0/gci"
)

to

package main
import (
  "fmt"

  "golang.org/x/tools"

  "github.com/daixiang0/gci"
)

with alias

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

to

package main
import (
  "fmt"

  go "github.com/golang"

  "github.com/daixiang0/gci"
)

with comment and alias

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

to

package main
import (
  "fmt"

  // golang
  _ "github.com/golang"

  "github.com/daixiang0/gci"
)

with above comment and alias

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

to

package main
import (
  "fmt"

  // golang
  _ "github.com/golang"

  "github.com/daixiang0/gci"
)

TODO

  • Support multi-3rd-party packages
  • Support multiple lines of comment in import block
  • Add testcases

gci's People

Contributors

daixiang0 avatar ldez avatar danxmoran avatar kwo avatar lukeshu avatar elliots avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.