Skip to content

ci: detect misspellings using typos-cli during tests #51

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

Closed
zimeg wants to merge 5 commits into from
Closed

ci: detect misspellings using typos-cli during tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f54cae
ci: detect misspellings using typos-cli during tests
zimeg Apr 18, 2025
09db64f
style: include a name for the health score workflow jobs
zimeg Apr 18, 2025
5b49077
fix: rearrange letters or change wording for spell checkings
zimeg Apr 18, 2025
656afdf
build: include a typos configuration file with default values
zimeg Apr 18, 2025
434fb79
chore: include a license comment header in configuration file
zimeg Apr 18, 2025
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
3 changes: 3 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ jobs:

# Monitor code coverage and TODO/FIXME-type comments
health-score:
name: Health score
needs: lint-test
runs-on: macos-latest
steps:
Expand All @@ -55,6 +56,8 @@ jobs:
uses: actions/[email protected]
with:
go-version: "1.24.2"
- name: Check spelling
uses: crate-ci/[email protected]
- name: Report health score
uses: slackapi/[email protected]
with:
Expand Down
20 changes: 20 additions & 0 deletions .typos.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2022-2025 Salesforce, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

[default]
extend-ignore-identifiers-re = [
"alle",
"groupe",
Comment on lines +17 to +18
Copy link
Member Author

@zimeg zimeg Apr 18, 2025

Choose a reason for hiding this comment

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

These are reserved constants not found in the included wordbanks:

slack-cli/internal/pkg/create/constants.go

Lines 210 to 225 in f3ba824

var reserved = []string{
"alle",
"allgemein",
"aquí",
"canais",
"canal",
"channel",
"chaîne",
"conversation",
"eu",
"everyone",
"false",
"general",
"geral",
"group",
"groupe",

"UE1",
Copy link
Member Author

@zimeg zimeg Apr 18, 2025

Choose a reason for hiding this comment

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

This pattern appears as a testing placeholder sometimes!

slack-cli/internal/prompts/app_select_test.go

Line 4042 in f3ba824

const enterprise1UserID = "UE1"

]
2 changes: 1 addition & 1 deletion cmd/auth/login.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func NewLoginCommand(clients *shared.ClientFactory) *cobra.Command {
Example: style.ExampleCommandsf([]style.ExampleCommand{
{Command: "auth login", Meaning: "Login to a Slack account with prompts"},
{Command: "auth login --no-prompt", Meaning: "Login to a Slack account without prompts, this returns a ticket"},
{Command: "auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...", Meaning: "Complete login using ticket and challenge code"},
{Command: "auth login --challenge 6d0a31c9 --ticket ISQWLiZT0tOMLO3YWNTJO0...", Meaning: "Complete login using ticket and challenge code"},
Copy link
Member Author

@zimeg zimeg Apr 18, 2025

Choose a reason for hiding this comment

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

The diff is not so clear, but "Ot" was replaced with "tO" to avoid unexpected identifiers found. It also reads more like "token" which is neat 🎉

{Command: "auth login --token xoxp-...", Meaning: "Login with a user token"},
}),
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
2 changes: 1 addition & 1 deletion cmd/auth/token.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func NewTokenCommand(clients *shared.ClientFactory) *cobra.Command {
Example: style.ExampleCommandsf([]style.ExampleCommand{
{Command: "auth token", Meaning: "Create a service token with prompts"},
{Command: "auth token --no-prompt", Meaning: "Gather a service token without prompts, this returns a ticket"},
{Command: "auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...", Meaning: "Complete authentication using a ticket and challenge code"},
{Command: "auth token --challenge 6d0a31c9 --ticket ISQWLiZT0tOMLO3YWNTJO0...", Meaning: "Complete authentication using a ticket and challenge code"},
}),
RunE: func(cmd *cobra.Command, args []string) error {
serviceTokenFlag = true
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_auth_login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ slack auth login
$ slack auth login --no-prompt

# Complete login using ticket and challenge code
$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...
$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0tOMLO3YWNTJO0...

# Login with a user token
$ slack auth login --token xoxp-...
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_auth_token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ slack auth token
$ slack auth token --no-prompt

# Complete authentication using a ticket and challenge code
$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...
$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0tOMLO3YWNTJO0...
```

### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ slack auth login
$ slack auth login --no-prompt

# Complete login using ticket and challenge code
$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...
$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0tOMLO3YWNTJO0...

# Login with a user token
$ slack auth login --token xoxp-...
Expand Down
2 changes: 1 addition & 1 deletion internal/goutils/strings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ func AddLogWhenValExist(title string, val string) string {
return ""
}

// UpperCaseTrimAll returns a formatted named_entites for trigger ACLs
// UpperCaseTrimAll returns a formatted named_entities for trigger ACLs
func UpperCaseTrimAll(namedEntities string) string {
return strings.ReplaceAll(strings.ToUpper(namedEntities), " ", "")
}
Expand Down
2 changes: 1 addition & 1 deletion internal/iostreams/writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"github.com/slackapi/slack-cli/internal/style"
)

// Writer contains implementions of io.Writer that log and output provided input
// Writer contains implementations of io.Writer to log and output provided input
//
// Used over Printer when the Write method is needed while still wanting to have
// outputs formatted and directed to the matching stream
Expand Down
Loading