Skip to content

chore: order alphabetical error codes and constants in reference #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zimeg wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chore: order alphabetical error codes and constants in reference #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a3db732
chore: sort slackerror constants and ErrorCodeMap alphabetically
zimeg Jun 2, 2026
f73c93e
fix: restore blank lines in ErrAppDeployNotSlackHosted remediation
zimeg Jun 2, 2026
a56fdef
fix: sort generated errors reference alphabetically by error code
zimeg Jun 2, 2026
1a9fe50
refactor: rename sortedErrors to errors
zimeg Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions cmd/docgen/docgen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func runDocGenCommandFunc(clients *shared.ClientFactory, cmd *cobra.Command, arg
return slackerror.New(slackerror.ErrDocumentationGenerationFailed).WithRootCause(err)
}

// Generate errors reference
// Generate errors reference sorted alphabetically by error code
file, err := clients.Fs.Create(filepath.Join(docsDirPath, "errors.md"))
if err != nil {
return err
Expand All @@ -118,7 +118,14 @@ func runDocGenCommandFunc(clients *shared.ClientFactory, cmd *cobra.Command, arg
if err != nil {
return err
}
err = tmpl.Execute(file, slackerror.ErrorCodeMap)
errors := make([]slackerror.Error, 0, len(slackerror.ErrorCodeMap))
for _, e := range slackerror.ErrorCodeMap {
errors = append(errors, e)
}
slices.SortFunc(errors, func(a, b slackerror.Error) int {
return strings.Compare(a.Code, b.Code)
})
err = tmpl.Execute(file, errors)
Comment on lines +121 to +128
Copy link
Copy Markdown
Contributor

@WilliamBergamin WilliamBergamin Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the errors are already sorted do we need this? Or are go Maps unordered?

if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/docgen/errors.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ones, as well as a list of the errors the Slack CLI may raise, what they mean,
and some ways to remediate them.

## Slack CLI errors list
{{range $key, $err := . }}
{{range $err := . }}
### {{ $err.Code }} {#{{ $err.Code }}}
{{ if $err.Message }}
**Message**: {{ $err.Message }}
Expand Down
Loading
Loading