Skip to content

Commit d8f8ac6

Browse files
authored
feat: add CI for codespell (#255)
* feat: add CI for codespell * feat: fix spells * feat: add excluded files * feat: fix typos
1 parent 378a2b3 commit d8f8ac6

File tree

50 files changed

+152
-124
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+152
-124
lines changed

.github/workflows/codespell.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
- master
9+
10+
jobs:
11+
spellcheck:
12+
name: Run codespell
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: "3.x"
23+
24+
- name: Install codespell
25+
run: pip install codespell
26+
27+
- name: Run codespell
28+
run: codespell --skip="yarn.lock,package-lock.json,node_modules,build"

docs/beaker/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,10 @@ To create the contract entrypoint for migration, first, define `MigrateMsg` in `
225225
pub struct MigrateMsg {}
226226
```
227227

228-
With MigrateMsg defined we need to update `contract.rs`. First update the import from `crate::msg` to include `MigrateMsg`:
228+
With MigrateMsg defined we need to update `contract.rs`. First update the import from `create::msg` to include `MigrateMsg`:
229229

230230
```rust
231-
use crate::msg::{CountResponse, ExecuteMsg, InstantiateMsg, QueryMsg, MigrateMsg};
231+
use create::msg::{CountResponse, ExecuteMsg, InstantiateMsg, QueryMsg, MigrateMsg};
232232
```
233233

234234
```rust
@@ -340,7 +340,7 @@ await contract.counter.signer(account.test1).execute({ increment: {} });
340340
await contract.counter.query({ get_count: {} });
341341
```
342342

343-
You can find avaialable methods for the aforementioned instances here:
343+
You can find available methods for the aforementioned instances here:
344344

345345
- [Account](console/classes//Account.md#methods-1)
346346
- [Contract](./console/classes//Contract.md#methods-1)

docs/beaker/commands/beaker_wasm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Arguments:
218218

219219
* ` <contract-name>`Name of the contract to instantiate
220220

221-
* `-l/--label <label>`: Label for the instantiated contract for selcting migration target (default: `default`)
221+
* `-l/--label <label>`: Label for the instantiated contract for selecting migration target (default: `default`)
222222

223223
* `-r/--raw <raw>`: Raw json string to use as instantiate msg
224224

docs/beaker/commands/beaker_wasm_proposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Arguments:
2626

2727
* `--title <title>`: Proposal title (default: ``)
2828

29-
* `--description <description>`: Proposal decsription (default: ``)
29+
* `--description <description>`: Proposal description (default: ``)
3030

3131
* `--deposit <deposit>`: Proposal deposit to activate voting
3232

docs/beaker/config/global.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* **`gas_adjustment`** : f64
2222

2323
>
24-
> Adjusting `gas_limit` from simulated gas as a safety factor to make sure gas_limit is enought for the tx.
24+
> Adjusting `gas_limit` from simulated gas as a safety factor to make sure gas_limit is enough for the tx.
2525
> When user doesn't specify `gas_limit`, `gas_limit = simulated_gas * gas_adjustment`,
2626
> while `simulated_gas` is simulated gas consumption for the tx.
2727
>

docs/beaker/config/workspace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* **`branch`** : String
3030

3131
>
32-
> Brance of the repo to be used as template
32+
> Branch of the repo to be used as template
3333
>
3434
3535

docs/cosmwasm/cw-orch.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ let count = counter.get_count()?;
2020
assert_eq!(count.count, 1);
2121
```
2222

23-
In this quick-start guide, we will review the necessary steps in order to integrate [`cw-orch`](https://github.com/AbstractSDK/cw-orchestrator) into a simple contract crate. [We review integration of rust-workspaces (multiple contracts) at the end of this page](#integration-in-a-workspace).
23+
In this quick-start guide, we will review the necessary steps in order to integrate [`cw-orch`](https://github.com/AbstractSDK/cw-orchestrator) into a simple contract create. [We review integration of rust-workspaces (multiple contracts) at the end of this page](#integration-in-a-workspace).
2424

2525
> **NOTE**: *Quicker than the quick start*
2626
>
@@ -40,7 +40,7 @@ In this quick-start guide, we will review the necessary steps in order to integr
4040
- [Using the integration](#using-the-integration)
4141
- [Integration in a workspace](#integration-in-a-workspace)
4242
- [Handling dependencies and features](#handling-dependencies-and-features)
43-
- [Creating an interface crate](#creating-an-interface-crate)
43+
- [Creating an interface create](#creating-an-interface-create)
4444
- [Integrating single contracts](#integrating-single-contracts)
4545
- [More examples and scripts](#more-examples-and-scripts)
4646

@@ -93,7 +93,7 @@ Then, inside that `interface.rs` file, you can define the interface for your con
9393
```rust
9494
use cw_orch::{interface, prelude::*};
9595

96-
use crate::msg::{ExecuteMsg, InstantiateMsg, MigrateMsg, QueryMsg};
96+
use create::msg::{ExecuteMsg, InstantiateMsg, MigrateMsg, QueryMsg};
9797

9898
pub const CONTRACT_ID: &str = "counter_contract";
9999

@@ -111,11 +111,11 @@ impl<Chain: CwEnv> Uploadable for CounterContract<Chain> {
111111
fn wrapper(&self) -> Box<dyn MockContract<Empty>> {
112112
Box::new(
113113
ContractWrapper::new_with_empty(
114-
crate::contract::execute,
115-
crate::contract::instantiate,
116-
crate::contract::query,
114+
create::contract::execute,
115+
create::contract::instantiate,
116+
create::contract::query,
117117
)
118-
.with_migrate(crate::contract::migrate),
118+
.with_migrate(create::contract::migrate),
119119
)
120120
}
121121
}
@@ -128,7 +128,7 @@ Learn more about the content of the interface creation specifics in the [`cw-orc
128128
>
129129
> ```rust
130130
> #[cfg(feature = "interface")]
131-
> pub use crate::interface::CounterContract;
131+
> pub use create::interface::CounterContract;
132132
> ```
133133
134134
### Interaction helpers
@@ -176,14 +176,14 @@ Find out more about the interaction helpers in the [`cw-orch` documentation](htt
176176
>
177177
> ```rust
178178
> #[cfg(feature = "interface")]
179-
> pub use crate::msg::{ExecuteMsgFns as CounterExecuteMsgFns, QueryMsgFns as CounterQueryMsgFns};
179+
> pub use create::msg::{ExecuteMsgFns as CounterExecuteMsgFns, QueryMsgFns as CounterQueryMsgFns};
180180
> ```
181181
182182
### Using the integration
183183
184184
Now that all the setup is done, you can use your contract in tests, integration-tests or scripts.
185185
186-
Start by importing your crate, with the `interface` feature enabled. Depending on your use-case this will be in `[dependencies]` or `[dev-dependencies]`:
186+
Start by importing your create, with the `interface` feature enabled. Depending on your use-case this will be in `[dependencies]` or `[dev-dependencies]`:
187187
188188
```toml
189189
counter-contract = { path = "../counter-contract", features = ["interface"] }
@@ -244,9 +244,9 @@ Refer above to [Adding `cw-orch` to your `Cargo.toml` file](#adding-cw-orch-to-y
244244

245245
For instance, for the `cw20_base` contract, you need to execute those 2 steps on the `cw20-base` contract (where the `QueryMsg` are defined) as well as on the `cw20` package (where the `ExecuteMsg` are defined).
246246

247-
### Creating an interface crate
247+
### Creating an interface create
248248

249-
When using a workspace, we advise you to create a new crate inside your workspace for defining your contract's interfaces. In order to do that, use:
249+
When using a workspace, we advise you to create a new create inside your workspace for defining your contract's interfaces. In order to do that, use:
250250

251251
```shell
252252
cargo new interface --lib
@@ -260,7 +260,7 @@ Add the interface package to your workspace `Cargo.toml` file
260260
members = ["packages/*", "contracts/*", "interface"]
261261
```
262262

263-
Inside this `interface` crate, we advise to integrate all your contracts 1 by 1 in separate files. Here is the structure of the `cw-plus` integration for reference:
263+
Inside this `interface` create, we advise to integrate all your contracts 1 by 1 in separate files. Here is the structure of the `cw-plus` integration for reference:
264264

265265
```path
266266
interface (interface collection)

docs/cosmwasm/javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Create a new index.ts file
3232
touch index.ts
3333
```
3434

35-
The class CosmWasmClient is exported from the CosmJS package @cosmjs/cosmwasm-stargate. Learn more in the [offical docs](https://cosmwasm.github.io/CosmWasmJS/clients/reading/CosmWasmClient.html).
35+
The class CosmWasmClient is exported from the CosmJS package @cosmjs/cosmwasm-stargate. Learn more in the [official docs](https://cosmwasm.github.io/CosmWasmJS/clients/reading/CosmWasmClient.html).
3636

3737
```javascript=
3838
import { CosmWasmClient } from "cosmwasm";

docs/cosmwasm/local/submit-wasm-proposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ CONTRACT=cw20_base
4242
```
4343

4444
## Define proposal ID
45-
We cannot really do this progamatically. Proposal `1` will come out after submitting it for the first time on a new chain. You can always update this manually when testing multiple times on the same state.
45+
We cannot really do this programmatically. Proposal `1` will come out after submitting it for the first time on a new chain. You can always update this manually when testing multiple times on the same state.
4646

4747
```
4848
PROPOSAL=1

docs/cosmwasm/testnet/cosmwasm-beaker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ beaker wasm new counter
4141
```
4242

4343
### Deploy contract on permisionless network
44-
The testnet is permisionless by default in order to allow developers to easyly deploy contracts.
44+
The testnet is permisionless by default in order to allow developers to easily deploy contracts.
4545

4646
```sh
4747
beaker wasm deploy counter --signer-account test1 --network testnet --no-wasm-opt --raw '{ "count": 0 }' --label 'My first Beaker Contract'
@@ -53,7 +53,7 @@ Note how we added `--network testnet` to tell beaker to deploy to the testnet Os
5353
In this example we are using `osmo1nyphwl8p5yx6fxzevjwqunsfqpcxukmtk8t60m` which is the address from the beaker test1 account as seen in the [config.rs](https://github.com/osmosis-labs/beaker/blob/main/packages/cli/src/framework/config.rs) file.
5454

5555
:::warning
56-
Please note that account test1 is publicaly available as documented [here](https://github.com/osmosis-labs/beaker/blob/main/docs/config/global.md) and only used for development purposes. Beaker will support local keyring in about 1-2 weeks.
56+
Please note that account test1 is publicly available as documented [here](https://github.com/osmosis-labs/beaker/blob/main/docs/config/global.md) and only used for development purposes. Beaker will support local keyring in about 1-2 weeks.
5757
:::
5858

5959
```
@@ -149,7 +149,7 @@ Run the following command to vote from beaker
149149
beaker wasm proposal vote --option yes counter --signer-account test1 --network testnet
150150
```
151151

152-
Even though the testnet is configured as permisionless, it's important to undertanding the voting process. We need validators to vote for your proposal in order to reach the quorum. We created a simple utility in our faucet that will allow you to request a validator with enough voting power to vote for your proposal as well.
152+
Even though the testnet is configured as permisionless, it's important to understanding the voting process. We need validators to vote for your proposal in order to reach the quorum. We created a simple utility in our faucet that will allow you to request a validator with enough voting power to vote for your proposal as well.
153153

154154
Please visit:
155155

0 commit comments

Comments
 (0)