cmd

Documentation

Overview

Package cmd provides commands to manage plenti sites.

Index

• Variables
• func Build() error
• func Execute()
• func FileServerWith404(root http.FileSystem, localUrl string) http.Handler

Variables

var BenchmarkFlag bool

BenchmarkFlag provides users with build speed statistics to help identify bottlenecks.

var BuildFlag bool

BuildFlag can be set to false to skip building the site when starting local server

var Building bool

Building keeps track of whether the build is in process or not

var BundleFlag bool

BundleFlag uses esbuild to bundle the single page application (SPA) into a single file, improving the first page load time.

var CommitFlag string

CommitFlag targets a specific commit hash when running the "git clone" operation.

var ConfigFileFlag string

ConfigFileFlag allows you to point to a nonstandard sitewide configuration file for the build (instead of plenti.json).

var EjectAll bool

EjectAll is a flag that allows users to eject all the core files to their local project.

var EndpointFlag bool

EndpointFlag disables the route for a content source by omitting the corresponding svelte template.

var LocalFlag bool

LocalFlag can be set to false to emulate a remote environment

var MinifyFlag bool

MinifyFlag condenses the JavaScript output so it runs faster in the browser.

var OutputDirFlag string

OutputDirFlag allows users to override name of default build directory (public)

var PortFlag int

PortFlag allows users to override default port (3000) for local server

var SSLFlag bool

SSLFlag can be set to true to serve localhost over HTTPS with SSL/TLS encryption

var SingleTypeFlag bool

SingleTypeFlag create a one time file at the top level of content.

var VerboseFlag bool

VerboseFlag provides users with additional logging information.

var Version = "undefined"

Version gets replaced by git tag referenced in -ldflags on build.

Functions

func Build

func Build() error

Build creates the compiled app that gets deployed.

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func FileServerWith404

func FileServerWith404(root http.FileSystem, localUrl string) http.Handler