catalog

Oct 28, 2020

Changes in this version

+ func ModuleNamespace(m *sysl.Module) string

+ func SimpleName(app *sysl.Application) string

Oct 15, 2020

Changes in this version

type Generator

+ func (p *Generator) DataModelAliasTable(app *sysl.Application, param Param) string

+ func (p *Generator) DataModelReturnTable(appName string, stmt *sysl.Statement, endpoint *sysl.Endpoint) string

+ func (p *Generator) DataModelTable(appName, typeName, aliasName string) string

Oct 6, 2020

Changes in this version

+ const MacroPackageProjectMermaid

+ const NewPackageTemplateMermaid

+ const ProjectTemplateMermaid

type Generator

+ Retriever gop.Retriever

+ func (p *Generator) AutomaticTemplates(fs afero.Fs, fileNames ...string) *Generator

+ func (p *Generator) DataModelAliasMermaid(app *sysl.Application, param Param) string

+ func (p *Generator) DataModelAliasPlantuml(appName, typeName, typeAlias string, t *sysl.Type, recursive bool) string

+ func (p *Generator) DataModelAppMermaid(app *sysl.Application) string

+ func (p *Generator) DataModelAppPlantuml(app *sysl.Application) string

+ func (p *Generator) DataModelMermaid(appName, typeName string) string

+ func (p *Generator) DataModelParamPlantuml(app *sysl.Application, param Param) string

+ func (p *Generator) DataModelPlantuml(appName, typeName string, t *sysl.Type, recursive bool) string

+ func (p *Generator) DataModelReturnMermaid(appName string, stmnt *sysl.Statement, endpoint *sysl.Endpoint) string

+ func (p *Generator) DataModelReturnPlantuml(appName string, stmnt *sysl.Statement, endpoint *sysl.Endpoint) string

+ func (p *Generator) ExtractReturnInfo(appname string, stmnt *sysl.Statement, endpoint *sysl.Endpoint) (appName string, typeName string, typeref *sysl.Type, getRecursive bool)

+ func (p *Generator) ExtractTypeInfo(app *sysl.Application, param Param) (appName, typeName, aliasTypeName string, getRecursive bool)

+ func (p *Generator) IntegrationMermaid(m *sysl.Module, title string, EPA bool) string

+ func (p *Generator) IntegrationPlantuml(m *sysl.Module, title string, EPA bool) string

+ func (p *Generator) SequenceMermaid(appName string, endpoint *sysl.Endpoint) string

+ func (p *Generator) SequencePlantuml(appName string, endpoint *sysl.Endpoint) string

+ func (p *Generator) WithRemoteTemplateString(remoteResources ...string) *Generator

+ func (p *Generator) WithRetriever(retr gop.Retriever) *Generator

Oct 1, 2020

Changes in this version

+ func CopySyslCacheDir(targetDir string) error

type Generator

+ Mapper *syslwrapper.AppMapper

Sep 29, 2020

Changes in this version

+ func GetAppNameString(a Namer) string

+ func JoinAppNameString(an *sysl.AppName) string

Sep 25, 2020

Changes in this version

type Generator

+ MermaidGen *MermaidGenerator

type MermaidGenerator

+ func (m *MermaidGenerator) GenerateMermaidDiagram(data string) []byte

Aug 21, 2020

Changes in this version

+ func GetImportPathAndVersion(app *sysl.Application) (importPath string, version string, err error)

type Generator

+ CopySpecsToOutput bool

Aug 14, 2020

Changes in this version

+ func UnmarshallJson(b []byte, m *sysl.Module) error

type Generator

+ BasePath string

Aug 13, 2020

Changes in this version

type Generator

+ func NewProjectFromJson(titleAndFileName, plantumlService, outputType string, logger *logrus.Logger, ...) *Generator

Aug 12, 2020

Changes in this version

+ func AppendVersion(remoteFilePath string, version string) string

Aug 11, 2020

Changes in this version

+ func CopySyslModCache(targetDir string) error

Aug 5, 2020

Changes in this version

type Generator

+ func (p *Generator) CreateAliasedTypeDiagramMermaid(appName string, typeName string, typeAlias string, recursive bool) string

+ func (p *Generator) CreateSequenceDiagramMermaid(appName string, endpoint *sysl.Endpoint) string

+ func (p *Generator) CreateSequenceDiagramPlantuml(appName string, endpoint *sysl.Endpoint) string

