Merge pull request #581 from CosmWasm/co/add-typo-check

Add typo check

Author: chipshort

.github/workflows/typo-check.yml

@@ -0,0 +1,19 @@
+name: Check for typos
+
+on:
+  merge_group:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  check-typos:
+    name: "Spell-check repository source"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Run spell-check
+        uses: crate-ci/typos@master

_typos.toml

@@ -0,0 +1,2 @@
+[default]
+extend-ignore-re = ["(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"]

builders/README.md

@@ -149,7 +149,7 @@ See those DockerHub repos for all available versions of the builder images.
 
 ## Usage
 
-Create the Docker images, capable of cross-compling Linux and MacOS dynamic
+Create the Docker images, capable of cross-compiling Linux and MacOS dynamic
 libs. As the builder images are all x86_64, it can be slow and memory intense to
 do this on a different architecture:
 

docs/COMPILER_VERSIONS.md

@@ -54,7 +54,7 @@ supported by cosmwasm-std/cosmwasm-vm.
 
 ## Tooling Rust compiler
 
-This Rust version is not related to our codebase directy. It's sufficiently
+This Rust version is not related to our codebase directly. It's sufficiently
 modern to install and execute tools like `cargo-audit`.
 
 ## Versions in use

docs/MIGRATING.md

@@ -64,8 +64,8 @@ where the old name was deprecated.
 | `SubcallResponse`                 | `SubMsgResponse`                      | Contracts do not "call" each other but send messages around  |
 | `HumanizeAddress`                 | `HumanizeAddressFunc`                 | Follow [best practice for naming function types][ft]         |
 | `CanonicalizeAddress`             | `CanonicalizeAddressFunc`             | Follow [best practice for naming function types][ft]         |
-| `GoAPI.HumanAddress`              | `GoAPI.HumanizeAddress`               | Perfer verbs for converters                                  |
-| `GoAPI.CanonicalAddress`          | `GoAPI.CanonicalizeAddress`           | Perfer verbs for converters                                  |
+| `GoAPI.HumanAddress`              | `GoAPI.HumanizeAddress`               | Prefer verbs for converters                                  |
+| `GoAPI.CanonicalAddress`          | `GoAPI.CanonicalizeAddress`           | Prefer verbs for converters                                  |
 | `CosmosMsg.Stargate`              | `CosmosMsg.Any`                       | The message has nothing to do with Stargate                  |
 | `StargateMsg`                     | `AnyMsg`                              | The message has nothing to do with Stargate                  |
 | `QueryResponse`                   | `QueryResult`                         | Brings consistency with the naming of the other results      |

internal/api/bindings.h

@@ -163,7 +163,7 @@ typedef struct ByteSliceView {
  * ```
  *
  *
- * If you want to mutate data, you need to comsume the vector and create a new one:
+ * If you want to mutate data, you need to consume the vector and create a new one:
  *
  * ```rust
  * # use wasmvm::{UnmanagedVector};
@@ -308,7 +308,7 @@ typedef struct GoIter {
   struct gas_meter_t *gas_meter;
   /**
    * A reference which identifies the iterator and allows finding and accessing the
-   * actual iterator instance in Go. Once fully initalized, this is immutable.
+   * actual iterator instance in Go. Once fully initialized, this is immutable.
    */
   struct IteratorReference reference;
   struct IteratorVtable vtable;

internal/api/memory_test.go

@@ -50,7 +50,7 @@ func TestCreateAndDestroyUnmanagedVector(t *testing.T) {
 		var original []byte
 		unmanaged := newUnmanagedVector(original)
 		require.Equal(t, cbool(true), unmanaged.is_none)
-		// We must not make assumtions on the other fields in this case
+		// We must not make assumptions on the other fields in this case
 		copy := copyAndDestroyUnmanagedVector(unmanaged)
 		require.Nil(t, copy)
 	}

internal/api/mocks.go

@@ -277,7 +277,7 @@ func (l *Lookup) WithGasMeter(meter MockGasMeter) *Lookup {
 	}
 }
 
-// Get wraps the underlying DB's Get method panicing on error.
+// Get wraps the underlying DB's Get method panicking on error.
 func (l Lookup) Get(key []byte) []byte {
 	l.meter.ConsumeGas(GetPrice, "get")
 	v, err := l.db.Get(key)
@@ -288,23 +288,23 @@ func (l Lookup) Get(key []byte) []byte {
 	return v
 }
 
-// Set wraps the underlying DB's Set method panicing on error.
+// Set wraps the underlying DB's Set method panicking on error.
 func (l Lookup) Set(key, value []byte) {
 	l.meter.ConsumeGas(SetPrice, "set")
 	if err := l.db.Set(key, value); err != nil {
 		panic(err)
 	}
 }
 
-// Delete wraps the underlying DB's Delete method panicing on error.
+// Delete wraps the underlying DB's Delete method panicking on error.
 func (l Lookup) Delete(key []byte) {
 	l.meter.ConsumeGas(RemovePrice, "remove")
 	if err := l.db.Delete(key); err != nil {
 		panic(err)
 	}
 }
 
-// Iterator wraps the underlying DB's Iterator method panicing on error.
+// Iterator wraps the underlying DB's Iterator method panicking on error.
 func (l Lookup) Iterator(start, end []byte) types.Iterator {
 	l.meter.ConsumeGas(RangePrice, "range")
 	iter, err := l.db.Iterator(start, end)
@@ -315,7 +315,7 @@ func (l Lookup) Iterator(start, end []byte) types.Iterator {
 	return iter
 }
 
-// ReverseIterator wraps the underlying DB's ReverseIterator method panicing on error.
+// ReverseIterator wraps the underlying DB's ReverseIterator method panicking on error.
 func (l Lookup) ReverseIterator(start, end []byte) types.Iterator {
 	l.meter.ConsumeGas(RangePrice, "range")
 	iter, err := l.db.ReverseIterator(start, end)

lib.go

@@ -40,7 +40,7 @@ func LibwasmvmVersion() (string, error) {
 
 // CreateChecksum performs the hashing of Wasm bytes to obtain the CosmWasm checksum.
 //
-// Ony Wasm blobs are allowed as inputs and a magic byte check will be performed
+// Only Wasm blobs are allowed as inputs and a magic byte check will be performed
 // to avoid accidental misusage.
 func CreateChecksum(wasm []byte) (Checksum, error) {
 	if len(wasm) == 0 {

libwasmvm/bindings.h

@@ -163,7 +163,7 @@ typedef struct ByteSliceView {
  * ```
  *
  *
- * If you want to mutate data, you need to comsume the vector and create a new one:
+ * If you want to mutate data, you need to consume the vector and create a new one:
  *
  * ```rust
  * # use wasmvm::{UnmanagedVector};
@@ -308,7 +308,7 @@ typedef struct GoIter {
   struct gas_meter_t *gas_meter;
   /**
    * A reference which identifies the iterator and allows finding and accessing the
-   * actual iterator instance in Go. Once fully initalized, this is immutable.
+   * actual iterator instance in Go. Once fully initialized, this is immutable.
    */
   struct IteratorReference reference;
   struct IteratorVtable vtable;