feat: add support for custom config locations & more cli flags

Signed-off-by: Henry <mail@henrygressmann.de>

Author: explodingcamera

README.md

@@ -0,0 +1,15 @@
+# StaticGen-Node
+
+StaticGen-Node is a simple wrapper around [staticgen](https://github.com/tj/staticgen) which simplifies using this tool in CI-Scenarios.
+
+```bash
+# npm
+npm install -S staticgen-node
+
+# yarn
+yarn add staticgen-node
+```
+
+Currently, the latest binaries for linux, osx and windows for amd64 and arm64 are included in the npm package (I might change this in a later version to download the binarys on runtime).
+
+StaticGen-Node also includes a couple of small changes to staticgen to improve the tool for CI, like windows support and all config variables are now also configurable using flags.

build.js

@@ -10,7 +10,7 @@ console.log("> removing old files");
 shell.rm("-rf", "./staticgen")
 console.log("> cloning staticgen");
 shell.exec(`git clone --depth 1 --branch v1.1.0 https://github.com/tj/staticgen`, {silent: true})
-console.log("> applying windows support patch");
-shell.exec("git apply remove-syscalls.patch --directory staticgen")
+console.log("> applying patches");
+shell.exec("git apply patches/*.patch --directory staticgen")
 console.log("> building binaries");
 shell.exec("goreleaser --snapshot --skip-publish --rm-dist")

package.json

@@ -1,6 +1,6 @@
 {
   "name": "staticgen-node",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "MIT",
   "author": "<mail@henrygressmann.de>",
   "main": "./lib/index.js",

remove-syscalls.patch patches/0000-remove-syscalls.patchremove-syscalls.patch renamed to patches/0000-remove-syscalls.patch

@@ -0,0 +1,33 @@
+diff --git a/staticgen.go b/staticgen.go
+index 63759e8..5a0b2a0 100644
+--- a/staticgen.go
++++ b/staticgen.go
+@@ -70,15 +70,9 @@ func (g *Generator) Run(ctx context.Context) error {
+
+ // Start loads configuration from ./static.json, starts the
+ // configured server, and begins the crawling process.
+-func (g *Generator) Start(ctx context.Context) error {
+-	// load configuration
+-	err := g.Config.Load("static.json")
+-	if err != nil {
+-		return fmt.Errorf("loading configuration: %w", err)
+-	}
+-
++func (g *Generator) Start(ctx context.Context, config Config) error {
+ 	// remove output dir
+-	err = os.RemoveAll(g.Dir)
++	err := os.RemoveAll(g.Dir)
+ 	if err != nil {
+ 		return fmt.Errorf("removing output directory: %w", err)
+ 	}
+@@ -49,8 +49,8 @@ type Generator struct {
+
+ // Run starts the configured server command, starts to perform crawling,
+ // and waits for completion before shutting down the configured server.
+-func (g *Generator) Run(ctx context.Context) error {
+-	err := g.Start(ctx)
++func (g *Generator) Run(ctx context.Context, config Config) error {
++	err := g.Start(ctx, config)
+ 	if err != nil {
+ 		return fmt.Errorf("starting: %w", err)
+ 	}

patches/0001-no-file-config.patch

@@ -0,0 +1,73 @@
+diff --git a/cmd/staticgen/main.go b/cmd/staticgen/main.go
+index def98a4..410b86b 100644
+--- a/cmd/staticgen/main.go
++++ b/cmd/staticgen/main.go
+@@ -62,7 +62,40 @@ func main() {
+ func generateCmd(app *kingpin.Application) {
+ 	cmd := app.Command("generate", "Generate static website").Default()
+ 	timeout := cmd.Flag("timeout", "Timeout of website generation").Short('t').Default("15m").String()
++	conf := cmd.Flag("config", "Config path").Default("static.json").String()
++	dir := cmd.Flag("directory", "The static website output directory").Default("build").String()
++	url := cmd.Flag("url", "URL is the target website to crawl").Default("http://127.0.0.1:3000").String()
++	pages := cmd.Flag("pages", "Pages is a list of paths added to crawl").Strings()
++	concurrency := cmd.Flag("concurrency", "Concurrency is the number of concurrent pages to crawl").Default("30").Int()
++	allow404 := cmd.Flag("allow404", "Allow404 can be enabled to opt-in to pages resulting in a 404").Default("false").Bool()
++
+ 	cmd.Action(func(_ *kingpin.ParseContext) error {
++		var c staticgen.Config
++
++		if err := c.Load(*conf); err != nil {
++			return fmt.Errorf("loading configuration: %w", err)
++		}
++
++		if c.Dir == "build" {
++			c.Dir = *dir
++		}
++
++		if c.URL == "http://127.0.0.1:3000" {
++			c.URL = *url
++		}
++
++		if len(c.Pages) == 0 {
++			c.Pages = *pages
++		}
++
++		if !c.Allow404 {
++			c.Allow404 = *allow404
++		}
++
++		if c.Concurrency == 30 {
++			c.Concurrency = *concurrency
++		}
++
+ 		// generator
+ 		g := staticgen.Generator{
+ 			HTTPClient: client,
+@@ -94,7 +127,7 @@ func generateCmd(app *kingpin.Application) {
+ 		done := r.Report(events)
+ 
+ 		// start
+-		err = g.Run(ctx)
++		err = g.Run(ctx, c)
+ 		if err != nil {
+ 			return fmt.Errorf("crawling: %w", err)
+ 		}
+@@ -109,10 +142,17 @@ func generateCmd(app *kingpin.Application) {
+ func serveCmd(app *kingpin.Application) {
+ 	cmd := app.Command("serve", "Serve the generated website")
+ 	addr := cmd.Flag("address", "Bind address").Default("localhost:3000").String()
++	dir := cmd.Flag("directory", "The static website output directory").Default("build").String()
++	conf := cmd.Flag("config", "Config path").Default("static.json").String()
++
+ 	cmd.Action(func(_ *kingpin.ParseContext) error {
+ 		var c staticgen.Config
++		err := c.Load(*conf)
++
++		if c.Dir == "build" {
++			c.Dir = *dir
++		}
+ 
+-		err := c.Load("static.json")
+ 		if err != nil {
+ 			return fmt.Errorf("loading configuration: %w", err)
+ 		}