+ type MermaidGenerator struct

+ func MakeMermaidGenerator() MermaidGenerator

+ func (m MermaidGenerator) GenerateAndWriteMermaidDiagram(fs afero.Fs, fileName string, data string) error

Jul 30, 2020

Changes in this version

type Generator

+ GeneratedFilesMutex *sync.RWMutex

Jul 14, 2020

Changes in this version

+ func GetPackageName(m *sysl.Module, a Namer) string

type Generator

+ FilterPackage []string

Jul 14, 2020

Changes in this version

type Generator

+ GeneratedFiles map[string][]byte

Jul 9, 2020

Changes in this version

type Generator

+ CustomTemplate bool

Jul 3, 2020

Changes in this version

type Generator

+ func (p *Generator) CreateAliasedTypeDiagram(appName, typeName, typeAlias string, t *sysl.Type, recursive bool) string

+ type Param interface

+ GetName func() string

Jun 26, 2020

Changes in this version

+ func BuildGithubBlobURL(repoURL string) string

Jun 24, 2020

Changes in this version

type Generator

+ ChatLink string

+ FeedbackLink string

+ func (p *Generator) GetChatLink() string

+ func (p *Generator) GetFeedbackLink() string

Jun 23, 2020

Changes in this version

+ func ServiceMetadata(a Attr) string

Jun 15, 2020

Changes in this version

type Generator

+ ImageDest string

Jun 10, 2020

Changes in this version

+ func PlantUMLJava(service, out string) error

+ func PlantUMLNailGun(contents string) ([]byte, error)

type Generator

+ func (p *Generator) PUMLFile(fs afero.Fs, fileName, contents string) error

Jun 4, 2020

Changes in this version

+ const RedocPage

+ func BuildGithubRawURL(repoURL string) (gitURL string)

+ func BuildRedoc(specURL string) []byte

+ func BuildSpecURL(source *sysl.SourceContext) string

+ func GenerateAndWriteRedoc(fs afero.Fs, fileName string, specURL string) error

+ func GetRemoteFromGit() string

+ func IsOpenAPIFile(source *sysl.SourceContext) bool

+ func StripExtension(input string) string

type Generator

+ Redoc bool

+ RedocFilesToCreate map[string]string

+ func (p *Generator) CreateRedoc(sourceContext *sysl.SourceContext, appName string) string

+ type Redoc struct

+ SpecURL string

Jun 1, 2020

Changes in this version

+ func PlantumlNailGun(contents string) ([]byte, error)

May 29, 2020

Changes in this version

+ func PlantUMLCLI(service, dir, wildcard string) (err error, cleanup func())

type Generator

+ DirsToCreate map[string]struct{}

+ Server bool

+ func (p *Generator) PlantumlJava(fs afero.Fs, fileName, contents string) error

May 25, 2020

Changes in this version

+ func FieldType(t *sysl.Type) string

+ func Fields(t *sysl.Type) map[string]*sysl.Type

May 19, 2020

Changes in this version

type Generator

+ Links map[string]string

+ ProjectTitle string

+ RootModule *sysl.Module

May 19, 2020

Changes in this version

+ func Remove(s, old string) string

May 19, 2020

Changes in this version

+ func Last(i interface{}, ind int) bool

May 19, 2020

Changes in this version

+ const MacroPackageProject

+ const ProjectTemplate

type Generator

+ StartTemplateIndex int

+ TempDir string

+ Templates []*template.Template

+ func (p *Generator) MacroPackages(module *sysl.Module) []string

+ func (p *Generator) Packages(m *sysl.Module) []string

+ func (p *Generator) WithTemplateFs(fs afero.Fs, fileNames ...string) *Generator

May 18, 2020

Changes in this version

type Generator

+ func (p *Generator) SourcePath(a SourceCoder) string

+ type SourceCoder interface

+ GetSourceContext func() *sysl.SourceContext

May 12, 2020

Changes in this version

+ func AsSet(in []string) map[string]struct

+ func CreateFileName(dir string, elems ...string) (string, string)

+ func Filter(vs []string, f func(string) bool) []string

+ func GenerateAndWriteMermaidDiagram(fs afero.Fs, fileName string, data string) error

+ func GetAppTypeName(param Typer) (string, string)

+ func SortedKeys(m interface{}) []string

