lang

Documentation

Index

• func LanguageSupported(language string) error
• func RegisterLanguage(language string, project ProjectBuilder) error
• type GolangProject
  • func (p *GolangProject) Build() error
  • func (p *GolangProject) CheckNamingConventions(name string) error
• type Project
• type ProjectBuilder
  • func GetProject(language string) ProjectBuilder
• type ProjectItem
• type PythonProject
  • func (p *PythonProject) Build() (err error)
  • func (p *PythonProject) CheckNamingConventions(name string) error
• type Registry

Functions

func LanguageSupported

func LanguageSupported(language string) error

LanguageSupported returns and error if argument language is not contained in the language registry

func RegisterLanguage

func RegisterLanguage(language string, project ProjectBuilder) error

RegisterLanguage allows modules in package lang to register themselves

Types

type GolangProject

type GolangProject Project

func (*GolangProject) Build

func (p *GolangProject) Build() error

func (*GolangProject) CheckNamingConventions

func (p *GolangProject) CheckNamingConventions(name string) error

type Project

type Project struct {
	Name         string
	Language     string
	ProjectItems []ProjectItem
}

Project represents a project in a certain language

type ProjectBuilder

type ProjectBuilder interface {
	CheckNamingConventions(name string) error
	Build() error
}

ProjectBuilder is an interface that builder objects implement within the lang package

func GetProject

func GetProject(language string) ProjectBuilder

type ProjectItem

type ProjectItem struct {
	Name       string
	Parent     string //TODO: does go have a "directory"/file object
	Permission os.FileMode
	Content    string
}

projectItem represents an item in a project

type PythonProject

type PythonProject Project

func (*PythonProject) Build

func (p *PythonProject) Build() (err error)

func (*PythonProject) CheckNamingConventions

func (p *PythonProject) CheckNamingConventions(name string) error

type Registry

type Registry map[string]ProjectBuilder

Projects type stores builders for every language