Merge branch 'main' into zimeg-fix-env-quote

Author: zimeg

.circleci/config.yml

@@ -159,7 +159,7 @@ jobs:
       - run:
           name: Run GoReleaser. Without actually publishing.
           command: |
-            LDFLAGS="-s -w -X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=$BUILD_VERSION'"
+            LDFLAGS="-s -w -X 'github.com/slackapi/slack-cli/internal/version.Version=$BUILD_VERSION'"
             make LDFLAGS="$LDFLAGS" build-snapshot
       - run:
           name: Show binaries are generated correctly

.claude/CLAUDE.md

@@ -171,7 +171,7 @@ Versions use semantic versioning with git tags (format: `v*.*.*`).
 Version is generated dynamically using `git describe` and injected at build time:
 
 ```bash
-LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=`git describe --tags --match 'v*.*.*'`'
+LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/version.Version=`git describe --tags --match 'v*.*.*'`'
 ```
 
 **Versioning Rules**:
@@ -189,6 +189,10 @@ When deprecating features, commands, or flags:
 3. **Public functionality**: Add comment `// DEPRECATED(semver:major): <description and migration path>`
 4. **Internal functionality**: Add comment `// DEPRECATED: <description>`
 
+## Style Guide
+
+See [`.github/STYLE_GUIDE.md`](../.github/STYLE_GUIDE.md) for conventions on command inputs and outputs.
+
 ## Important Configuration Files
 
 - `.golangci.yml` - Linter configuration with custom initialisms (CLI, API, SDK, etc.) and staticcheck rules

.claude/settings.json

@@ -27,10 +27,13 @@
       "Bash(make build:*)",
       "Bash(make lint:*)",
       "Bash(make test:*)",
+      "Bash(mkdir:*)",
       "Bash(tree:*)",
+      "Bash(vhs:*)",
       "WebFetch(domain:docs.slack.dev)",
       "WebFetch(domain:github.com)"