+ type Attr interface

+ GetAttrs func() map[string]*sysl.Attribute

type Generator

+ CurrentDir string

+ DisableCss bool

+ DisableImages bool

+ Ext string

+ Mermaid bool

+ MermaidFilesToCreate map[string]string

+ SourceFileName string

+ func (p *Generator) CreateFile(contents string, diagramType int, elems ...string) string

+ func (p *Generator) CreateIntegrationDiagramMermaid(m *sysl.Module, title string, EPA bool) string

+ func (p *Generator) CreateIntegrationDiagramPlantuml(m *sysl.Module, title string, EPA bool) string

+ func (p *Generator) GetRows(module *sysl.Module) []string

+ func (p *Generator) ModuleAsMacroPackage(m *sysl.Module) map[string]map[string]*sysl.Module

+ func (p *Generator) ModuleAsPackages(m *sysl.Module) map[string]*sysl.Module

+ func (p *Generator) SetOptions(disableCss, disableImages bool) *Generator

+ func (p *Generator) WithTemplateFiles(p1, p2 afero.File) *Generator

+ func (p *Generator) WithTemplateString(p1, p2 string) *Generator

+ type Namer interface

+ GetName func() *sysl.AppName

+ type Typer interface

+ GetType func() *sysl.Type

May 7, 2020

Changes in this version

+ const NewPackageTemplate

+ const NewProjectTemplate

+ func AlphabeticalModules(m map[string]*sysl.Module) []string

+ func AlphabeticalParams(m map[string]*sysl.Param) []string

+ func AppComment(application *sysl.Application) string

+ func Attribute(attr string, Attrs map[string]*sysl.Attribute) string

+ func HttpToFile(url, fileName string, fs afero.Fs) error

+ func Map(vs []string, f func(string) string) []string

+ func ModuleAsPackages(m *sysl.Module) map[string]*sysl.Module

+ func ModulePackageName(m *sysl.Module) string

+ func PlantUMLURL(plantumlService, contents string) (string, error)

+ func RetryHTTPRequest(url string) ([]byte, error)

+ func SanitiseOutputName(s string) string

+ func TernaryOperator(condition bool, i ...interface{}) interface

+ func TypeComment(Type *sysl.Type) string

+ type Generator struct

+ FilesToCreate map[string]string

+ Format string

+ Fs afero.Fs

+ ImageTags bool

+ LiveReload bool

+ Log *logrus.Logger

+ Module *sysl.Module

+ OutputDir string

+ OutputFileName string

+ PackageTempl *template.Template

+ PlantumlService string

+ ProjectTempl *template.Template

+ Title string

+ func (p *Generator) CreateFileName(contents string, absolute string, elems ...string) string

+ func (p *Generator) CreateIntegrationDiagram(m *sysl.Module, title string, EPA bool) string

+ func (p *Generator) CreateMarkdown(t *template.Template, outputFileName string, i interface{})

+ func (p *Generator) CreateParamDataModel(app *sysl.Application, param *sysl.Param) string

+ func (p *Generator) CreatePathParamDataModel(CurrentAppName string, param *sysl.Endpoint_RestParams_QueryParam) string

+ func (p *Generator) CreateQueryParamDataModel(CurrentAppName string, param *sysl.Endpoint_RestParams_QueryParam) string

+ func (p *Generator) CreateReturnDataModel(stmnt *sysl.Statement, endpoint *sysl.Endpoint) string

+ func (p *Generator) CreateSequenceDiagram(appName string, endpoint *sysl.Endpoint) string

+ func (p *Generator) CreateTypeDiagram(app *sysl.Application, typeName string, t *sysl.Type, recursive bool) string

+ func (p *Generator) GenerateDataModel(app *sysl.Application) string

+ func (p *Generator) GetFuncMap() template.FuncMap

+ func (p *Generator) GetParamType(app *sysl.Application, param *sysl.Param) *sysl.Type

+ func (p *Generator) GetReturnType(endpoint *sysl.Endpoint, stmnt *sysl.Statement) *sysl.Type

+ func (p *Generator) Run()

+ func (p *Generator) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (p *Generator) ServerSettings(server, liveReload, imageTags bool) *Generator

+ func (p *Generator) Update(m *sysl.Module) *Generator

May 5, 2020

Changes in this version

+ func AlphabeticalTypes(m map[string]*sysl.Type) []string

