cmd

Documentation

Overview

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Package cmd ...

Index

• Constants
• Variables
• func DeployCmdRun(cmd *cobra.Command, args []string)
• func Execute()
• func GetSveltinCommands() []*cobra.Command
• func NewCmdRun(cmd *cobra.Command, args []string)
• func NewPageCmdRun(cmd *cobra.Command, args []string)
• func NewThemeCmdRun(cmd *cobra.Command, args []string)
• func RunBuildCmd(cmd *cobra.Command, args []string)
• func RunGenerateMenuCmd(cmd *cobra.Command, args []string)
• func RunGenerateRSSCmd(cmd *cobra.Command, args []string)
• func RunGenerateSitemapCmd(cmd *cobra.Command, args []string)
• func RunInstallCmd(cmd *cobra.Command, args []string)
• func RunNewContentCmd(cmd *cobra.Command, args []string)
• func RunNewMetadataCmd(cmd *cobra.Command, args []string)
• func RunNewResourceCmd(cmd *cobra.Command, args []string)
• func RunPrepareCmd(cmd *cobra.Command, args []string)
• func RunPreviewCmd(cmd *cobra.Command, args []string)
• func RunServerCmd(cmd *cobra.Command, args []string)
• func RunUpdateCmd(cmd *cobra.Command, args []string)
• type EntryType

Constants

const (
	StyleDefault string = "default"
	StyleNone    string = "none"
)

names for the available style options

const (
	Bootstrap   string = "bootstrap"
	Bulma       string = "bulma"
	Scss        string = "scss"
	TailwindCSS string = "tailwindcss"
	VanillaCSS  string = "vanillacss"
)

names for the available CSS Lib options

const (
	Defaults  string = "defaults"
	Externals string = "externals"
	Website   string = "website"
	Menu      string = "menu"
	DotEnv    string = "dotenv"
)

names for config files

const (
	// Blank represents the fontmatter-only template id used when generating the content file.
	Blank string = "blank"
	// Sample represents the sample-content template id used when generating the content file.
	Sample string = "sample"
)

const (
	// Svelte set svelte as the language used to scaffold a new page
	Svelte string = "svelte"
	// Markdown set markdown as the language used to scaffold a new page
	Markdown string = "markdown"
)

const (
	// CliVersion is the current sveltin cli version number.
	CliVersion string = "0.8.6"
	// SvelteKitStarter is a string representing the project starter id.
	SvelteKitStarter string = "starter"
	// ThemeStarter is a string representing the project starter id for new themes.
	ThemeStarter string = "blog-theme-starter"
)

const (
	RootFolder        string = "root"
	BackupsFolder     string = "backups"
	ConfigFolder      string = "config"
	ContentFolder     string = "content"
	RoutesFolder      string = "routes"
	ApiFolder         string = "api"
	LibFolder         string = "lib"
	StaticFolder      string = "static"
	ThemesFolder      string = "themes"
	IndexFile         string = "index"
	IndexEndpointFile string = "indexendpoint"
	SlugFile          string = "slug"
	SlugEndpointFile  string = "slugendpoint"
	SettingsFile      string = ".sveltin-settings.yaml"
	DotEnvProdFile    string = ".env.production"
)

folder and file names for a Sveltin project structure.

Variables

var (
	// YamlConfig is used by yaml.Unmarshal to decode the YAML file.
	YamlConfig []byte
)

Functions

func DeployCmdRun

func DeployCmdRun(cmd *cobra.Command, args []string)

DeployCmdRun is the actual work function.

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. It is called by main.main().

func GetSveltinCommands

func GetSveltinCommands() []*cobra.Command

GetSveltinCommands returns an array of pointers to the implemented cobra.Command

func NewCmdRun

func NewCmdRun(cmd *cobra.Command, args []string)

NewCmdRun is the actual work function.

func NewPageCmdRun

func NewPageCmdRun(cmd *cobra.Command, args []string)

NewPageCmdRun is the actual work function.

func NewThemeCmdRun

func NewThemeCmdRun(cmd *cobra.Command, args []string)

NewThemeCmdRun is the actual work function.

func RunBuildCmd

func RunBuildCmd(cmd *cobra.Command, args []string)

RunBuildCmd is the actual work function.

func RunGenerateMenuCmd

func RunGenerateMenuCmd(cmd *cobra.Command, args []string)

RunGenerateMenuCmd is the actual work function.

func RunGenerateRSSCmd

func RunGenerateRSSCmd(cmd *cobra.Command, args []string)

RunGenerateRSSCmd is the actual work function.

func RunGenerateSitemapCmd

func RunGenerateSitemapCmd(cmd *cobra.Command, args []string)

RunGenerateSitemapCmd is the actual work function.

func RunInstallCmd

func RunInstallCmd(cmd *cobra.Command, args []string)

RunInstallCmd is the actual work function.

func RunNewContentCmd

func RunNewContentCmd(cmd *cobra.Command, args []string)

RunNewContentCmd is the actual work function.

func RunNewMetadataCmd

func RunNewMetadataCmd(cmd *cobra.Command, args []string)

RunNewMetadataCmd is the actual work function.

func RunNewResourceCmd

func RunNewResourceCmd(cmd *cobra.Command, args []string)

RunNewResourceCmd is the actual work function.

func RunPrepareCmd

func RunPrepareCmd(cmd *cobra.Command, args []string)

RunPrepareCmd is the actual work function.

func RunPreviewCmd

func RunPreviewCmd(cmd *cobra.Command, args []string)

RunPreviewCmd is the actual work function.

func RunServerCmd

func RunServerCmd(cmd *cobra.Command, args []string)

RunServerCmd is the actual work function.

func RunUpdateCmd

func RunUpdateCmd(cmd *cobra.Command, args []string)

RunUpdateCmd is the actual work function.

Types

type EntryType

type EntryType int

EntryType describes the different types of an Entry

const (
	EntryTypeFolder EntryType = 0
	EntryTypeFile   EntryType = 1
)

The differents types of an Entry