-    ]
+    ],
+    "deny": ["Bash(vhs publish:*)"]
   },
   "enabledPlugins": {
     "gopls-lsp@claude-plugins-official": true

.github/MAINTAINERS_GUIDE.md

@@ -294,6 +294,7 @@ Certain things are common during development and require a few commands.
   - [Bumping the Golang version](#bumping-the-golang-version)
   - [Bumping Go packages versions](#bumping-go-package-versions)
   - [Bumping Goreleaser versions](#bumping-goreleaser-versions)
+- [Designing](#designing)
 - [Deprecating features and flags](#deprecating-features-and-flags)
 - [Allowlist configuration](#allowlist-configuration)
 
@@ -632,6 +633,11 @@ updates in the following files on occasion:
 
 Testing in our CI setup uses changes to these files when creating test builds.
 
+### Designing
+
+Conventions for how commands handle inputs and format outputs are documented in
+the [style guide][style-guide].
+
 ### Deprecating features and flags
 
 Many good things come to an end. This can sometimes include commands and flags.
@@ -926,6 +932,7 @@ When in doubt, find the other maintainers and ask.
 [practical-go]: https://dave.cheney.net/practical-go/presentations/qcon-china.html
 [scripts]: ../scripts
 [semver]: https://semver.org/
+[style-guide]: ./STYLE_GUIDE.md
 [sync]: https://github.com/slackapi/slack-cli/blob/main/.github/workflows/sync-docs-from-cli-repo.yml
 [vscode]: https://github.com/slackapi/slack-cli/blob/main/.vscode/settings.json
 [wf-dependencies]: ./workflows/dependencies.yml

.github/STYLE_GUIDE.md

@@ -0,0 +1,40 @@
+# Style Guide
+
+A current suggestion for how Slack CLI inputs are handled and outputs are formatted.
+
+- **Input**
+  - [Prompts are Flags with Forms](#prompts-are-flags-with-forms)
+- **Output**
+  - [Format Sections with Command Details](#format-sections-with-command-details)
+
+## Input
+
+Customizations to commands are made through arguments, flags, environment variables, saved files, details from the Slack API itself, or sometimes just kept as "sensible" defaults.
+
+### Prompts are Flags with Forms
+
+When information is needed we can prompt for text, confirmation, or a selection.
+
+These decisions can be made in an interactive terminal (TTY) or not, such as in a scripting environment.
+
+A flag option should exist for each prompt with a form fallback. Either default values should be used if forms are attempted in a non-TTY setup or an error and remmediation to use a flag should be returned.
+
+## Output
+
+Results of a command go toward informing current happenings and suggesting next steps.
+
+### Format Sections with Command Details
+
+A command often prints information and details about the process happenings. We format this as a section:
+
+```txt
+📚 App Install
+   Installing "focused-lamb-99" app to "devrelsandbox"
+   Finished in 2.0s
+```
+
+This example highlights some recommendations:
+
+- An emoji is used with the section header.
+- The section header text is the command name, with "Title Case" letters.
+- Following details reveal progress of the process.

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Install Tests
         run: make test-install
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+        uses: codecov/codecov-action@1af58845a975a7985b0beb0cbe6fbbb71a41dbad # v5.5.3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage.out

Makefile

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # Common variables
-LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=`git describe --tags --match 'v*.*.*'`'
+LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/version.Version=`git describe --tags --match 'v*.*.*'`'
 BUILD_VERSION = `git describe --tags --match 'v*.*.*' | sed 's/v//'`
 RELEASE_VERSION := $(shell git describe --tags --match 'v*.*.*')
 testdir ?= ...

cmd/doctor/check.go

@@ -26,12 +26,12 @@ import (
 	"github.com/slackapi/slack-cli/internal/config"
 	"github.com/slackapi/slack-cli/internal/deputil"
 	"github.com/slackapi/slack-cli/internal/iostreams"
-	"github.com/slackapi/slack-cli/internal/pkg/version"
 	"github.com/slackapi/slack-cli/internal/shared"
 	"github.com/slackapi/slack-cli/internal/shared/types"
 	"github.com/slackapi/slack-cli/internal/slackerror"
 	"github.com/slackapi/slack-cli/internal/style"
 	"github.com/slackapi/slack-cli/internal/update"
+	"github.com/slackapi/slack-cli/internal/version"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )

cmd/doctor/check_test.go

@@ -23,12 +23,12 @@ import (
 	"github.com/slackapi/slack-cli/internal/config"
 	"github.com/slackapi/slack-cli/internal/deputil"
 	"github.com/slackapi/slack-cli/internal/hooks"
-	"github.com/slackapi/slack-cli/internal/pkg/version"
 	"github.com/slackapi/slack-cli/internal/shared"
 	"github.com/slackapi/slack-cli/internal/shared/types"
 	"github.com/slackapi/slack-cli/internal/slackcontext"
 	"github.com/slackapi/slack-cli/internal/slackdeps"
 	"github.com/slackapi/slack-cli/internal/slackerror"
+	"github.com/slackapi/slack-cli/internal/version"
 	"github.com/slackapi/slack-cli/test/slackmock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"

cmd/doctor/doctor_test.go

@@ -24,12 +24,12 @@ import (
 	"github.com/slackapi/slack-cli/internal/config"
 	"github.com/slackapi/slack-cli/internal/deputil"
 	"github.com/slackapi/slack-cli/internal/hooks"
-	"github.com/slackapi/slack-cli/internal/pkg/version"
 	"github.com/slackapi/slack-cli/internal/shared"
 	"github.com/slackapi/slack-cli/internal/shared/types"
 	"github.com/slackapi/slack-cli/internal/slackcontext"
 	"github.com/slackapi/slack-cli/internal/slackdeps"
 	"github.com/slackapi/slack-cli/internal/slackerror"
+	"github.com/slackapi/slack-cli/internal/version"
 	"github.com/slackapi/slack-cli/test/slackmock"
 	"github.com/slackapi/slack-cli/test/testutil"
 	"github.com/stretchr/testify/assert"