✨ Exporters: show description and name of exporters activated for the…

… build

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Cloud exporter: uses rclone to upload the database.json file to many cloud services
 - Requires key in exporter manifests to specify programs required to run the exporter
 
+### Changed
+
+- building now shows exporters that are activated along with their description
+
 ## [1.1.0] - 2024-04-14
 
 ### Added

build.go

@@ -268,6 +268,7 @@ func PrepareBuild(databaseDirectory string, outputFilename string, flags Flags,
 			return &ctx, err
 		}
 
+		LogCustom("Using", "magenta", "exporter [bold]%s[reset]\n[dim]%s", exporter.Name(), exporter.Description())
 		err = exporter.Before(&ctx, options)
 		if err != nil {
 			return &ctx, fmt.Errorf("while running exporter %s before hook: %w", exporter.Name(), err)

exporter_custom.go

@@ -37,6 +37,10 @@ func (e *CustomExporter) Name() string {
 	return e.name
 }
 
+func (e *CustomExporter) Description() string {
+	return e.manifest.Description
+}
+
 func (e *CustomExporter) OptionsType() any {
 	return e.manifest.Data
 }

exporter_sql.go

@@ -25,6 +25,10 @@ func (e *SqlExporter) Name() string {
 	return "sql"
 }
 
+func (e *SqlExporter) Description() string {
+	return "Export the database as SQL statements. Rudimentary for now."
+}
+
 func (e *SqlExporter) Before(ctx *RunContext, opts ExporterOptions) error {
 	e.result = ""
 	if !fileExists(e.outputFilename(ctx)) {

exporters.go

@@ -12,6 +12,7 @@ type ExporterOptions interface{}
 
 type Exporter interface {
 	Name() string
+	Description() string
 	Before(ctx *RunContext, opts ExporterOptions) error
 	Export(ctx *RunContext, opts ExporterOptions, work *AnalyzedWork) error
 	After(ctx *RunContext, opts ExporterOptions, built *Database) error