Grit includes standard patterns for declaratively adding or finding imports.
The main function for Go is require_import(source=$module), which ensures that the given module is imported and returns the name it was imported as. This is useful for ensuring that a module is imported, and for finding the name it was imported as.
Apply with the Grit CLI
grit apply go_importing
Already imported
BEFORE
package main
import "othermodule"
import "somepackage/somemodule"
func main() {
use_real_getenv()
}AFTER
package main
import "othermodule"
import "somepackage/somemodule"
func main() {
somemodule.Getenv()
}Aliased import
BEFORE
package main
import aliasmodule "somepackage/somemodule"
func main() {
use_real_getenv()
}AFTER
package main
import aliasmodule "somepackage/somemodule"
func main() {
aliasmodule.Getenv()
}Add the import, existing list
BEFORE
package main
import (
"foo"
"bar"
)
func main() {
use_real_getenv()
}AFTER
package main
import (
"foo"
"bar"
"somepackage/somemodule"
)
func main() {
somemodule.Getenv()
}Add the same import twice
BEFORE
package main
import (
"foo"
"bar"
)
func foo() {
second_case()
}
func main() {
use_real_getenv()
}AFTER
package main
import (
"foo"
"bar"
"somepackage/somemodule"
)
func foo() {
somemodule.CaseTwo()
}
func main() {
somemodule.Getenv()
}Single existing import
BEFORE
package main
import "foo"
func main() {
use_real_getenv()
}AFTER
package main
import "foo"
import "somepackage/somemodule"
func main() {
somemodule.Getenv()
}No imports at all
BEFORE
package main
func main() {
use_real_getenv()
module_two()
}AFTER
package main
import "somepackage/somemodule"
import "somepackage/packagetwo"
func main() {
somemodule.Getenv()
packagetwo.ModuleTwo()
}Known name
Sometimes the package name is different from the module name. In those cases, you must specify it explicitly, like require_import(source="somepackage/somemodule", as="model").
BEFORE
package main
func main() {
add_aliased_import()
}AFTER
package main
import "somepackage/my-model"
func main() {
model.my_import()
}As does not conflict
If the import is already aliased, the aliased name will be used.
BEFORE
package main
import coolmodel "somepackage/my-model"
func main() {
add_aliased_import()
}AFTER
package main
import coolmodel "somepackage/my-model"
func main() {
coolmodel.my_import()
}