module

Documentation

Index

• Constants
• Variables
• type Component
• type LoadInfo
• type Module
• type Modules
• type Mount
• type Paths
• type Workspace

Constants

const (
	ComponentFolderArchetypes = "archetypes"
	ComponentFolderStatic     = "static"
	ComponentFolderLayouts    = "layouts"
	ComponentFolderContent    = "content"
	ComponentFolderData       = "data"
	ComponentFolderAssets     = "assets"
	ComponentFolderI18n       = "i18n"

	FolderResources = "resources"
)

Module folder structure

Variables

var (
	ComponentFolders = []string{
		ComponentFolderArchetypes,
		ComponentFolderStatic,
		ComponentFolderLayouts,
		ComponentFolderContent,
		ComponentFolderData,
		ComponentFolderAssets,
		ComponentFolderI18n,
	}
)

Types

type Component

type Component interface {
	Name() string
	Dir() string
	Language() string
}

type LoadInfo

type LoadInfo interface {
	Workspace
	Paths
}

type Module

type Module interface {
	Owner() Module
	Mounts() []Mount
	Dir() string
}

type Modules

type Modules interface {
	Proj() Module
	All() []Module
	IsProjMod(mod Module) bool

	GetSourceLang(source string) (string, bool)
}

type Mount

type Mount interface {
	Source() string
	Target() string
	Lang() string
	Marshal() string
}

type Paths

type Paths interface {
	ImportPaths() []string
	GetImports(moduleDir string) ([]string, error)
}

type Workspace

type Workspace interface {
	Fs() afero.Fs
	WorkingDir() string
	ThemesDir() string

	DefaultLanguage() string
	OtherLanguageKeys() []string
	GetRelDir(name string, langKey string) (dir string, err error)
}