pathmaker

Documentation

Overview

Package pathmaker defines utility functions used to navigate through the project structure.

Index

• type SveltinPathMaker
  • func NewSveltinPathMaker(settings *config.SveltinSettings) *SveltinPathMaker
  • func (maker *SveltinPathMaker) GetAPIFolder() string
  • func (maker *SveltinPathMaker) GetConfigFolder() string
  • func (maker *SveltinPathMaker) GetContentFolder() string
  • func (maker *SveltinPathMaker) GetLibFolder() string
  • func (maker *SveltinPathMaker) GetParamsFolder() string
  • func (maker *SveltinPathMaker) GetPathToExistingResources() string
  • func (maker *SveltinPathMaker) GetPathToPublicPages() string
  • func (maker *SveltinPathMaker) GetPathToRoutes() string
  • func (maker *SveltinPathMaker) GetProjectConfigFolder(project string) string
  • func (maker *SveltinPathMaker) GetProjectContentFolder(project string) string
  • func (maker *SveltinPathMaker) GetProjectRoot(project string) string
  • func (maker *SveltinPathMaker) GetProjectThemesFolder(project string) string
  • func (maker *SveltinPathMaker) GetResourceContentFilename() string
  • func (maker *SveltinPathMaker) GetResourceLibFilename(artifact string) string
  • func (maker *SveltinPathMaker) GetRootFolder() string
  • func (maker *SveltinPathMaker) GetRoutesFolder() string
  • func (maker *SveltinPathMaker) GetSrcFolder() string
  • func (maker *SveltinPathMaker) GetStaticFolder() string
  • func (maker *SveltinPathMaker) GetThemeComponentsFolder() string
  • func (maker *SveltinPathMaker) GetThemePartialsFolder() string
  • func (maker *SveltinPathMaker) GetThemesFolder() string

Types

type SveltinPathMaker

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

SveltinPathMaker is the main struct to deal with path within a Sveltin/SvelteKit project structure.

func NewSveltinPathMaker

func NewSveltinPathMaker(settings *config.SveltinSettings) *SveltinPathMaker

NewSveltinPathMaker returns a SveltinPathMaker struct.

func (*SveltinPathMaker) GetAPIFolder

func (maker *SveltinPathMaker) GetAPIFolder() string

GetAPIFolder returns a string representing the path to the 'src/routes/api' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetConfigFolder

func (maker *SveltinPathMaker) GetConfigFolder() string

GetConfigFolder returns a string representing the path to the 'config' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetContentFolder

func (maker *SveltinPathMaker) GetContentFolder() string

GetContentFolder returns a string representing the path to the 'content' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetLibFolder

func (maker *SveltinPathMaker) GetLibFolder() string

GetLibFolder returns a string representing the path to the 'src/lib' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetParamsFolder

func (maker *SveltinPathMaker) GetParamsFolder() string

GetParamsFolder returns a string representing the path to the 'src/params' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetPathToExistingResources

func (maker *SveltinPathMaker) GetPathToExistingResources() string

GetPathToExistingResources returns a string representing the path to the 'content' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetPathToPublicPages

func (maker *SveltinPathMaker) GetPathToPublicPages() string

GetPathToPublicPages returns a string representing the path to the 'src/routes' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetPathToRoutes

func (maker *SveltinPathMaker) GetPathToRoutes() string

GetPathToRoutes returns a string representing the path to the 'src/routes' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetProjectConfigFolder

func (maker *SveltinPathMaker) GetProjectConfigFolder(project string) string

GetProjectConfigFolder returns a string representing the path to the 'config' folder for a sveltin project relative to the current working directory.

func (*SveltinPathMaker) GetProjectContentFolder

func (maker *SveltinPathMaker) GetProjectContentFolder(project string) string

GetProjectContentFolder returns a string representing the path to the 'content' folder for a sveltin project relative to the current working directory.

func (*SveltinPathMaker) GetProjectRoot

func (maker *SveltinPathMaker) GetProjectRoot(project string) string

GetProjectRoot returns a string representing the path to the sveltin project folder relative to the current working directory.

func (*SveltinPathMaker) GetProjectThemesFolder

func (maker *SveltinPathMaker) GetProjectThemesFolder(project string) string

GetProjectThemesFolder returns a string representing the path to the 'themes' folder for a sveltin project relative to the current working directory.

func (*SveltinPathMaker) GetResourceContentFilename

func (maker *SveltinPathMaker) GetResourceContentFilename() string

GetResourceContentFilename returns a string representing the filename for a resource content page.

func (*SveltinPathMaker) GetResourceLibFilename

func (maker *SveltinPathMaker) GetResourceLibFilename(artifact string) string

GetResourceLibFilename returns a string representing the path to the resource lib file for a sveltin project relative to the current working directory.

func (*SveltinPathMaker) GetRootFolder

func (maker *SveltinPathMaker) GetRootFolder() string

GetRootFolder returns a string representing the path to the project root folder.

func (*SveltinPathMaker) GetRoutesFolder

func (maker *SveltinPathMaker) GetRoutesFolder() string

GetRoutesFolder returns a string representing the path to the 'src/routes' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetSrcFolder

func (maker *SveltinPathMaker) GetSrcFolder() string

GetSrcFolder returns a string representing the path to the 'src' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetStaticFolder

func (maker *SveltinPathMaker) GetStaticFolder() string

GetStaticFolder returns a string representing the path to the 'static' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetThemeComponentsFolder

func (maker *SveltinPathMaker) GetThemeComponentsFolder() string

GetThemeComponentsFolder returns a string representing the path to the 'themes/<theme>/components' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetThemePartialsFolder

func (maker *SveltinPathMaker) GetThemePartialsFolder() string

GetThemePartialsFolder returns a string representing the path to the 'themes/<theme>/partials' folder for a sveltin project relative to the project root folder.

func (*SveltinPathMaker) GetThemesFolder

func (maker *SveltinPathMaker) GetThemesFolder() string

GetThemesFolder returns a string representing the path to the 'themes' folder for a sveltin project relative to the project root folder.