From 85bde1cc6969e7db0aaab0851f6051350b30409f Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Fri, 2 Jan 2026 13:56:47 -0500 Subject: Rewrite man pages in mdoc(7) format instead of older man(7) format --- CHANGELOG.md | 31 +++++++++++++ build.go | 12 +++-- init.go | 4 +- man/ssg-build.1 | 99 +++++++++++++++++++-------------------- man/ssg-help.1 | 65 ++++++++++++++------------ man/ssg-init.1 | 100 +++++++++++++++++++++------------------ man/ssg-serve.1 | 91 +++++++++++++++++++----------------- man/ssg-templates.5 | 131 +++++++++++++++++++++++++++------------------------- man/ssg-version.1 | 34 +++++++++----- man/ssg.1 | 104 ++++++++++++++++++++++------------------- serve.go | 17 ++++--- site.go | 10 ++-- version.go | 10 ++-- 13 files changed, 398 insertions(+), 310 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 353b71e..0c69d6e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- `ssg-build(1)`: Supports for short and long options + - `-q` or `--quiet` instead of only `-q`. + - `-d` or `--data` instead of only `--data`. + - `-t` or `--templates` instead of only `--templates`. + - `-s` or `--static` instead of only `--static`. + - `-o` or `--out` instead of only `--out`. + +- `ssg-serve(1)`: Support for short option for `dir` e.g. `-d` or `--dir`. + +### Changed + +- Usage output for all commands (e.g. `-h` or `--help`) has been improved to + show all available options. + +- `ssg-serve(1)`: `addr` option has been renamed to `port`. It now is accepted + as `-p` or `--port`. Furthermore, it no longer requires a colon to prefix the + port e.g. `--port 8080` now instead of `--port :8080`. + +- `ssg-serve(1)`: "Serving ..." log now goes to stderr instead of stdout. + +- Man pages have been reworked and rewritten in `mdoc` instead of the older + `man(7)` format. + +### Fixed + +- `ssg-build(1)`: Diagnostic output will now reference the custom data, + templates, static, or output directory, if provided, instead of assuming it is + the default directories. + ## [0.1.1] - 2025-12-27 ### Fixed diff --git a/build.go b/build.go index 0026250..b23dec9 100644 --- a/build.go +++ b/build.go @@ -19,14 +19,21 @@ type buildCmd struct { func (c *buildCmd) Name() string { return "build" } func (c *buildCmd) Synopsis() string { return "build the site" } func (c *buildCmd) Usage() string { - return "build [options]\n\nSee ssg-build(1) for details.\n" + return `ssg build [-h | --help] [-d | --data dir] [-t | --templates dir] [-s | --static dir] [-o | --out dir] [-q | --quiet] + +See ssg-build(1) for details.` } func (c *buildCmd) SetFlags(f *flag.FlagSet) { + f.StringVar(&c.dataDir, "d", "data", "") f.StringVar(&c.dataDir, "data", "data", "") + f.StringVar(&c.templatesDir, "t", "templates", "") f.StringVar(&c.templatesDir, "templates", "templates", "") + f.StringVar(&c.staticDir, "s", "static", "") f.StringVar(&c.staticDir, "static", "static", "") + f.StringVar(&c.outDir, "o", "dist", "") f.StringVar(&c.outDir, "out", "dist", "") f.BoolVar(&c.quiet, "q", false, "") + f.BoolVar(&c.quiet, "quiet", false, "") } func (c *buildCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcmd.ExitStatus { site := &Site{ @@ -35,16 +42,13 @@ func (c *buildCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...any) su StaticDir: c.staticDir, OutDir: c.outDir, } - if !c.quiet { site.Log = func(format string, a ...any) { fmt.Printf(format+"\n", a...) } } - if err := site.Build(); err != nil { fatal("%v", err) } - return subcmd.ExitSuccess } diff --git a/init.go b/init.go index 46b2fc9..9d682f6 100644 --- a/init.go +++ b/init.go @@ -15,7 +15,9 @@ type initCmd struct{} func (c *initCmd) Name() string { return "init" } func (c *initCmd) Synopsis() string { return "initialize a new site" } func (c *initCmd) Usage() string { - return "init [directory]\n\nSee ssg-init(1) for details.\n" + return `ssg init [-h | --help] [directory]: Initialize a new site with the standard directory structure. + +See ssg-init(1) for details.` } func (c *initCmd) SetFlags(f *flag.FlagSet) {} func (c *initCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcmd.ExitStatus { diff --git a/man/ssg-build.1 b/man/ssg-build.1 index 231d1ae..83e09ee 100644 --- a/man/ssg-build.1 +++ b/man/ssg-build.1 @@ -1,59 +1,56 @@ -.TH SSG-BUILD 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-build \- build the site -.SH SYNOPSIS -.B ssg build -.RI [ options ] -.SH DESCRIPTION -Build the static site by rendering templates with data and copying static files. -.PP -Templates are processed using Go's html/template package. See -.BR ssg-templates (5) +.Dd January 2, 2026 +.Dt SSG-BUILD 1 +.Os +.Sh NAME +.Nm ssg-build +.Nd build the site +.Sh SYNOPSIS +.Nm ssg build +.Op Fl h | -help +.Op Fl d | -data Ar dir +.Op Fl t | -templates Ar dir +.Op Fl s | -static Ar dir +.Op Fl o | -out Ar dir +.Op Fl q | -quiet +.Sh DESCRIPTION +.Nm +builds the static site by rendering HTML templates with the provided data into +the output directory and copying static files to the output directory. +.Pp +Templates are processed using Go's +.Lk https://pkg.go.dev/html/template html/template +package. See +.Xr ssg-templates 5 for template syntax and available functions. -.SH OPTIONS -.TP -.BI \-data " dir" +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.It Fl d Ar dir , Fl -data Ar dir Data directory containing JSON files. Default: data -.TP -.BI \-templates " dir" +.It Fl t Ar dir , Fl -templates Ar dir Templates directory containing HTML files. Default: templates -.TP -.BI \-static " dir" +.It Fl s Ar dir , Fl -static Ar dir Static files directory. Default: static -.TP -.BI \-out " dir" +.It Fl o Ar dir , Fl -out Ar dir Output directory. Default: dist -.TP -.B \-q +.It Fl q , Fl -quiet Quiet mode. Only show errors. -.SH EXAMPLES +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh EXAMPLES Build a site: -.PP -.RS -.nf -$ ssg build -.fi -.RE -.PP -Build to a custom output directory: -.PP -.RS -.nf -$ ssg build -out=public -.fi -.RE -.PP +.Dl $ ssg build +.Pp Build with custom directories: -.PP -.RS -.nf -$ ssg build -data=content -templates=layouts -out=public -.fi -.RE -.SH SEE ALSO -.BR ssg-templates (5), -.BR ssg-serve (1) -.SH SSG -Part of the -.BR ssg (1) -suite. +.Dl $ ssg build --static assets --data content --templates layouts --out public +.Pp +Build with regular output silenced: +.Dl $ ssg build --quiet +.Pp +.Sh SEE ALSO +.Xr ssg 1 , +.Xr ssg-serve 1 , +.Xr ssg-templates 5 diff --git a/man/ssg-help.1 b/man/ssg-help.1 index 0862cc2..5c241a1 100644 --- a/man/ssg-help.1 +++ b/man/ssg-help.1 @@ -1,32 +1,37 @@ -.TH SSG-HELP 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-help \- show manual page -.SH SYNOPSIS -.B ssg help -.RI [ command ] -.SH DESCRIPTION -Open the manual page for a command. -.PP +.Dd January 2, 2026 +.Dt SSG-HELP 1 +.Os +.Sh NAME +.Nm ssg-help +.Nd open the manual page for a command +.Sh SYNOPSIS +.Nm ssg help +.Op Fl h | -help +.Ar [] +.Sh DESCRIPTION +.Nm +opens the manual page for a command. +.Pp If no command is specified, opens the main -.BR ssg (1) +.Xr ssg 1 page. -.SH EXAMPLES -Show main documentation: -.PP -.RS -.nf -$ ssg help -.fi -.RE -.PP -Show build command documentation: -.PP -.RS -.nf -$ ssg help build -.fi -.RE -.SH SSG -Part of the -.BR ssg (1) -suite. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh EXAMPLES +Show the manual page for +.Xr ssg 1 : +.Pp +.Dl $ ssg help +.Pp +Show the manual page for +.Xr ssg-build 1 : +.Pp +.Dl $ ssg help build +.Sh SEE ALSO +.Xr ssg 1 diff --git a/man/ssg-init.1 b/man/ssg-init.1 index 47dd2bb..909801b 100644 --- a/man/ssg-init.1 +++ b/man/ssg-init.1 @@ -1,45 +1,55 @@ -.TH SSG-INIT 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-init \- initialize a new site -.SH SYNOPSIS -.B ssg init -.RI [ directory ] -.SH DESCRIPTION -Create a new site with the standard directory structure: -.PP -.RS -.nf -data/ -templates/ -static/ -.fi -.RE -.PP -If no directory is specified, initializes in the current directory. -A sample -.I templates/index.html -is created if one does not exist. -.SH EXAMPLES -Initialize in the current directory: -.PP -.RS -.nf -$ ssg init -.fi -.RE -.PP -Initialize a new site: -.PP -.RS -.nf -$ ssg init mysite -$ cd mysite -$ ssg build -.fi -.RE -.SH SEE ALSO -.BR ssg-build (1) -.SH SSG -Part of the -.BR ssg (1) -suite. +.Dd January 2, 2026 +.Dt SSG-INIT 1 +.Os +.Sh NAME +.Nm ssg-init +.Nd initialize a new site +.Sh SYNOPSIS +.Nm ssg init +.Op Fl h | -help +.Ar [directory] +.Sh DESCRIPTION +.Nm +creates a new site with the standard directory structure: +.Pp +.Bl -item -offset indent -compact +.It +.Pa data/ +.It +.Pa templates/index.html +.It +.Pa static/ +.El +.Pp +If no +.Ar directory +is specified, initializes in the current directory. A sample +.Qq hello world +.Pa templates/index.html +is created if the file does not already exist. +.Pp +.Ar directory +can be any relative path from the current working directory or any absolute path. If any subdirectories are missing along the given path, they will be created with 755 permissions. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh EXAMPLES +Initialize a site in the current directory: +.Dl $ ssg init +.Pp +Initialize, build, and serve a new site in a subdirectory: +.Dl $ ssg init mysite +.Dl $ cd mysite +.Dl $ ssg build +.Dl $ ssg serve +.Pp +.Sh SEE ALSO +.Xr ssg 1 , +.Xr ssg-build 1 , +.Xr ssg-serve 1 , +.Xr ssg-templates 5 diff --git a/man/ssg-serve.1 b/man/ssg-serve.1 index ede5977..5d1ffd5 100644 --- a/man/ssg-serve.1 +++ b/man/ssg-serve.1 @@ -1,45 +1,50 @@ -.TH SSG-SERVE 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-serve \- serve the site locally -.SH SYNOPSIS -.B ssg serve -.RI [ options ] -.SH DESCRIPTION -Start a local HTTP server to preview the built site. -.SH OPTIONS -.TP -.BI \-dir " dir" -Directory to serve. Default: dist -.TP -.BI \-addr " address" -Address to listen on. Default: :8080 -.SH EXAMPLES -Serve the default output directory: -.PP -.RS -.nf -$ ssg serve -.fi -.RE -.PP +.Dd January 2, 2026 +.Dt SSG-SERVE 1 +.Os +.Sh NAME +.Nm ssg-serve +.Nd serve the built static site locally +.Sh SYNOPSIS +.Nm ssg serve +.Op Fl h | -help +.Op Fl d | -dir Ar dir +.Op Fl p | -port Ar port +.Sh DESCRIPTION +.Nm +starts a local HTTP server at +.Lk http://localhost:8080 +to preview the built site. +.Pp +It is assumed that you have run +.Xr ssg-build 1 +first. If not, the output directory may not exist and while the HTTP +server will start up, any request to the server will result in a 404 +Not Found. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.It Fl d Ar dir , Fl -dir Ar dir +Relative path to a directory to serve. Default: dist +.It Fl p Ar port , Fl -port Ar port +Port to listen on. Default: 8080 +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh EXAMPLES +Serve the default output directory on the default port: +.Dl $ ssg serve +.Pp Serve on a different port: -.PP -.RS -.nf -$ ssg serve -addr=:3000 -.fi -.RE -.PP +.Dl $ ssg serve --port 9000 +.Pp +Serve on a different output directory: +.Dl $ ssg serve --dir build/ +.Pp Build and serve: -.PP -.RS -.nf -$ ssg build && ssg serve -.fi -.RE -.SH SEE ALSO -.BR ssg-build (1) -.SH SSG -Part of the -.BR ssg (1) -suite. +.Dl $ ssg build && ssg serve +.Pp +.Sh SEE ALSO +.Xr ssg 1 , +.Xr ssg-build 1 diff --git a/man/ssg-templates.5 b/man/ssg-templates.5 index 8f31920..156eef9 100644 --- a/man/ssg-templates.5 +++ b/man/ssg-templates.5 @@ -1,83 +1,86 @@ -.TH SSG-TEMPLATES 5 "2026-01-01" "ssg" "File Formats Manual" -.SH NAME -ssg-templates \- ssg template format -.SH DESCRIPTION -ssg templates use Go's -.B html/template -syntax. Each HTML file in the templates directory is processed and rendered -to the output directory with the same filename. -.SH DATA -Data from JSON files in the data directory is made available to templates. -Each file becomes a template variable named after the file (without the -.I .json +.Dd January 2, 2026 +.Dt SSG-TEMPLATES 5 +.Os +.Sh NAME +.Nm ssg-templates +.Nd ssg template format +.Sh DESCRIPTION +Templates use Go's +.Lk https://pkg.go.dev/html/template html/template +syntax. Each HTML file in the templates directory (default: +.Pa templates/ ) +is processed and rendered to +the output directory with the same filename and directory structure. +.Sh DATA +Data from JSON files in the data directory (default: +.Pa data/ ) +is made available to templates. Each file becomes a template variable named +after the file (without the +.Pa .json extension). -.PP +.Pp For example, if -.I data/projects.json +.Pa data/projects.json contains: -.PP -.RS -.nf +.Bd -literal -offset indent [ {"name": "foo", "url": "https://example.com/foo", "featured": true}, {"name": "bar", "url": "https://example.com/bar", "featured": false} ] -.fi -.RE -.PP +.Ed +.Pp It can be accessed in templates as -.BR .projects : -.PP -.RS -.nf +.Va .projects : +.Bd -literal -offset indent {{range .projects}}
  • {{.name}}
  • {{end}} -.fi -.RE -.SH FUNCTIONS -.SS filter -The -.B filter -function returns items from an array where a field equals a value. -.PP -.RS -.nf -{{range filter .projects "featured" true}} -
  • {{.name}}
  • -{{end}} -.fi -.RE -.PP -This would output only "foo" since it has -.B featured -set to -.BR true . -.SH SYNTAX +.Ed +.Sh SYNTAX Templates use Go's text/template syntax: -.TP -.B {{.field}} +.Bl -tag -width Ds +.It Li {{.field}} Output a field value. -.TP -.B {{range .items}}...{{end}} +.It Li {{range .items}}...{{end}} Iterate over a list. -.TP -.B {{if .condition}}...{{end}} +.It Li {{if .condition}}...{{end}} Conditional rendering. -.TP -.B {{with .object}}...{{end}} +.It Li {{with .object}}...{{end}} Set dot to the object for the block. -.PP +.El +.Pp See the Go -.B html/template +.Lk https://pkg.go.dev/html/template html/template documentation for full syntax details. -.SH FILES -.TP -.I data/*.json -JSON data files. Each becomes a template variable. -.TP -.I templates/*.html +.Sh FUNCTIONS +In addition to Go's built-in template functions, the following +functions are available. +.Pp +All examples use data from +.Sx DATA . +.Ss filter +.Bd -literal +filter +.Ed +.Pp +Returns items from an array where a field equals a value. +.Bd -literal -offset indent +{{range filter .projects "featured" true}} +
  • {{.name}}
  • +{{end}} +.Ed +.Pp +This would output only "foo" since it has +.Va featured +set to +.Li true . +.Sh FILES +.Bl -tag -width Ds +.It Pa templates/*.html HTML templates to render. -.SH SEE ALSO -.BR ssg (1), -.BR ssg-build (1) +.It Pa data/*.json +JSON data files. Each becomes a template variable. +.El +.Sh SEE ALSO +.Xr ssg 1 , +.Xr ssg-build 1 diff --git a/man/ssg-version.1 b/man/ssg-version.1 index b5d4902..ff8e3f3 100644 --- a/man/ssg-version.1 +++ b/man/ssg-version.1 @@ -1,11 +1,23 @@ -.TH SSG-VERSION 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-version \- print version -.SH SYNOPSIS -.B ssg version -.SH DESCRIPTION -Print the ssg version and exit. -.SH SSG -Part of the -.BR ssg (1) -suite. +.Dd January 2, 2026 +.Dt SSG-VERSION 1 +.Os +.Sh NAME +.Nm ssg-version +.Nd print version +.Sh SYNOPSIS +.Nm ssg version +.Op Fl h | -help +.Sh DESCRIPTION +.Nm +prints the version of +.Xr ssg 1 . +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh SEE ALSO +.Xr ssg 1 diff --git a/man/ssg.1 b/man/ssg.1 index 837fbf7..57666bd 100644 --- a/man/ssg.1 +++ b/man/ssg.1 @@ -1,50 +1,60 @@ -.TH SSG 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg \- a tiny static site generator -.SH SYNOPSIS -.B ssg -.I command -.RI [ options ] -.SH DESCRIPTION -.B ssg -is a minimal static site generator that reads JSON data files and renders -Go templates to produce static HTML. Static assets are copied unchanged -to the output directory. -.SH COMMANDS -.TP -.BR ssg-build (1) +.Dd January 2, 2026 +.Dt SSG 1 +.Os +.Sh NAME +.Nm ssg +.Nd a tiny static site generator +.Sh SYNOPSIS +.Nm ssg +.Op Fl h | -help +.Ar +.Ar [] +.Sh DESCRIPTION +.Nm +is a tiny static site generator that can render Go templates to produce static +HTML. If any JSON data files are provided, they are automatically accessible +within the Go templates. Static assets are copied verbatim to the build output +directory. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.El +.Sh COMMANDS +.Bl -tag -width Ds +.It Xr ssg-build 1 Build the site. -.TP -.BR ssg-serve (1) -Start a local HTTP server. -.TP -.BR ssg-init (1) +.It Xr ssg-help 1 +Show the manual for a command. +.It Xr ssg-init 1 Initialize a new site. -.TP -.BR ssg-version (1) +.It Xr ssg-serve 1 +Start a local HTTP server serving the output directory. +.It Xr ssg-version 1 Print the version. -.TP -.BR ssg-help (1) -Show help for a command. -.SH FILES -.TP -.I data/ -JSON data files. Each file becomes a template variable. -.TP -.I templates/ -HTML template files. -.TP -.I static/ -Static files copied unchanged. -.TP -.I dist/ -Default output directory. -.SH SEE ALSO -.BR ssg-build (1), -.BR ssg-serve (1), -.BR ssg-init (1), -.BR ssg-version (1), -.BR ssg-help (1), -.BR ssg-templates (5) -.SH AUTHOR -Eugene Triguba +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa data/ +Data files to make available to the HTML templates. +.It Pa templates/ +HTML template files using the Go templating language. See +.Xr ssg-templates 5 +for details. +.It Pa static/ +Any files that should be copied to the output directory when the site is built +e.g. CSS, images, etc. +.It Pa dist/ +Default output directory that contains the static files verbatim and the +rendered HTML files. See +.Xr ssg-build 1 +for details. +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh AUTHOR +.Nm +was written and is maintained by +.An Eugene Triguba , +.Mt hello@eugenetriguba.com . diff --git a/serve.go b/serve.go index 8931113..820b6ac 100644 --- a/serve.go +++ b/serve.go @@ -5,27 +5,32 @@ import ( "flag" "fmt" "net/http" + "os" "git.sr.ht/~eugenetriguba/subcmd" ) type serveCmd struct { dir string - addr string + port int } func (c *serveCmd) Name() string { return "serve" } func (c *serveCmd) Synopsis() string { return "serve the site locally" } func (c *serveCmd) Usage() string { - return "serve [options]\n\nSee ssg-serve(1) for details.\n" + return `serve [-h | --help] [-d | --dir ] [-p | --port ] + +See ssg-serve(1) for details.` } func (c *serveCmd) SetFlags(f *flag.FlagSet) { - f.StringVar(&c.dir, "dir", "dist", "") - f.StringVar(&c.addr, "addr", ":8080", "") + f.StringVar(&c.dir, "d", "dist", "directory to serve") + f.StringVar(&c.dir, "dir", "dist", "directory to serve") + f.IntVar(&c.port, "p", 8080, "port to serve on") + f.IntVar(&c.port, "port", 8080, "port to serve on") } func (c *serveCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcmd.ExitStatus { - fmt.Printf("Serving %s at http://localhost%s\n", c.dir, c.addr) - if err := http.ListenAndServe(c.addr, http.FileServer(http.Dir(c.dir))); err != nil { + fmt.Fprintf(os.Stderr, "Serving %s at http://localhost:%d\n", c.dir, c.port) + if err := http.ListenAndServe(fmt.Sprintf(":%d", c.port), http.FileServer(http.Dir(c.dir))); err != nil { fatal("%v", err) } return subcmd.ExitSuccess diff --git a/site.go b/site.go index 03fdec7..c3bd8f3 100644 --- a/site.go +++ b/site.go @@ -39,7 +39,7 @@ func (s *Site) loadData() (map[string]any, error) { if os.IsNotExist(err) { return data, nil } - return nil, fmt.Errorf("reading data directory: %w", err) + return nil, fmt.Errorf("reading %s directory: %w", s.DataDir, err) } for _, entry := range entries { @@ -63,7 +63,7 @@ func (s *Site) loadData() (map[string]any, error) { f.Close() data[name] = v - s.log("data/%s.json", name) + s.log("%s/%s.json", s.DataDir, name) } return data, nil @@ -110,13 +110,13 @@ func (s *Site) copyStatic() error { return fmt.Errorf("copying static files: %w", err) } - s.log("static/") + s.log("%s/", s.StaticDir) return nil } func (s *Site) render(data map[string]any) error { if err := os.MkdirAll(s.OutDir, 0755); err != nil { - return fmt.Errorf("creating output directory: %w", err) + return fmt.Errorf("creating %s directory: %w", s.OutDir, err) } funcs := template.FuncMap{ @@ -125,7 +125,7 @@ func (s *Site) render(data map[string]any) error { entries, err := os.ReadDir(s.TemplatesDir) if err != nil { - return fmt.Errorf("reading templates directory: %w", err) + return fmt.Errorf("reading %s directory: %w", s.TemplatesDir, err) } for _, entry := range entries { diff --git a/version.go b/version.go index 5ba375b..154ed64 100644 --- a/version.go +++ b/version.go @@ -11,9 +11,13 @@ var version = "dev" type versionCmd struct{} -func (c *versionCmd) Name() string { return "version" } -func (c *versionCmd) Synopsis() string { return "print version" } -func (c *versionCmd) Usage() string { return "version: Print ssg version." } +func (c *versionCmd) Name() string { return "version" } +func (c *versionCmd) Synopsis() string { return "print version" } +func (c *versionCmd) Usage() string { + return `ssg version [-h | --help]: Print the ssg version. + +See ssg-version(1) for details.` +} func (c *versionCmd) SetFlags(f *flag.FlagSet) {} func (c *versionCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcmd.ExitStatus { fmt.Println(version) -- cgit v1.2.3