gimps

package

v0.6.0 Latest Latest Go to latest Published: Oct 25, 2023 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/xrstf/gimps

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Execute(config *Config, filePath string, aliaser *Aliaser) ([]byte, bool, error)
type AliasRule
type Aliaser
- func NewAliaser(projectName string, rules []AliasRule) (*Aliaser, error)
- func (a *Aliaser) RewriteFile(file *ast.File, filePath string, imports map[string]*importMetadata) error
type Classifier
- func NewClassifier(projectName string, sets []Set) *Classifier
- func (c *Classifier) ClassifyImport(pkg string) string
- func (c *Classifier) IsProjectImport(pkg string) bool
type Config
type DependencyCache
- func NewDependencyCache() DependencyCache
- func (c DependencyCache) GetPackageName(filePath string, buildTags string, packagePath string) (string, error)
type GimpsString
type Set

Constants ¶

View Source

const (
	SetStd      = "std"
	SetProject  = "project"
	SetExternal = "external"
)

Variables ¶

This section is empty.

Functions ¶

func Execute ¶

func Execute(config *Config, filePath string, aliaser *Aliaser) ([]byte, bool, error)

Execute is for revise imports and format the code

Types ¶

type AliasRule ¶ added in v0.4.0

type AliasRule struct {
	Name       string `yaml:"name"`
	Expression string `yaml:"expr"`

	Alias string `yaml:"alias"`
	// contains filtered or unexported fields
}

type Aliaser ¶ added in v0.4.0

type Aliaser struct {
	// contains filtered or unexported fields
}

func NewAliaser ¶ added in v0.4.0

func NewAliaser(projectName string, rules []AliasRule) (*Aliaser, error)

func (*Aliaser) RewriteFile ¶ added in v0.4.0

func (a *Aliaser) RewriteFile(file *ast.File, filePath string, imports map[string]*importMetadata) error

type Classifier ¶ added in v0.4.0

type Classifier struct {
	// contains filtered or unexported fields
}

func NewClassifier ¶ added in v0.4.0

func NewClassifier(projectName string, sets []Set) *Classifier

func (*Classifier) ClassifyImport ¶ added in v0.4.0

func (c *Classifier) ClassifyImport(pkg string) string

func (*Classifier) IsProjectImport ¶ added in v0.4.0

func (c *Classifier) IsProjectImport(pkg string) bool

type Config ¶

type Config struct {
	ProjectName string      `yaml:"projectName"`
	ImportOrder []string    `yaml:"importOrder"`
	Sets        []Set       `yaml:"sets"`
	AliasRules  []AliasRule `yaml:"aliasRules"`
}

type DependencyCache ¶ added in v0.4.0

type DependencyCache map[string]astutil.PackageImports

DependencyCache holds a list of package names per build tags (i.e. the key is the build tags string, like "windows prod").

func NewDependencyCache ¶ added in v0.4.0

func NewDependencyCache() DependencyCache

func (DependencyCache) GetPackageName ¶ added in v0.4.0

func (c DependencyCache) GetPackageName(filePath string, buildTags string, packagePath string) (string, error)

type GimpsString ¶ added in v0.4.0

type GimpsString string

type Set ¶

type Set struct {
	Name     string   `yaml:"name"`
	Patterns []string `yaml:"patterns"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL