file

Documentation

Index

• Constants
• Variables
• func ContainsHeader(s string) bool
• func Inject(fl *File, content map[string]string) error
• func ReplaceSections(fl *File, tgt filesystem.FileLoader) error
• type File
  • func NewFile(path string, mode os.FileMode, b []byte, addHeader bool, logger util.Logger) *File
  • func (f *File) Ext() string
  • func (f *File) FullPath() string
• type Files
  • func (f Files) Exists(path string) bool
  • func (f Files) Get(path string) *File
  • func (f Files) String() string
• type Type
  • func TypeFromString(s string) Type
  • func (t *Type) MarshalJSON() ([]byte, error)
  • func (t *Type) String() string
  • func (t *Type) UnmarshalJSON(data []byte) error

Constants

const (
	InjectPrefix = prefix + "INJECT"
	ModulePrefix = prefix + "HAS_MODULE"

	IgnorePattern       = prefix + "IGNORE" + suffix
	GenerateOncePattern = prefix + "GENERATE_ONCE" + suffix
)

const HeaderContent = "Content managed by Project Forge, see [projectforge.md] for details."

Variables

var (
	TypeBatch        = Type{Key: "batch", Suffixes: []string{".bat"}, Title: "Windows batch file"}
	TypeCodeowners   = Type{Key: "codeowners", Suffixes: []string{"CODEOWNERS"}, Title: "Code owners source control file"}
	TypeConf         = Type{Key: "conf", Suffixes: []string{".conf"}, Title: "Configuration file"}
	TypeCSS          = Type{Key: "css", Suffixes: []string{".css"}, Title: "Cascading Stylesheet"}
	TypeDocker       = Type{Key: "docker", Suffixes: []string{"Dockerfile"}, Title: "Docker build configuration"}
	TypeEditorConfig = Type{Key: "editorconfig", Suffixes: []string{".editorconfig"}, Title: "IDE configuration and styling"}
	TypeEntitlements = Type{Key: "entitlements", Suffixes: []string{".entitlements"}, Title: "Apple entitlements file"}
	TypeESLint       = Type{Key: "eslint", Suffixes: []string{".eslintrc"}, Title: "ESLint configuration file"}
	TypeGitIgnore    = Type{Key: "gitignore", Suffixes: []string{".gitignore"}, Title: "Git ignore file"}
	TypeGo           = Type{Key: "go", Suffixes: []string{".go"}, Title: "Go source"}
	TypeGoMod        = Type{Key: "gomod", Suffixes: []string{".mod"}, Title: "Go module configuration"}
	TypeGradle       = Type{Key: "gradle", Suffixes: []string{".gradle"}, Title: "Gradle build or source file"}
	TypeHCL          = Type{Key: "hcl", Suffixes: []string{".hcl"}, Title: "HashiCorp Configuration Language"}
	TypeHTML         = Type{Key: "html", Suffixes: []string{".html", ".htm"}, Title: "HTML web page"}
	TypeIgnore       = Type{Key: "dockerignore", Suffixes: []string{".dockerignore"}, Title: "Docker ignore file"}
	TypeIcons        = Type{Key: "icons", Suffixes: []string{".icns"}, Title: "Apple icon collection"}
	TypeJavaScript   = Type{Key: "javascript", Suffixes: []string{".js", ".javascript"}, Title: "JavaScript source"}
	TypeJSON         = Type{Key: "json", Suffixes: []string{".json"}, Title: "JavaScript Object Notation"}
	TypeKotlin       = Type{Key: "kotlin", Suffixes: []string{".kt"}, Title: "Kotlin source file"}
	TypeMakefile     = Type{Key: "makefile", Suffixes: []string{"Makefile", "makefile"}, Title: "Build file"}
	TypeMarkdown     = Type{Key: "markdown", Suffixes: []string{".md", ".markdown"}, Title: "Markdown document"}
	TypePList        = Type{Key: "plist", Suffixes: []string{".plist"}, Title: "Apple configuration plist"}
	TypeProperties   = Type{Key: "properties", Suffixes: []string{".properties"}, Title: "Java properties file"}
	TypeProtobuf     = Type{Key: "protobuf", Suffixes: []string{".proto"}, Title: "Protobuf definition"}
	TypeShell        = Type{Key: "shell", Suffixes: []string{".sh"}, Title: "Shell script"}
	TypeSQL          = Type{Key: "sql", Suffixes: []string{".sql"}, Title: "SQL query file"}
	TypeSVG          = Type{Key: "svg", Suffixes: []string{".svg"}, Title: "Simple Vector Graphics file"}
	TypeSwift        = Type{Key: "swift", Suffixes: []string{".swift"}, Title: "Swift source file"}
	TypeTypeScript   = Type{Key: "typescript", Suffixes: []string{".ts"}, Title: "TypeScript source"}
	TypeXML          = Type{Key: "xml", Suffixes: []string{".xml"}, Title: "XML document"}
	TypeYAML         = Type{Key: "yaml", Suffixes: []string{".yml", ".yaml"}, Title: "YAML configuration source"}
)

var AllTypes = []Type{
	TypeBatch, TypeCodeowners, TypeConf, TypeCSS, TypeDocker, TypeEditorConfig, TypeEntitlements,
	TypeESLint, TypeGitIgnore, TypeGo, TypeGoMod, TypeGradle, TypeHCL, TypeHTML, TypeIcons, TypeIgnore,
	TypeJavaScript, TypeJSON, TypeKotlin, TypeMakefile, TypeMarkdown, TypePList, TypeProperties,
	TypeProtobuf, TypeShell, TypeSQL, TypeSVG, TypeSwift, TypeTypeScript, TypeXML, TypeYAML,
}

Functions

func ContainsHeader

func ContainsHeader(s string) bool

func Inject

func Inject(fl *File, content map[string]string) error

func ReplaceSections

func ReplaceSections(fl *File, tgt filesystem.FileLoader) error

Types

type File

type File struct {
	Type    Type        `json:"type"`
	Path    []string    `json:"path,omitempty"`
	Name    string      `json:"name"`
	Mode    os.FileMode `json:"mode,omitempty"`
	Content string      `json:"-"`
}

func NewFile

func NewFile(path string, mode os.FileMode, b []byte, addHeader bool, logger util.Logger) *File

func (*File) Ext

func (f *File) Ext() string

func (*File) FullPath

func (f *File) FullPath() string

type Files

type Files []*File

func (Files) Exists

func (f Files) Exists(path string) bool

func (Files) Get

func (f Files) Get(path string) *File

func (Files) String

func (f Files) String() string

type Type

type Type struct {
	Key      string
	Suffixes []string
	Title    string
}

func TypeFromString

func TypeFromString(s string) Type

func (*Type) MarshalJSON

func (t *Type) MarshalJSON() ([]byte, error)

func (*Type) String

func (t *Type) String() string

func (*Type) UnmarshalJSON

func (t *Type) UnmarshalJSON(data []byte) error