cli

Documentation

Overview

Package cli organizes and implements a command line program.

Index

• func Run(args []string) int
• type App
  • func (app *App) CloseTrap()
  • func (app *App) NewLogger(w io.Writer) *slog.Logger
  • func (app *App) NewServer(logger *slog.Logger) *http.Server
  • func (app *App) NoOp() bool
  • func (app *App) ParseFlags(args []string)
  • func (app *App) StartAndShutdown(server *http.Server, logger *slog.Logger)
  • func (app *App) TrapSignals(signals ...os.Signal)
• type WrappedDir
  • func (wd WrappedDir) Open(name string) (http.File, error)

Functions

func Run

func Run(args []string) int

Run creates an App, performs the App's tasks, and returns an exit value.

Types

type App

type App struct {
	Trap          chan os.Signal
	Port          string
	Dir           string
	ExitValue     int
	HelpWanted    bool
	VersionWanted bool
}

App stores information about the application's state.

func (*App) CloseTrap

func (app *App) CloseTrap()

CloseTrap closes the os.Signal channel.

func (*App) NewLogger

func (app *App) NewLogger(w io.Writer) *slog.Logger

NewLogger returns a configured slog logger or nil.

func (*App) NewServer

func (app *App) NewServer(logger *slog.Logger) *http.Server

NewServer returns an http.Server configured for use by miniserve.

func (*App) NoOp

func (app *App) NoOp() bool

NoOp determines whether an App should bail out.

func (*App) ParseFlags

func (app *App) ParseFlags(args []string)

ParseFlags handles flags and options in my finicky way.

func (*App) StartAndShutdown

func (app *App) StartAndShutdown(server *http.Server, logger *slog.Logger)

StartAndShutdown starts and (gracefully) shuts down an http.Server.

func (*App) TrapSignals

func (app *App) TrapSignals(signals ...os.Signal)

TrapSignals sets app.Trap to watch for a variable number of signals.

type WrappedDir

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

WrappedDir wraps http.Dir so that we can modify http.Dir's Open method.

func (WrappedDir) Open

func (wd WrappedDir) Open(name string) (http.File, error)

Open modifies http.Dir's Open method in order to handle URLs without ".html".