Add lets self doc command

Author: kindermax

cmd/lets/main.go

@@ -164,7 +164,7 @@ func getExitCode(err error, defaultCode int) int {
 
 // do not fail on config error in it is help (-h, --help) or --init or completion command.
 func failOnConfigError(root *cobra.Command, current *cobra.Command, rootFlags *flags) bool {
-	rootCommands := set.NewSet("completion", "help", "lsp")
+	rootCommands := set.NewSet("completion", "help", "self", "lsp", "doc")
 	return (root.Flags().NFlag() == 0 && !rootCommands.Contains(current.Name())) && !rootFlags.help && !rootFlags.init
 }
 

docs/docs/changelog.md

@@ -13,6 +13,7 @@ title: Changelog
 * `[Added]` When a command or its `depends` chain fails, print an indented tree to stderr showing the full chain with the failing command highlighted
 * `[Added]` Support `env_file` in global config and commands. File names are expanded after `env` is resolved, and values loaded from env files override values from `env`.
 * `[Changed]` Migrate the LSP YAML parser from the CGO-based tree-sitter bindings to pure-Go [`gotreesitter`](https://github.com/odvcencio/gotreesitter), removing the C toolchain requirement from normal builds and release packaging.
+* `[Added]` Add `lets self doc` command to open the online documentation in a browser.
 
 ## [0.0.59](https://github.com/lets-cli/lets/releases/tag/v0.0.59)
 

internal/cmd/doc.go

@@ -0,0 +1,27 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+const letsDocsURL = "https://lets-cli.org/docs/quick_start"
+
+func initDocCommand(openURL func(string) error) *cobra.Command {
+	docCmd := &cobra.Command{
+		Use:     "doc",
+		Aliases: []string{"docs"},
+		Short:   "Open lets documentation in browser",
+		Args:    cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := openURL(letsDocsURL); err != nil {
+				return fmt.Errorf("can not open documentation: %w", err)
+			}
+
+			return nil
+		},
+	}
+
+	return docCmd
+}

internal/cmd/root_test.go

@@ -176,6 +176,69 @@ func TestPrintVersionMessage(t *testing.T) {
 }
 
 func TestSelfCmd(t *testing.T) {
+	t.Run("should open documentation in browser", func(t *testing.T) {
+		bufOut := new(bytes.Buffer)
+		called := false
+		gotURL := ""
+
+		prevOpenURL := openURL
+		openURL = func(url string) error {
+			called = true
+			gotURL = url
+
+			return nil
+		}
+		defer func() {
+			openURL = prevOpenURL
+		}()
+
+		rootCmd := CreateRootCommand("v0.0.0-test", "")
+		rootCmd.SetArgs([]string{"self", "doc"})
+		rootCmd.SetOut(bufOut)
+		rootCmd.SetErr(bufOut)
+		InitSelfCmd(rootCmd, "v0.0.0-test")
+
+		err := rootCmd.Execute()
+		if err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+
+		if !called {
+			t.Fatal("expected documentation opener to be called")
+		}
+
+		if gotURL != letsDocsURL {
+			t.Fatalf("expected docs url %q, got %q", letsDocsURL, gotURL)
+		}
+	})
+
+	t.Run("should return opener error for documentation command", func(t *testing.T) {
+		bufOut := new(bytes.Buffer)
+
+		prevOpenURL := openURL
+		openURL = func(url string) error {
+			return errors.New("open failed")
+		}
+		defer func() {
+			openURL = prevOpenURL
+		}()
+
+		rootCmd := CreateRootCommand("v0.0.0-test", "")
+		rootCmd.SetArgs([]string{"self", "doc"})
+		rootCmd.SetOut(bufOut)
+		rootCmd.SetErr(bufOut)
+		InitSelfCmd(rootCmd, "v0.0.0-test")
+
+		err := rootCmd.Execute()
+		if err == nil {
+			t.Fatal("expected documentation opener error")
+		}
+
+		if !strings.Contains(err.Error(), "can not open documentation") {
+			t.Fatalf("expected documentation error, got %q", err.Error())
+		}
+	})
+
 	t.Run("should return exit code 2 for unknown self subcommand", func(t *testing.T) {
 		bufOut := new(bytes.Buffer)
 

internal/cmd/self.go

@@ -1,9 +1,12 @@
 package cmd
 
 import (
+	"github.com/lets-cli/lets/internal/util"
 	"github.com/spf13/cobra"
 )
 
+var openURL = util.OpenURL
+
 // InitSelfCmd intializes root 'self' subcommand.
 func InitSelfCmd(rootCmd *cobra.Command, version string) {
 	selfCmd := &cobra.Command{
@@ -19,5 +22,6 @@ func InitSelfCmd(rootCmd *cobra.Command, version string) {
 
 	rootCmd.AddCommand(selfCmd)
 
+	selfCmd.AddCommand(initDocCommand(openURL))
 	selfCmd.AddCommand(initLspCommand(version))
 }

internal/util/browser.go

@@ -0,0 +1,36 @@
+package util
+
+import (
+	"fmt"
+	"os/exec"
+	"runtime"
+)
+
+func browserCommand(goos string, url string) (string, []string, error) {
+	switch goos {
+	case "darwin":
+		return "open", []string{url}, nil
+	case "linux":
+		return "xdg-open", []string{url}, nil
+	default:
+		return "", nil, fmt.Errorf("unsupported platform %q", goos)
+	}
+}
+
+func OpenURL(url string) error {
+	name, args, err := browserCommand(runtime.GOOS, url)
+	if err != nil {
+		return err
+	}
+
+	cmd := exec.Command(name, args...)
+	if err := cmd.Start(); err != nil {
+		return fmt.Errorf("start %s: %w", name, err)
+	}
+
+	if cmd.Process != nil {
+		_ = cmd.Process.Release()
+	}
+
+	return nil
+}

internal/util/browser_test.go

@@ -0,0 +1,47 @@
+package util
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestBrowserCommand(t *testing.T) {
+	t.Run("darwin", func(t *testing.T) {
+		name, args, err := browserCommand("darwin", "https://lets-cli.org")
+		if err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+
+		if name != "open" {
+			t.Fatalf("expected open, got %q", name)
+		}
+
+		expectedArgs := []string{"https://lets-cli.org"}
+		if !reflect.DeepEqual(args, expectedArgs) {
+			t.Fatalf("expected args %v, got %v", expectedArgs, args)
+		}
+	})
+
+	t.Run("linux", func(t *testing.T) {
+		name, args, err := browserCommand("linux", "https://lets-cli.org")
+		if err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+
+		if name != "xdg-open" {
+			t.Fatalf("expected xdg-open, got %q", name)
+		}
+
+		expectedArgs := []string{"https://lets-cli.org"}
+		if !reflect.DeepEqual(args, expectedArgs) {
+			t.Fatalf("expected args %v, got %v", expectedArgs, args)
+		}
+	})
+
+	t.Run("unsupported", func(t *testing.T) {
+		_, _, err := browserCommand("windows", "https://lets-cli.org")
+		if err == nil {
+			t.Fatal("expected unsupported platform error")
+		}
+	})
+}

tests/no_lets_file.bats

@@ -49,4 +49,37 @@ NOT_EXISTED_LETS_FILE="lets-not-existed.yaml"
     LETS_CONFIG=${NOT_EXISTED_LETS_FILE} run lets -h
     assert_success
     assert_line --index 0  "A CLI task runner"
-}
+}
+
+@test "no_lets_file: lets self doc opens docs without config" {
+    fake_bin_dir="$(mktemp -d)"
+    opened_url_file="$(mktemp)"
+    rm -f "${opened_url_file}"
+
+    cat > "${fake_bin_dir}/xdg-open" <<'EOF'
+#!/usr/bin/env bash
+printf "%s" "$1" > "${LETS_TEST_OPENED_URL_FILE}"
+EOF
+    chmod +x "${fake_bin_dir}/xdg-open"
+
+    PATH="${fake_bin_dir}:${PATH}" \
+    LETS_CONFIG=${NOT_EXISTED_LETS_FILE} \
+    LETS_TEST_OPENED_URL_FILE="${opened_url_file}" \
+    run lets self doc
+
+    assert_success
+
+    for _ in $(seq 1 20); do
+        if [[ -f "${opened_url_file}" ]]; then
+            break
+        fi
+        sleep 0.1
+    done
+
+    run cat "${opened_url_file}"
+    assert_success
+    assert_output "https://lets-cli.org/docs/quick_start"
+
+    rm -rf "${fake_bin_dir}"
+    rm -f "${opened_url_file}"
+}