Merge pull request #2256 from CosmWasm/aw/typos-ci

Add typo check to the CI

Author: aumetra

.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

CHANGELOG-pre1.0.0.md

@@ -738,7 +738,7 @@ and this project adheres to
   with this change, the `backtraces` feature now requires Rust nightly.
 - Rename `StdError::ParseErr::source` to `StdError::ParseErr::source_type` and
   `StdError::SerializeErr::target` to `StdError::SerializeErr::target_type` to
-  work around speacial treatment of the field name `source` in thiserror.
+  work around special treatment of the field name `source` in thiserror.
 - Rename `Extern` to `Deps` to unify naming.
 - Simplify ownership of calling `handle`, etc. with `Deps` and `DepsMut` struct
   that just contains references (`DepsMut` has `&mut Storage` otherwise the
@@ -1259,7 +1259,7 @@ https://github.com/CosmWasm/cosmwasm/issues/451).
   for mock storage and copying a stateless bridge for the external storage,
   which are different semantics.
 - Remove public `cosmwasm::imports::dependencies`. A user of this library does
-  not need to call this explicitely. Dependencies are created internally and
+  not need to call this explicitly. Dependencies are created internally and
   passed as an argument in `exports::do_init`, `exports::do_handle` and
   `exports::do_query`.
 - Make `ExternalStorage` not `Clone`able anymore. This does not copy any data,

CHANGELOG.md

@@ -768,7 +768,7 @@ and this project adheres to
 - all: Bump a few dependency versions to make the codebase compile with
   `-Zminimal-versions` ([#1465]).
 - cosmwasm-profiler: Package was removed 🪦. It served its job showing us that
-  we cannot properly measure different runtimes for differet Wasm opcodes.
+  we cannot properly measure different runtimes for different Wasm opcodes.
 - cosmwasm-schema: schema generation is now locked to produce strictly
   `draft-07` schemas
 - cosmwasm-schema: `QueryResponses` derive now sets the `JsonSchema` trait bound

Cargo.toml

@@ -2,7 +2,7 @@
 members = ["packages/*"]
 exclude = ["contracts"]
 
-# Resolver has to be set explicitely in workspaces
+# Resolver has to be set explicitly in workspaces
 # due to https://github.com/rust-lang/cargo/issues/9956
 resolver = "2"
 

IBC.md

@@ -25,7 +25,7 @@ pub enum IbcMsg {
     /// We cannot select the port_id, this is whatever the local chain has bound the ibctransfer
     /// module to.
     Transfer {
-        /// exisiting channel to send the tokens over
+        /// existing channel to send the tokens over
         channel_id: String,
         /// address on the remote chain to receive these tokens
         to_address: String,
@@ -385,7 +385,7 @@ produced 3 suggestions on how to handle errors and rollbacks _inside
    `submessage` and capture the error. This approach requires we use _exactly
    one_ submessage. If we have multiple, we may commit #1 and rollback #2 (see
    example 3 for that case). The main point is moving `messages` to
-   `submessages` and reformating the error in `reply`. Note that if you set the
+   `submessages` and reformatting the error in `reply`. Note that if you set the
    `Response.data` field in `reply` it will override the acknowledgement
    returned from the parent call. (See
    [bottom of reply section](./SEMANTICS.md#handling-the-reply)). You can see a

MIGRATING.md

@@ -1342,7 +1342,7 @@ arbitrary ones.
 
 - The block time in `env.block.time` is now a `Timestamp` which stores
   nanosecond precision. `env.block.time_nanos` was removed. If you need the
-  compnents as before, use
+  components as before, use
   ```rust
   let seconds = env.block.time.nanos() / 1_000_000_000;
   let nsecs = env.block.time.nanos() % 1_000_000_000;
@@ -1456,7 +1456,7 @@ arbitrary ones.
 - Contracts now support any custom error type `E: ToString + From<StdError>`.
   Previously this has been `StdError`, which you can still use. However, you can
   now create a much more structured error experience for your unit tests that
-  handels exactly the error cases of your contract. In order to get a convenient
+  handles exactly the error cases of your contract. In order to get a convenient
   implementation for `ToString` and `From<StdError>`, we use the crate
   [thiserror](https://crates.io/crates/thiserror), which needs to be added to
   the contracts dependencies in `Cargo.toml`. To create the custom error, create
@@ -1492,8 +1492,8 @@ arbitrary ones.
   - `fn handle`: `Result<HandleResponse, MyCustomError>`,
   - `fn query`: `Result<Binary, MyCustomError>`.
 
-  If one of your funtions does not use the custom error, you can continue to use
-  `StdError` as before. I.e. you can have `handle` returning
+  If one of your functions does not use the custom error, you can continue to
+  use `StdError` as before. I.e. you can have `handle` returning
   `Result<HandleResponse, MyCustomError>` and `query` returning
   `StdResult<Binary>`.
 

_typos.toml

@@ -0,0 +1,10 @@
+[default]
+extend-ignore-re = [
+    "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+]
+
+[files]
+extend-exclude = [
+    "contracts/**/schema/**",
+    "packages/crypto/**/*.json",
+]

contracts/burner/tests/integration.rs

@@ -3,7 +3,7 @@
 //! Then running `cargo integration-test` will validate we can properly call into that generated Wasm.
 //!
 //! You can easily convert unit tests to integration tests.
-//! 1. First copy them over verbatum,
+//! 1. First copy them over verbatim,
 //! 2. Then change
 //!      let mut deps = mock_dependencies(20, &[]);
 //!    to

contracts/crypto-verify/src/webauthn.rs

@@ -20,7 +20,7 @@ pub fn verify(
     //
     // - the length of the encoded bytes being correct
     // - the point being an element of the curve
-    // - the conversion from the encoded coorinate to an affine point succeeding
+    // - the conversion from the encoded coordinate to an affine point succeeding
     // - the affine point actually being a valid public key
     // - the signature could actually exist like this for a secp256r1 ECDSA key
     //

contracts/cyberpunk/schema/cyberpunk.json

@@ -5,7 +5,7 @@
   "instantiate": {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "title": "InstantiateMsg",
-    "description": "An empty struct that serves as a placeholder in different places, such as contracts that don't set a custom message.\n\nIt is designed to be expressable in correct JSON and JSON Schema but contains no meaningful data. Previously we used enums without cases, but those cannot represented as valid JSON Schema (https://github.com/CosmWasm/cosmwasm/issues/451)",
+    "description": "An empty struct that serves as a placeholder in different places, such as contracts that don't set a custom message.\n\nIt is designed to be expressible in correct JSON and JSON Schema but contains no meaningful data. Previously we used enums without cases, but those cannot represented as valid JSON Schema (https://github.com/CosmWasm/cosmwasm/issues/451)",
     "type": "object",
     "additionalProperties": false
   },
@@ -498,7 +498,7 @@
           ],
           "properties": {
             "index": {
-              "description": "The position of this transaction in the block. The first transaction has index 0.\n\nThis allows you to get a unique transaction indentifier in this chain using the pair (`env.block.height`, `env.transaction.index`).",
+              "description": "The position of this transaction in the block. The first transaction has index 0.\n\nThis allows you to get a unique transaction identifier in this chain using the pair (`env.block.height`, `env.transaction.index`).",
               "type": "integer",
               "format": "uint32",
               "minimum": 0.0