+ func NewTypeRef(appName, typeName string) *sysl.Type

type Diagram

+ func (d Diagram) GetProject() *Project

+ func (d Diagram) Link() string

+ func (s Diagram) PathParamDataModel() []*Diagram

+ func (s Diagram) QueryParamDataModel() []*Diagram

+ type DiagramPair struct

+ Full *Diagram

+ Key string

+ Simple *Diagram

type Package

+ Types map[string]*DiagramPair

+ func (p *Package) GenerateTypes()

type Project

+ Format string

+ Progress *pb.ProgressBar

Apr 30, 2020

Changes in this version

+ const PackageHTMLTemplateWithoutCSS

+ const ProjectHTMLTemplatePackageTemplateWithoutCSS

type Diagram

+ PlantUMLDiagramString string

+ Project *Project

+ Type *sysl.Type

+ func (d Diagram) Img() string

+ func (d Diagram) TypeComment() string

type Project

+ DiagramExt string

+ LiveReload bool

+ func (p *Project) EnableLiveReload() *Project

+ func (p *Project) SetServerMode() *Project

+ func (p *Project) Update(m *sysl.Module) *Project

Apr 28, 2020

Changes in this version

+ const PackageHTMLTemplate

+ const PackageMarkdownTemplate

+ const ProjectHTMLTemplate

+ const ProjectMarkdownTemplate

+ func AlphabeticalApps(m map[string]*sysl.Application) []string

+ func AlphabeticalEndpoints(m map[string]*sysl.Endpoint) []string

+ func AlphabeticalPackage(m map[string]*Package) []string

+ func CreateSequenceDiagram(m *sysl.Module, call string) (string, error)

+ func GenerateDiagramAndMarkdown(sd *Diagram) error

+ func GenerateMarkdown(outputdir, fileName string, object interface{}, t *template.Template, ...) error

+ func GetAppPackageName(app *sysl.Application) (string, string)

+ func LoadMarkdownTemplates(markdowns ...string) ([]*template.Template, error)

+ type Diagram struct

+ App *sysl.Application

+ DiagramString string

+ Diagramtype string

+ Endpoint *sysl.Endpoint

+ OutputDir string

+ OutputFileName__ string

+ Parent *Package

+ func (d Diagram) AppComment() string

+ func (d Diagram) AppName() string

+ func (d Diagram) EndpointComment() string

+ func (d Diagram) EndpointName() string

+ func (d Diagram) EndpointNameWithoutSpaces() string

+ func (s Diagram) InputDataModel() []*Diagram

+ func (s Diagram) OutputDataModel() []*Diagram

+ func (sd *Diagram) GenerateDiagramAndMarkdown() error

+ type Package struct

+ DatabaseModel map[string]*Diagram

+ EPAIntegration *Diagram

+ Integration *Diagram

+ OutputDir string

+ OutputFile string

+ PackageName string

+ Parent *Project

+ SequenceDiagrams map[string][]*Diagram

+ func (p Package) SequenceDiagramFromEndpoint(appName string, endpoint *sysl.Endpoint) (*Diagram, error)

+ type Project struct

+ Fs afero.Fs

+ Log *logrus.Logger

+ Module *sysl.Module

+ Output string

+ OutputFileName string

+ PackageModules map[string]*sysl.Module

+ PackageTempl *template.Template

+ Packages map[string]*Package

+ PageFileName string

+ PlantumlService string

+ ProjectTempl *template.Template

+ RootLevelIntegrationDiagram *Diagram

+ RootLevelIntegrationDiagramEPA *Diagram

+ Server bool

+ Title string

+ func NewProject(title, outputDir, plantumlservice string, outputType string, ...) *Project

+ func (p *Project) CreateIntegrationDiagrams(title, output string, projectApp *sysl.Application, EPA bool) (*Diagram, error)

+ func (p *Project) ExecuteTemplateAndDiagrams()

+ func (p *Project) RegisterTemplates(projectTemplateString, packageTemplateString string) error

+ func (p *Project) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (p *Project) SetOutputFs(fs afero.Fs) *Project

+ func (p Project) AlphabeticalRows() []*Package

+ func (p Project) GenerateDBDataModel(parentAppName string) string

+ func (p Project) GenerateEndpointDataModel(parentAppName string, t *sysl.Type) string

+ func (p Project) RegisterDiagrams() error