Updates build process to unify with dump and fdw anywhere. Closes #9

Author: binaek

Makefile

@@ -1,4 +1,10 @@
-build:
-	go run generate/generator.go templates . $(plugin_alias) $(plugin_github_url)
+# Check if the 'plugin' variable is set
+validate_plugin:
+ifndef plugin
+	$(error "The 'plugin' variable is missing. Usage: make build plugin=<plugin_name>")
+endif
+
+build: validate_plugin
+	go run generate/generator.go templates . $(plugin) $(plugin_github_url)
 	go mod tidy
 	make -f out/Makefile build

generate/generator.go

@@ -13,6 +13,11 @@ import (
 
 const templateExt = ".tmpl"
 
+type RenderData struct {
+	Plugin          string
+	PluginGithubUrl string
+}
+
 func RenderDir(templatePath, root, pluginAlias, pluginGithubUrl string) {
 	var targetFilePath string
 	err := filepath.Walk(templatePath, func(filePath string, info os.FileInfo, err error) error {
@@ -59,12 +64,9 @@ func RenderDir(templatePath, root, pluginAlias, pluginGithubUrl string) {
 		var renderedContent strings.Builder
 
 		// define the data to be used in the template
-		data := struct {
-			PluginAlias     string
-			PluginGithubUrl string
-		}{
-			pluginAlias,
-			pluginGithubUrl,
+		data := RenderData{
+			Plugin:          pluginAlias,
+			PluginGithubUrl: pluginGithubUrl,
 		}
 
 		// execute the template with the data
@@ -95,15 +97,25 @@ func RenderDir(templatePath, root, pluginAlias, pluginGithubUrl string) {
 
 func main() {
 	// Check if the correct number of command-line arguments are provided
-	if len(os.Args) != 5 {
-		fmt.Println("Usage: go run generator.go <templatePath> <root> <pluginAlias> <pluginGithubUrl>")
+	if len(os.Args) < 4 {
+		fmt.Println("Usage: go run generator.go <templatePath> <root> <plugin> [pluginGithubUrl]")
 		return
 	}
 
 	templatePath := os.Args[1]
 	root := os.Args[2]
-	pluginAlias := os.Args[3]
-	pluginGithubUrl := os.Args[4]
+	plugin := os.Args[3]
+	var pluginGithubUrl string
+
+	fmt.Println(len(os.Args))
+
+	// Check if PluginGithubUrl is provided as a command-line argument
+	if len(os.Args) == 5 {
+		pluginGithubUrl = os.Args[4]
+	} else {
+		// If PluginGithubUrl is not provided, generate it based on PluginAlias
+		pluginGithubUrl = "github.com/turbot/steampipe-plugin-" + plugin
+	}
 
 	// Convert relative paths to absolute paths
 	absTemplatePath, err := filepath.Abs(templatePath)
@@ -118,5 +130,5 @@ func main() {
 		return
 	}
 
-	RenderDir(absTemplatePath, absRoot, pluginAlias, pluginGithubUrl)
+	RenderDir(absTemplatePath, absRoot, plugin, pluginGithubUrl)
 }

templates/main.go.tmpl

@@ -5,11 +5,11 @@ package main
 import (
 	"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
 
-	"{{.PluginGithubUrl}}/{{.PluginAlias}}"
+	"{{.PluginGithubUrl}}/{{.Plugin}}"
 )
 
-var pluginServer = plugin.Server(&plugin.ServeOpts{PluginFunc: {{.PluginAlias}}.Plugin})
-var pluginAlias = "{{.PluginAlias}}"
+var pluginServer = plugin.Server(&plugin.ServeOpts{PluginFunc: {{.Plugin}}.Plugin})
+var pluginAlias = "{{.Plugin}}"
 
 func init() {
 	setupLogger(pluginAlias)

templates/out/Makefile.tmpl

@@ -4,4 +4,4 @@ ifeq ($(shell uname -s),Darwin)
 endif
 
 build:
-	go build -v -x -buildmode=c-shared -o steampipe_sqlite_extension_{{.PluginAlias}}.so
+	go build -buildmode=c-shared -o steampipe_sqlite_extension_{{.Plugin}}.so

templates/out/README.md.tmpl

@@ -1,25 +1,25 @@
-# Steampipe SQLite Extension {{.PluginAlias}}
+# Steampipe SQLite Extension {{.Plugin}}
 
-This SQLite extensions allows you to query {{.PluginAlias}} using the [Steampipe Plugin](https://{{.PluginGithubUrl}})
+This SQLite extensions allows you to query {{.Plugin}} using the [Steampipe Plugin](https://{{.PluginGithubUrl}})
 
 ## Prerequisites
 - A build of SQLite that supports extensions, you can verify this by opening SQLite and ensuring `.help` displays a `.load command`.
   - If required you can [download](https://www.sqlite.org/download.html) a pre-compiled binary or compile from [source](https://github.com/sqlite/sqlite#compiling-for-unix-like-systems)
 
 ## Configuration
-If you require [configuration](https://hub.steampipe.io/plugins/turbot/{{.PluginAlias}}#configuration) for the extension, you need to set this prior to loading the extension.
+If you require [configuration](https://hub.steampipe.io/plugins/turbot/{{.Plugin}}#configuration) for the extension, you need to set this prior to loading the extension.
 
 - Create the configuration table if it doesn't exist:
-  - `CREATE TABLE IF NOT EXISTS {{.PluginAlias}}_config(config TEXT);`
+  - `CREATE TABLE IF NOT EXISTS {{.Plugin}}_config(config TEXT);`
 - Insert your configuration into the config table:
-  - `INSERT INTO {{.PluginAlias}}_config(config) VALUES('your_config="GoesHere"')`
+  - `INSERT INTO {{.Plugin}}_config(config) VALUES('your_config="GoesHere"')`
 
 ## Installation
-- Copy the binary `steampipe-sqlite-extension-{{.PluginAlias}}.so` to a directory of choice.
+- Copy the binary `steampipe-sqlite-extension-{{.Plugin}}.so` to a directory of choice.
 - Start your `sqlite` instance.
   - `sqlite3` or `sqlite3 myDB.file`
 - Load the extension into `sqlite`. 
-  - `.load /path/to/steampipe-sqlite-extension-{{.PluginAlias}}.so`
+  - `.load /path/to/steampipe-sqlite-extension-{{.Plugin}}.so`
 
 ## Usage
-Please refer to the [Table Documentation](https://hub.steampipe.io/plugins/turbot/{{.PluginAlias}}/tables).
+Please refer to the [Table Documentation](https://hub.steampipe.io/plugins/turbot/{{.Plugin}}/tables).