tsimport

Documentation

Index

• func ImportPathEqual(ip1, ip2 *ImportPath) bool
• func ImportPathsEqual(l1, l2 []*ImportPath) bool
• type Config
• type ImportPath
  • func NewEntActionImportPath(typ string) *ImportPath
  • func NewEntGraphQLImportPath(typ string) *ImportPath
  • func NewEntImportPath(typ string) *ImportPath
  • func NewGQLClassImportPath(typ string) *ImportPath
  • func NewGQLImportPath(typ string) *ImportPath
  • func NewGraphQLJSONImportPath(typ string) *ImportPath
  • func NewLocalEntConnectionImportPath(typ string) *ImportPath
  • func NewLocalEntImportPath(typ string) *ImportPath
  • func NewLocalGraphQLEntImportPath(typ string) *ImportPath
  • func NewLocalGraphQLInputEntImportPath(typ string) *ImportPath
• type Imports
  • func NewImports(cfg Config, filePath string) *Imports
  • func (imps *Imports) ConditionallyReserveImportPath(imp *ImportPath, external bool) (string, error)
  • func (imps *Imports) Export(path string, exports ...string) (string, error)
  • func (imps *Imports) ExportAll(path string) (string, error)
  • func (imps *Imports) ExportAllAs(path, as string) (string, error)
  • func (imps *Imports) FuncMap() template.FuncMap
  • func (imps *Imports) Reserve(path string, imports ...string) (string, error)
  • func (imps *Imports) ReserveAll(path, as string) (string, error)
  • func (imps *Imports) ReserveDefault(path, defaultImport string, imports ...string) (string, error)
  • func (imps *Imports) ReserveImportPath(imp *ImportPath, external bool) (string, error)
  • func (imps *Imports) String() (string, error)
  • func (imps *Imports) Use(impItem string) (string, error)
  • func (imps *Imports) UseMaybe(export string) (string, error)

Functions

func ImportPathEqual

func ImportPathEqual(ip1, ip2 *ImportPath) bool

func ImportPathsEqual

func ImportPathsEqual(l1, l2 []*ImportPath) bool

Types

type Config

type Config interface {
	GetAbsPathToRoot() string
	ShouldUseRelativePaths() bool
}

type ImportPath

type ImportPath struct {
	ImportPath    string `json:"importPath"`
	Import        string `json:"import"`
	DefaultImport bool   `json:"defaultImport,omitempty"`
	// we name this originalImport so that clients everywhere can just keep calling useImport .Import
	OriginalImport string `json:"originalImport,omitempty"`

	// only used in graphql (at least for now)
	// defaults to no. if function, call it instead of just referencing the import when used?
	Function bool `json:"function,omitempty"`

	Class bool `json:"class,omitempty"`

	TransformedForGraphQLMutation bool `json:"transformedForGraphQLMutation,omitempty"`
	TransformedForExternalEnt     bool `json:"transformedForExternalEnt,omitempty"`

	// automatically imported and we don't need to use it
	// imported as follows: `import "{path}";`
	SideEffect bool `json:"sideEffect"`
}

func NewEntActionImportPath

func NewEntActionImportPath(typ string) *ImportPath

func NewEntGraphQLImportPath

func NewEntGraphQLImportPath(typ string) *ImportPath

func NewEntImportPath

func NewEntImportPath(typ string) *ImportPath

func NewGQLClassImportPath

func NewGQLClassImportPath(typ string) *ImportPath

func NewGQLImportPath

func NewGQLImportPath(typ string) *ImportPath

NewGQLImportPath creates a new import from "graphql"

func NewGraphQLJSONImportPath

func NewGraphQLJSONImportPath(typ string) *ImportPath

func NewLocalEntConnectionImportPath

func NewLocalEntConnectionImportPath(typ string) *ImportPath

func NewLocalEntImportPath

func NewLocalEntImportPath(typ string) *ImportPath

func NewLocalGraphQLEntImportPath

func NewLocalGraphQLEntImportPath(typ string) *ImportPath

func NewLocalGraphQLInputEntImportPath

func NewLocalGraphQLInputEntImportPath(typ string) *ImportPath

type Imports

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

Imports keeps track of imports in a generated typescript file

func NewImports

func NewImports(cfg Config, filePath string) *Imports

NewImports is the constructor for Imports filePath is path that's currently being written

func (*Imports) ConditionallyReserveImportPath

func (imps *Imports) ConditionallyReserveImportPath(imp *ImportPath, external bool) (string, error)

ConditionallyReserveImportPath skips importing when the import path is same as file path

func (*Imports) Export

func (imps *Imports) Export(path string, exports ...string) (string, error)

func (*Imports) ExportAll

func (imps *Imports) ExportAll(path string) (string, error)

func (*Imports) ExportAllAs

func (imps *Imports) ExportAllAs(path, as string) (string, error)

func (*Imports) FuncMap

func (imps *Imports) FuncMap() template.FuncMap

FuncMap returns the FuncMap to be passed to a template

func (*Imports) Reserve

func (imps *Imports) Reserve(path string, imports ...string) (string, error)

Reserve reserves a path and list of imports

func (*Imports) ReserveAll

func (imps *Imports) ReserveAll(path, as string) (string, error)

ReserveAll reserves importing all from a path as the alias

func (*Imports) ReserveDefault

func (imps *Imports) ReserveDefault(path, defaultImport string, imports ...string) (string, error)

ReserveDefault reserves the default export from a path and a list of exports

func (*Imports) ReserveImportPath

func (imps *Imports) ReserveImportPath(imp *ImportPath, external bool) (string, error)

ReserveImportPath takes an instance of importPath and reserves importing from it should be default eventually

func (*Imports) String

func (imps *Imports) String() (string, error)

Returns a list of imported lines

func (*Imports) Use

func (imps *Imports) Use(impItem string) (string, error)

Use makes use of an export and ensures that's imported

func (*Imports) UseMaybe

func (imps *Imports) UseMaybe(export string) (string, error)