feat: Add fig support to Meroxa CLI (#403)

* feat: Add fig support

* feat: add workflow

* feat: generate fig documentation separately

* test: workflow

* rename: acceptance test action

* update: gh action

* fix: update gh action name

* add debugger

* move action

* Test new spec path

* update spec path

* test direct push

* fix: description for apps deploy

* fix: update documentation + workflow

* feat: update spec only when releasing

* fix: isRepeatable

* chore: Update dependencies

* chore: Update documentation that was out of date

* doc: Update readme adding steps relevant to Fig

* chore: no need to delete it

* fix: typo

* Update gen-spec/main.go

Co-authored-by: Janelle Tavares <janelletavares@users.noreply.github.com>

* Update gen-spec/main.go

Co-authored-by: Janelle Tavares <janelletavares@users.noreply.github.com>

* fix: link

* fix: lint

* chore: update fig spec

Co-authored-by: Janelle Tavares <janelletavares@users.noreply.github.com>

Author: raulb

.github/workflows/pull_request.yml .github/workflows/acceptance_test.yml

@@ -1,5 +1,4 @@
-name: Acceptance Test
-
+name: Acceptance Tests
 # Run this workflow every time a new PR wants to merge to master/main
 on:
   pull_request:

.github/workflows/fig.yml

@@ -0,0 +1,31 @@
+name: 'Fig Autocomplete Spec'
+on:
+  push:
+    tags:
+      - 'v*'
+      - '!v*.*.*-nightly.*'
+  workflow_dispatch:
+
+jobs:
+  publish-spec:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: ^1.18
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v3  
+    - name: Run make fig
+      run: |
+       make fig
+    - name: Create Autocomplete PR ## Create the autocomplete PR using this action
+      uses: withfig/push-to-fig-autocomplete-action@v1
+      with:
+        token: ${{ secrets.MEROXA_MACHINE }}
+        autocomplete-spec-name: meroxa
+        spec-path: spec/meroxa.ts
+        repo-org: meroxa
+        repo-name: cli-autocomplete
+        integration: cobra
+        use-minor-base: true

Makefile

@@ -24,13 +24,17 @@ test:
 	go test -v ${GO_TEST_FLAGS} -count=1 -timeout 5m ./...
 
 .PHONY: docs
-docs:
 ifeq ($(REBUILD_DOCS), "true")
+docs:
 	rm -rf docs/cmd && mkdir -p docs/cmd/{md,www}
 	rm -rf etc && mkdir -p etc/man/man1 && mkdir -p etc/completion
 	go run gen-docs/main.go
 endif
 
+.PHONY: fig
+fig:
+	go run gen-spec/main.go
+
 .PHONY: lint
 lint:
 	docker run --rm -v $(CURDIR):/app -w /app golangci/golangci-lint:latest golangci-lint run --timeout 5m -v

README.md

@@ -32,6 +32,12 @@ These are also updated when running `make build`. In the event you need to build
 $ export REBUILD_DOCS="false"
 ```
 
+To generate manually a Meroxa spec for Fig, you could simply run:
+
+```shell
+$ make fig
+```
+
 ## Contributing
 
 For a complete guide to contributing to the Meroxa CLI, see the [Contribution Guide](CONTRIBUTING.md).
@@ -81,6 +87,10 @@ git tag is pushed to the repo.
 
 With every release, a new Homebrew formula will be automatically updated on [meroxa/homebrew-taps](https://github.com/meroxa/homebrew-taps).
 
+When releasing a newer version of our Meroxa CLI, a new [Meroxa spec](https://github.com/withfig/autocomplete/blob/master/src/meroxa.ts) for [Fig](https://fig.io/) will be automatically generated in [meroxa/cli-autocomplete](https://github.com/meroxa/cli-autocomplete) via [this GitHub action](/.github/workflows/fig.yml).
+
+Once a new pull-request is opened in [meroxa/cli-autocomplete](https://github.com/meroxa/cli-autocomplete), you'll need to submit a request to main's [withfig/autocomplete's](https://github.com/withfig/autocomplete) repository.
+
 ## Linting
 
 If you want to make sure everything's correct before pushing to GitHub, you'll need to install [`golangci-lint`](https://golangci-lint.run/) and run:

cmd/meroxa/root/apps/deploy.go

@@ -62,10 +62,10 @@ type deployApplicationClient interface {
 
 type Deploy struct {
 	flags struct {
-		Path                 string `long:"path" description:"path to the app directory (default is local directory)"`
-		DockerHubUserName    string `long:"docker-hub-username" description:"DockerHub username to use to build and deploy the app" hidden:"true"`         //nolint:lll
-		DockerHubAccessToken string `long:"docker-hub-access-token" description:"DockerHub access token to use to build and deploy the app" hidden:"true"` //nolint:lll
-		Spec                 string `long:"spec" description:"Deployment specification version to use to build and deploy the app" hidden:"true"`
+		Path                 string `long:"path" usage:"path to the app directory (default is local directory)"`
+		DockerHubUserName    string `long:"docker-hub-username" usage:"DockerHub username to use to build and deploy the app" hidden:"true"`         //nolint:lll
+		DockerHubAccessToken string `long:"docker-hub-access-token" usage:"DockerHub access token to use to build and deploy the app" hidden:"true"` //nolint:lll
+		Spec                 string `long:"spec" usage:"Deployment specification version to use to build and deploy the app" hidden:"true"`
 	}
 
 	client        deployApplicationClient

cmd/meroxa/root/root.go

@@ -78,7 +78,7 @@ meroxa resources list --types
 	global.RegisterGlobalFlags(cmd)
 
 	// Subcommands
-	cmd.AddCommand(CompletionCmd()) // Coming from Cobra
+	cmd.AddCommand(CompletionCmd()) // To generate shell autocompletion
 
 	cmd.AddCommand(builder.BuildCobraCommand(&api.API{}))
 	cmd.AddCommand(builder.BuildCobraCommand(&auth.Auth{}))

docs/cmd/md/meroxa_apps_deploy.md

@@ -25,7 +25,7 @@ meroxa apps deploy --path ./my-app
 
 ```
   -h, --help          help for deploy
-      --path string   
+      --path string   path to the app directory (default is local directory)
 ```
 
 ### Options inherited from parent commands

docs/cmd/www/meroxa-apps-deploy.md

@@ -32,7 +32,7 @@ meroxa apps deploy --path ./my-app
 
 ```
   -h, --help          help for deploy
-      --path string   
+      --path string   path to the app directory (default is local directory)
 ```
 
 ### Options inherited from parent commands

etc/completion/meroxa.completion.fish

@@ -18,7 +18,8 @@ function __meroxa_perform_completion
     __meroxa_debug "args: $args"
     __meroxa_debug "last arg: $lastArg"
 
-    set -l requestComp "$args[1] __complete $args[2..-1] $lastArg"
+    # Disable ActiveHelp which is not supported for fish shell
+    set -l requestComp "MEROXA_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg"
 
     __meroxa_debug "Calling $requestComp"
     set -l results (eval $requestComp 2> /dev/null)

etc/completion/meroxa.completion.ps1

@@ -33,17 +33,18 @@ Register-ArgumentCompleter -CommandName 'meroxa' -ScriptBlock {
     if ($Command.Length -gt $CursorPosition) {
         $Command=$Command.Substring(0,$CursorPosition)
     }
-	__meroxa_debug "Truncated command: $Command"
+    __meroxa_debug "Truncated command: $Command"
 
     $ShellCompDirectiveError=1
     $ShellCompDirectiveNoSpace=2
     $ShellCompDirectiveNoFileComp=4
     $ShellCompDirectiveFilterFileExt=8
     $ShellCompDirectiveFilterDirs=16
 
-	# Prepare the command to request completions for the program.
+    # Prepare the command to request completions for the program.
     # Split the command at the first space to separate the program and arguments.
     $Program,$Arguments = $Command.Split(" ",2)
+
     $RequestComp="$Program __completeNoDesc $Arguments"
     __meroxa_debug "RequestComp: $RequestComp"
 
@@ -73,11 +74,13 @@ Register-ArgumentCompleter -CommandName 'meroxa' -ScriptBlock {
     }
 
     __meroxa_debug "Calling $RequestComp"
+    # First disable ActiveHelp which is not supported for Powershell
+    $env:MEROXA_ACTIVE_HELP=0
+
     #call the command store the output in $out and redirect stderr and stdout to null
     # $Out is an array contains each line per element
     Invoke-Expression -OutVariable out "$RequestComp" 2>&1 | Out-Null
 
-
     # get directive from last line
     [int]$Directive = $Out[-1].TrimStart(':')
     if ($Directive -eq "") {
@@ -216,7 +219,7 @@ Register-ArgumentCompleter -CommandName 'meroxa' -ScriptBlock {
             Default {
                 # Like MenuComplete but we don't want to add a space here because
                 # the user need to press space anyway to get the completion.
-                # Description will not be shown because thats not possible with TabCompleteNext
+                # Description will not be shown because that's not possible with TabCompleteNext
                 [System.Management.Automation.CompletionResult]::new($($comp.Name | __meroxa_escapeStringWithSpecialChars), "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
             }
         }