Skip to content

Commit

Permalink
a bunch of warning fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
chmouel committed Aug 24, 2023
1 parent 0b9f5a2 commit e7868ab
Show file tree
Hide file tree
Showing 22 changed files with 7 additions and 27 deletions.
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Abbreviations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/abbreviations/
message: "Do not use periods in all-uppercase abbreviations such as '%s'."
nonword: true
source: "IBM - Periods with abbreviations, p. 5"
tokens:
- '\b(?:[A-Z]\.){3,5}'
1 change: 0 additions & 1 deletion .vale/styles/RedHat/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: false
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/
message: Use '%s' rather than '%s'.
source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions"
action:
name: replace
swap:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Conjunctions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/conjunctions/
message: "Do not overuse beginning sentences with '%s'."
scope: paragraph
source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml
action:
name: remove
tokens:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/ConsciousLanguage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/consciouslanguage/
message: Use '%s' rather than '%s.'
source: "https://redhat-documentation.github.io/supplementary-style-guide/#conscious-language"
action:
name: replace
swap:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Contractions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/contractions/
message: "Avoid contractions. Use '%s' rather than '%s.'"
source: "https://redhat-documentation.github.io/supplementary-style-guide/#contractions"
action:
name: replace
swap:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Definitions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/definitions/
message: "Define acronyms and abbreviations (such as '%s') on first occurrence if they're likely to be unfamiliar."
source: "IBM - Abbreviations, p. 1"
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5}s?)\b'
second: '\(([A-Z]{3,5}s?)\)'
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Ellipses.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/ellipses/
message: "Avoid the ellipsis (...) except to indicate omitted words."
nonword: true
source: "IBM - Ellipses, p.49"
action:
name: remove
tokens:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/HeadingPunctuation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guid
message: "Do not use end punctuation in headings."
nonword: true
scope: heading
source: "IBM - Periods in headings and titles, p. 61"
action:
name: edit
params:
Expand Down
3 changes: 1 addition & 2 deletions .vale/styles/RedHat/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guid
match: $sentence
message: "Use sentence-style capitalization in '%s'."
scope: heading
source: "IBM - Capitalization in headings and titles, p.16"
indicators:
- ":"
exceptions:
Expand Down Expand Up @@ -173,4 +172,4 @@ exceptions:
- Yana
- Yeoman
- Zowe
- GitLab Code Quality
- GitLab Code Quality
1 change: 0 additions & 1 deletion .vale/styles/RedHat/OxfordComma.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ extends: existence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/oxfordcomma/
message: "Use the Oxford comma in '%s'."
source: "IBM - Commas between clauses, p.45"
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'
1 change: 0 additions & 1 deletion .vale/styles/RedHat/PassiveVoice.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/passivevoice/
message: "'%s' is passive voice. Consider rewording in active voice. You can use the passive voice in prerequisites"
source: "https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites; IBM - Voice, p.35"
raw:
- \b(am|are|were|being|is|been|was|be)\b\s*
tokens:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/ReleaseNotes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/releasenotes/
message: "For release notes, consider using '%s' rather than '%s'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes"
# swap maps tokens in form of bad: good
swap:
Now: With this update
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/SentenceLength.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/sentencelength/
message: "Try to keep sentences to an average of 32 words or fewer."
scope: sentence
source: "IBM - Conversational style"
max: 32
token: \b(\w+)\b
1 change: 0 additions & 1 deletion .vale/styles/RedHat/SimpleWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/simplewords/
message: "Use simple language. Consider using '%s' rather than '%s'."
source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm"
swap:
"approximate(?:ly)?": about
"objective(?! C?)": aim|goal
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Slash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/slash/
message: "Use either 'or' or 'and' in '%s'"
source: "IBM - Slashes, p. 68"
tokens:
- '\w+/\w+'
exceptions:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Spacing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spacing/
message: "Keep one space beween words in '%s'."
nonword: true
source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
tokens:
- "[a-z][.?!] {2,}[A-Z]"
- "[a-z][.?!][A-Z]"
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ extends: spelling
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spelling/
message: "Use correct American English spelling. Did you really mean '%s'?"
source: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spelling/
# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
# Spelling rule applies to individual words
filters:
Expand Down
2 changes: 0 additions & 2 deletions .vale/styles/RedHat/TermsErrors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termserrors/
message: "Use '%s' rather than '%s'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
# swap maps tokens in form of bad: good
Expand Down Expand Up @@ -215,7 +214,6 @@ swap:
on-premise: on-premises|off-premises|onsite|offsite
on-ramp: access method
op-code: opcode
open-source|OpenSource|opensource: open source
organise: organize
organised: organized
organising: organizing
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/TermsSuggestions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termssuggestions/
message: "Depending on the context, consider using '%s' rather than '%s'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
swap:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/TermsWarnings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termswarnings/
message: "Consider using '%s' rather than '%s' unless updating existing content that uses it."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
swap:
Expand Down
1 change: 0 additions & 1 deletion .vale/styles/RedHat/Usage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/usage/
message: "Verify your use of '%s' with the word usage guidelines."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
tokens:
- "pop-up (?:help|menu)"
- "redbook(:s)?"
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Gosmee is a versatile webhook relayer that can be conveniently executed anywhere

## Description

Gosmee enables you to relay webhooks from either itself (as a server) or from https://smee.io to your local notebook.
Gosmee enables you to relay webhooks from either itself (as a server) or from <https://smee.io> to your local notebook.

With gosmee, you can effortlessly expose the service on your local network or behind a VPN, allowing a public service (such as GitHub) to push webhooks to it.

For instance, if you configure your GitHub Webhook to direct to a https://smee.io/ URL or where gosmee server is listening, you can then use the gosmee client on your local notebook to obtain the events from the server and forward them to the local service, thereby establishing a connection between the GitHub webhook and your local service on your workstation.
For instance, if you configure your GitHub Webhook to direct to a <https://smee.io/> URL or where gosmee server is listening, you can then use the gosmee client on your local notebook to obtain the events from the server and forward them to the local service, thereby establishing a connection between the GitHub webhook and your local service on your workstation.

### Diagram

Expand Down Expand Up @@ -101,14 +101,16 @@ source <(gosmee completion zsh)
## Usage

### Client
If you intend to use https://smee.io, you might want to generate your own smee URL by visiting https://smee.io/new.

If you intend to use <https://smee.io>, you might want to generate your own smee URL by visiting <https://smee.io/new>.

Once you have it, the basic usage is as follows:

```shell
gosmee client https://smee.io/aBcDeF https://localhost:8080
```
This command will relay all payloads received at the smee URL to a service running on http://localhost:8080.

This command will relay all payloads received at the smee URL to a service running on <http://localhost:8080>.

Another option is to save all the relays as shell script that can be replayed without having to recreate the event:

Expand Down

0 comments on commit e7868ab

Please sign in to comment.