Skip to content

Commit

Permalink
Fix: Typos (#44)
Browse files Browse the repository at this point in the history
* chore: fix typo in file name

interacive => interactive

* chore: fix wrong comments and names

also use the official names:
- bcrypt
- Base32
- Base64
- Base64 URL
- SHA-1
- SHA-256
- SHA-512
- macOS
- ...

* chore: fix Markdown fenced block identifiers

* chore: fix typos

* chore: fix invalid aliases for Morse decode

* chore: fix acronyms case
  • Loading branch information
ccoVeille authored May 29, 2024
1 parent 8c802d4 commit 5aea98a
Show file tree
Hide file tree
Showing 24 changed files with 190 additions and 166 deletions.
63 changes: 32 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

`sttr` is command line software that allows you to quickly run various transformation operations on the string.

```go
```shell
// With input prompt
sttr

Expand Down Expand Up @@ -40,20 +40,21 @@ sttr yaml-json file.yaml > file-output.json
You can run the below `curl` to install it somewhere in your PATH for easy use. Ideally it will be installed at `./bin`
folder

```sh
```shell
curl -sfL https://raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
```

#### Webi

**MacOS / Linux**
```
**macOS / Linux**

```shell
curl -sS https://webi.sh/sttr | sh
```

**Windows**

```
```shell
curl.exe https://webi.ms/sttr | powershell
```

Expand All @@ -63,20 +64,20 @@ See [here](https://webinstall.dev/sttr/)

If you are on macOS and using Homebrew, you can install `sttr` with the following:

```go
```shell
brew tap abhimanyu003/sttr
brew install sttr
```

#### Snap

```
```shell
sudo snap install sttr
```

#### Arch Linux

```
```shell
yay -S sttr-bin
```

Expand All @@ -89,7 +90,7 @@ scoop install sttr

#### Go

```go
```shell
go install github.com/abhimanyu003/sttr@latest
```

Expand All @@ -102,7 +103,7 @@ to the desired location.

* After installation simply run `sttr` command.

```go
```shell
// For interactive menu
sttr
// Provide your input
Expand All @@ -113,7 +114,7 @@ sttr
* Working with help.
```go
```shell
sttr -h

// Example
Expand All @@ -123,7 +124,7 @@ sttr md5 -h
* Working with files input.
```go
```shell
sttr {command-name} {filename}

sttr base64-encode image.jpg
Expand All @@ -133,19 +134,19 @@ sttr md-html Readme.md
* Writing output to file.
```go
```shell
sttr yaml-json file.yaml > file-output.json
```
* Taking input from other command.
```go
```shell
curl https: //jsonplaceholder.typicode.com/users | sttr json-yaml
```
* Chaining the different processor.
```go
```shell
sttr md5 hello | sttr base64-encode

echo "Hello World" | sttr base64-encode | sttr md5
Expand All @@ -155,16 +156,16 @@ echo "Hello World" | sttr base64-encode | sttr md5
#### Encode/Decode
- [x] **ascii85-encode** - Encode your text to ascii85
- [x] **ascii85-decode** - Decode your ascii85 text
- [x] **base32-decode** - Decode your base32 text
- [x] **base32-encode** - Encode your text to base32
- [x] **base64-decode** - Decode your base64 text
- [x] **base64-encode** - Encode your text to base64
- [x] **base85-encode** - Encode your text to base85
- [x] **base85-decode** - Decode your base85 text
- [x] **base64url-decode** - Decode your base64 url
- [x] **base64url-encode** - Encode your text to url
- [x] **ascii85-encode** - Encode your text to Ascii85
- [x] **ascii85-decode** - Decode your Ascii85 text
- [x] **base32-decode** - Decode your Base32 text
- [x] **base32-encode** - Encode your text to Base32
- [x] **base64-decode** - Decode your Base64 text
- [x] **base64-encode** - Encode your text to Base64
- [x] **base85-encode** - Encode your text to Base85
- [x] **base85-decode** - Decode your Base85 text
- [x] **base64url-decode** - Decode your Base64 URL
- [x] **base64url-encode** - Encode your text to URL
- [x] **html-decode** - Unescape your HTML
- [x] **html-encode** - Escape your HTML
- [x] **rot13-encode** - Encode your text to ROT13
Expand All @@ -173,7 +174,7 @@ echo "Hello World" | sttr base64-encode | sttr md5
#### Hash
- [x] **bcrypt** - Get the Bcrypt hash of your text
- [x] **bcrypt** - Get the bcrypt hash of your text
- [x] **md5** - Get the MD5 checksum of your text
- [x] **sha1** - Get the SHA1 checksum of your text
- [x] **sha256** - Get the SHA256 checksum of your text
Expand Down Expand Up @@ -236,7 +237,7 @@ echo "Hello World" | sttr base64-encode | sttr md5
- [x] **extract-emails** - Extract emails from given text
- [x] **extract-ip** - Extract IPv4 and IPv6 from your text
- [x] **extract-urls** - Extract URls your text ( we don't do ping check )
- [x] **extract-urls** - Extract URLs your text ( we don't do ping check )
#### Other
Expand All @@ -245,14 +246,14 @@ echo "Hello World" | sttr base64-encode | sttr md5
- [x] **interactive** - Use sttr in interactive mode
- [x] **version** - Print the version of sttr
- [x] **zeropad** - Pad a number with zeros
- [x] **and adding more....**
- [x] **and adding more...**
# Featured On
These are the few locations where `sttr` was highlighted, many thanks to all of you.
Please feel free to add any blogs/videos you may have made that discuss `sttr` to the list.
These are the few places where `sttr` got featured, many thanks to everyone.
If you have talked about `sttr` in your blog/video feel to add that to the list.
* [Youtube: The Giants of Open Source - DevOps Paradox](https://youtu.be/4nFRKbY_HVE?t=2529?ref=abhimanyu003/sttr)
* [YouTube: The Giants of Open Source - DevOps Paradox](https://youtu.be/4nFRKbY_HVE?t=2529?ref=abhimanyu003/sttr)
* [Terminal Trove - Tool of the Week](https://terminaltrove.com/sttr/?ref=abhimanyu003/sttr)
* [nixCraft](https://www.cyberciti.biz/open-source/sttr-awesome-linux-unix-command-tool-for-transformation-string/?ref=abhimanyu003/sttr)
Expand Down
File renamed without changes.
36 changes: 18 additions & 18 deletions hugo/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

`sttr` is command line software that allows you to quickly run various transformation operations on the string.

```go
```shell
// With input prompt
sttr

Expand Down Expand Up @@ -35,22 +35,22 @@ sttr yaml-json file.yaml > file-output.json
You can run the below `curl` to install it somewhere in your PATH for easy use.
Ideally it will be installed at `./bin` folder

```go
```shell
curl -sfL https://raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
```

#### Homebrew

If you are on macOS and using Homebrew, you can install `sttr` with the following:

```go
```shell
brew tap abhimanyu003/sttr
brew install sttr
```

#### Go
#### Go

```go
```shell
go install github.com/abhimanyu003/sttr@latest
```

Expand All @@ -62,9 +62,9 @@ Download the pre-compiled binaries from the [Release!](https://github.com/abhima

* After installation simply run `sttr` command.

```go
```shell
// For interactive menu
sttr
sttr
// Provide your input
// Press two enter to open operation menu
// Press `/` to filter various operations.
Expand All @@ -73,7 +73,7 @@ sttr
* Working with help.
```go
```shell
sttr -h

// Example
Expand All @@ -83,7 +83,7 @@ sttr md5 -h
* Working with files input.
```go
```shell
sttr {command-name} {filename}

sttr base64-encode image.jpg
Expand All @@ -93,19 +93,19 @@ sttr md-html Readme.md
* Writing output to file.
```go
```shell
sttr yaml-json file.yaml > file-output.json
```
* Taking input from other command.
```go
```shell
curl https://jsonplaceholder.typicode.com/users | sttr json-yaml
```
* Chaining the different processor.
```go
```shell
sttr md5 hello | sttr base64-encode

echo "Hello World" | sttr base64-encode | sttr md5
Expand All @@ -114,11 +114,11 @@ echo "Hello World" | sttr base64-encode | sttr md5
# 💥 Supported Operations
* [sttr base32-decode]({{< relref "sttr_base32-decode.md" >}}) - Decode your base32 text
* [sttr base32-decode]({{< relref "sttr_base32-decode.md" >}}) - Decode your Base32 text
* [sttr base32-encode]({{< relref "sttr_base32-encode.md" >}}) - Encode your text to Base32
* [sttr base64-decode]({{< relref "sttr_base64-decode.md" >}}) - Decode your base64 text
* [sttr base64-decode]({{< relref "sttr_base64-decode.md" >}}) - Decode your Base64 text
* [sttr base64-encode]({{< relref "sttr_base64-encode.md" >}}) - Encode your text to Base64
* [sttr bcrypt]({{< relref "sttr_bcrypt.md" >}}) - Get the Bcrypt hash of your text
* [sttr bcrypt]({{< relref "sttr_bcrypt.md" >}}) - Get the bcrypt hash of your text
* [sttr camel]({{< relref "sttr_camel.md" >}}) - Transform your text to CamelCase
* [sttr completion]({{< relref "sttr_completion.md" >}}) - generate the autocompletion script for the specified shell
* [sttr count-chars]({{< relref "sttr_count-chars.md" >}}) - Find the length of your text (including spaces)
Expand All @@ -138,9 +138,9 @@ echo "Hello World" | sttr base64-encode | sttr md5
* [sttr md5]({{< relref "sttr_md5.md" >}}) - Get the MD5 checksum of your text
* [sttr reverse]({{< relref "sttr_reverse.md" >}}) - Reverse Text ( txeT esreveR )
* [sttr rot13-encode]({{< relref "sttr_rot13-encode.md" >}}) - Encode your text to ROT13
* [sttr sha1]({{< relref "sttr_sha1.md" >}}) - Get the SHA1 checksum of your text
* [sttr sha256]({{< relref "sttr_sha256.md" >}}) - Get the SHA256 checksum of your text
* [sttr sha512]({{< relref "sttr_sha512.md" >}}) - Get the SHA512 checksum of your text
* [sttr sha1]({{< relref "sttr_sha1.md" >}}) - Get the SHA-1 checksum of your text
* [sttr sha256]({{< relref "sttr_sha256.md" >}}) - Get the SHA-256 checksum of your text
* [sttr sha512]({{< relref "sttr_sha512.md" >}}) - Get the SHA-512 checksum of your text
* [sttr slug]({{< relref "sttr_slug.md" >}}) - Transform your text to slug-case
* [sttr snake]({{< relref "sttr_snake.md" >}}) - Transform your text to snake_case
* [sttr sort-lines]({{< relref "sttr_sort-lines.md" >}}) - Sort lines alphabetically
Expand Down
14 changes: 7 additions & 7 deletions hugo/content/cli/sttr.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sttr is a fast and flexible string/text converter

### Synopsis

sttr is a command line tool that allows you to quickly apply various
sttr is a command line tool that allows you to quickly apply various
transformation operations on the input text.

Complete documentation is available at https://github.com/abhimanyu003/sttr
Expand All @@ -24,11 +24,11 @@ sttr [flags]

### SEE ALSO

* [sttr base32-decode]({{< relref "sttr_base32-decode.md" >}}) - Decode your base32 text
* [sttr base32-decode]({{< relref "sttr_base32-decode.md" >}}) - Decode your Base32 text
* [sttr base32-encode]({{< relref "sttr_base32-encode.md" >}}) - Encode your text to Base32
* [sttr base64-decode]({{< relref "sttr_base64-decode.md" >}}) - Decode your base64 text
* [sttr base64-decode]({{< relref "sttr_base64-decode.md" >}}) - Decode your Base64 text
* [sttr base64-encode]({{< relref "sttr_base64-encode.md" >}}) - Encode your text to Base64
* [sttr bcrypt]({{< relref "sttr_bcrypt.md" >}}) - Get the Bcrypt hash of your text
* [sttr bcrypt]({{< relref "sttr_bcrypt.md" >}}) - Get the bcrypt hash of your text
* [sttr camel]({{< relref "sttr_camel.md" >}}) - Transform your text to CamelCase
* [sttr completion]({{< relref "sttr_completion.md" >}}) - generate the autocompletion script for the specified shell
* [sttr count-chars]({{< relref "sttr_count-chars.md" >}}) - Find the length of your text (including spaces)
Expand All @@ -48,9 +48,9 @@ sttr [flags]
* [sttr md5]({{< relref "sttr_md5.md" >}}) - Get the MD5 checksum of your text
* [sttr reverse]({{< relref "sttr_reverse.md" >}}) - Reverse Text ( txeT esreveR )
* [sttr rot13-encode]({{< relref "sttr_rot13-encode.md" >}}) - Encode your text to ROT13
* [sttr sha1]({{< relref "sttr_sha1.md" >}}) - Get the SHA1 checksum of your text
* [sttr sha256]({{< relref "sttr_sha256.md" >}}) - Get the SHA256 checksum of your text
* [sttr sha512]({{< relref "sttr_sha512.md" >}}) - Get the SHA512 checksum of your text
* [sttr sha1]({{< relref "sttr_sha1.md" >}}) - Get the SHA-1 checksum of your text
* [sttr sha256]({{< relref "sttr_sha256.md" >}}) - Get the SHA-256 checksum of your text
* [sttr sha512]({{< relref "sttr_sha512.md" >}}) - Get the SHA-512 checksum of your text
* [sttr slug]({{< relref "sttr_slug.md" >}}) - Transform your text to slug-case
* [sttr snake]({{< relref "sttr_snake.md" >}}) - Transform your text to snake_case
* [sttr sort-lines]({{< relref "sttr_sort-lines.md" >}}) - Sort lines alphabetically
Expand Down
4 changes: 2 additions & 2 deletions processors/ascii85.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"io"
)

// ASCII85Encoding encode string to base64.
// ASCII85Encoding encodes plain text to Ascii85 (aka Base85)
type ASCII85Encoding struct{}

func (p ASCII85Encoding) Name() string {
Expand Down Expand Up @@ -49,7 +49,7 @@ func (p ASCII85Encoding) FilterValue() string {
return p.Title()
}

// ASCII85Decoding encode string to Ascii aka base85.
// ASCII85Decoding decodes Ascii85 (aka Base85) to plain text.
type ASCII85Decoding struct{}

func (p ASCII85Decoding) Name() string {
Expand Down
4 changes: 2 additions & 2 deletions processors/base32.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"fmt"
)

// Base32Encoding encode string to base64.
// Base32Encoding encodes plain text to Base32 string.
type Base32Encoding struct{}

func (p Base32Encoding) Name() string {
Expand Down Expand Up @@ -37,7 +37,7 @@ func (p Base32Encoding) FilterValue() string {
return p.Title()
}

// Base32Decode decode string from base64 to plain text.
// Base32Decode decodes string from Base32 string to plain text.
type Base32Decode struct{}

func (p Base32Decode) Name() string {
Expand Down
6 changes: 3 additions & 3 deletions processors/base64.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func checkBase64RawFlag(f []Flag) bool {
return raw
}

// Base64Encode encode string to base64.
// Base64Encode encodes plain text to Base64 string.
type Base64Encode struct{}

func (p Base64Encode) Name() string {
Expand Down Expand Up @@ -61,7 +61,7 @@ func (p Base64Encode) FilterValue() string {
return p.Title()
}

// Base64Decode decode string from base64 to plain text.
// Base64Decode decodes string from Base64 string to plain text.
type Base64Decode struct{}

func (p Base64Decode) Name() string {
Expand Down Expand Up @@ -93,7 +93,7 @@ func (p Base64Decode) Title() string {
}

func (p Base64Decode) Description() string {
return "Decode your base64 text"
return "Decode your Base64 text"
}

func (p Base64Decode) FilterValue() string {
Expand Down
Loading

0 comments on commit 5aea98a

Please sign in to comment.