Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add spellchecker #303

Merged
merged 4 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/config/.codespellignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
cips
pullrequest
keypair
pastTime
hasTables
Nam
EyT
upTo
initia
minitia
28 changes: 28 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Spell Check

on:
pull_request:

jobs:
spellcheck:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Run codespell
continue-on-error: true
run: |
sudo apt-get install codespell -y
codespell -w --skip="*.pulsar.go,*.pb.go,*.pb.gw.go,*.cosmos_orm.go,*.json,*.git,*.js,crypto/keys,fuzz,*.h,proto/tendermint,*.bin,go.sum,go.mod,statik.go,*.map" --ignore-words=.github/config/.codespellignore
- uses: peter-evans/[email protected]
if: github.event_name != 'pull_request'
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "chore: fix typos"
title: "chore: fix typos"
branch: "chore/fix-typos"
delete-branch: true
body: |
This PR fixes typos in the codebase.
Please review it, and merge if everything is fine.
If there are proto changes, run `make proto-gen` and commit the changes.
2 changes: 1 addition & 1 deletion api/initia/distribution/v1/genesis.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/initia/gov/v1/genesis.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/initia/ibchooks/v1/genesis.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions api/initia/move/v1/query_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions api/initia/move/v1/types.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/initia/mstaking/v1/genesis.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/initia/mstaking/v1/staking.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/initia/reward/v1/genesis.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion app/upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func (app *InitiaApp) RegisterUpgradeHandlers(cfg module.Configurator) {
return nil, err
}

// 2. update vm data with new seperator and add checksums of each module
// 2. update vm data with new separator and add checksums of each module

// Previous:
// ModuleSeparator = byte(0)
Expand Down
2 changes: 1 addition & 1 deletion client/docs/statik/statik.go

Large diffs are not rendered by default.

38 changes: 21 additions & 17 deletions client/docs/swagger-ui/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44811,7 +44811,7 @@ paths:
type: string
format: uint64
title: >-
unbonding id, uniquely identifing an unbonding of this
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total
Expand Down Expand Up @@ -45477,7 +45477,7 @@ paths:
type: string
format: uint64
title: >-
unbonding id, uniquely identifing an unbonding of this
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total amount
Expand Down Expand Up @@ -46588,7 +46588,7 @@ paths:
type: string
format: uint64
title: >-
unbonding id, uniquely identifing an unbonding of this
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total
Expand Down Expand Up @@ -47252,7 +47252,7 @@ paths:
type: string
format: uint64
title: >-
unbonding id, uniquely identifing an unbonding of this
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total amount
Expand Down Expand Up @@ -51316,7 +51316,7 @@ paths:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for
existing resources, no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down Expand Up @@ -51462,7 +51462,7 @@ paths:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for
existing resources, no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down Expand Up @@ -52473,7 +52473,7 @@ paths:
/initia/move/v1/view/json:
post:
summary: >-
ViewJSON execute view function with json arguemtns and return the view
ViewJSON execute view function with json arguments and return the view
result
operationId: ViewJSON
responses:
Expand Down Expand Up @@ -52560,7 +52560,7 @@ paths:
/initia/move/v1/view/json/batch:
post:
summary: >-
ViewJSONBatch execute multiple view functions with json arguemtns and
ViewJSONBatch execute multiple view functions with json arguments and
return the view results
operationId: ViewJSONBatch
responses:
Expand Down Expand Up @@ -83211,7 +83211,7 @@ definitions:
unbonding_id:
type: string
format: uint64
title: unbonding id, uniquely identifing an unbonding of this validator
title: unbonding id, uniquely identifying an unbonding of this validator
description: >-
Validator defines a validator, together with the total amount of the

Expand Down Expand Up @@ -83572,7 +83572,9 @@ definitions:
unbonding_id:
type: string
format: uint64
title: unbonding id, uniquely identifing an unbonding of this validator
title: >-
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total amount of the

Expand Down Expand Up @@ -84461,7 +84463,7 @@ definitions:
unbonding_id:
type: string
format: uint64
title: unbonding id, uniquely identifing an unbonding of this validator
title: unbonding id, uniquely identifying an unbonding of this validator
description: >-
Validator defines a validator, together with the total amount of the

Expand Down Expand Up @@ -84932,7 +84934,9 @@ definitions:
unbonding_id:
type: string
format: uint64
title: unbonding id, uniquely identifing an unbonding of this validator
title: >-
unbonding id, uniquely identifying an unbonding of this
validator
description: >-
Validator defines a validator, together with the total amount of the

Expand Down Expand Up @@ -85858,7 +85862,7 @@ definitions:
unbonding_id:
type: string
format: uint64
title: unbonding id, uniquely identifing an unbonding of this validator
title: unbonding id, uniquely identifying an unbonding of this validator
description: >-
Validator defines a validator, together with the total amount of the

Expand Down Expand Up @@ -87591,7 +87595,7 @@ definitions:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for existing
resources, no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down Expand Up @@ -87709,7 +87713,7 @@ definitions:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for existing
resources, no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down Expand Up @@ -87745,7 +87749,7 @@ definitions:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for existing
resources, no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down Expand Up @@ -88244,7 +88248,7 @@ definitions:
UpgradePolicy is the policy for upgrading a move module.

- UNSPECIFIED: UNSPECIFIED: a placeholder for an unspecified upgrade policy.
- COMPATIBLE: COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
- COMPATIBLE: COMPATIBLE: Whether a compatibility check should be performed for upgrades. The check only passes if
a new module has (a) the same public functions (b) for existing resources,
no layout change.
- IMMUTABLE: IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
Expand Down
2 changes: 1 addition & 1 deletion cmd/move/move.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const (
flagReportStatistics = "statistics"
flagReportStatisticsShorthand = "s"
flagReportStorageOnError = "state-on-error" // original move cli uses snake case, not kebab.
flagIgnoreCompileWarnings = "ignore-compile-warnings" // original move cli uses snake case, noe kebab.
flagIgnoreCompileWarnings = "ignore-compile-warnings" // original move cli uses snake case, not kebab.
fiagCheckStacklessVM = "stackless"
flagComputeCoverage = "coverage"
// clean options
Expand Down
4 changes: 2 additions & 2 deletions contrib/devtools/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ tools-stamp: statik runsim
touch $@

# Install the runsim binary with a temporary workaround of entering an outside
# directory as the "go install" command ignores the -mod option and will polute the
# directory as the "go install" command ignores the -mod option and will pollute the
# go.{mod, sum} files.
#
# ref: https://github.com/golang/go/issues/30515
Expand All @@ -67,7 +67,7 @@ $(STATIK):
@(cd /tmp && go install github.com/rakyll/[email protected])

# Install the runsim binary with a temporary workaround of entering an outside
# directory as the "go install" command ignores the -mod option and will polute the
# directory as the "go install" command ignores the -mod option and will pollute the
# go.{mod, sum} files.
#
# ref: https://github.com/golang/go/issues/30515
Expand Down
2 changes: 1 addition & 1 deletion images/node/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ fi;
mkdir -p "${INITIAD_HOME}"

# `initiad init` does NOT take cmd env vars into account for some reason
# so we have to manually insert flags with the corresponsing values
# so we have to manually insert flags with the corresponding values
initiad --home "${INITIAD_HOME}" init "${INITIAD_MONIKER}"

wget -O "${CONFIG_DIR}/genesis.json" "${GENESIS_URL}"
Expand Down
2 changes: 1 addition & 1 deletion proto/initia/distribution/v1/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ message GenesisState {
option (gogoproto.equal) = false;
option (gogoproto.goproto_getters) = false;

// params defines all the paramaters of the module.
// params defines all the parameters of the module.
Params params = 1 [
(gogoproto.nullable) = false,
(gogoproto.moretags) = "yaml:\"params\""
Expand Down
2 changes: 1 addition & 1 deletion proto/initia/gov/v1/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ message GenesisState {
repeated cosmos.gov.v1.Vote votes = 3;
// proposals defines all the proposals present at genesis.
repeated Proposal proposals = 4;
// params defines all the paramaters of x/gov module.
// params defines all the parameters of x/gov module.
Params params = 5;
// The constitution allows builders to lay a foundation and define purpose.
// This is an immutable string set in genesis.
Expand Down
2 changes: 1 addition & 1 deletion proto/initia/ibchooks/v1/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ option go_package = "github.com/initia-labs/initia/x/ibc-hooks/types";

// GenesisState defines the mint module's genesis state.
message GenesisState {
// Params defines all the paramaters of the module.
// Params defines all the parameters of the module.
Params params = 1 [(gogoproto.nullable) = false];
repeated ACL acls = 2 [
(gogoproto.nullable) = false,
Expand Down
4 changes: 2 additions & 2 deletions proto/initia/move/v1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,15 @@ service Query {
};
}

// ViewJSON execute view function with json arguemtns and return the view result
// ViewJSON execute view function with json arguments and return the view result
rpc ViewJSON(QueryViewJSONRequest) returns (QueryViewJSONResponse) {
option (google.api.http) = {
post: "/initia/move/v1/view/json"
body: "*"
};
}

// ViewJSONBatch execute multiple view functions with json arguemtns and return the view results
// ViewJSONBatch execute multiple view functions with json arguments and return the view results
rpc ViewJSONBatch(QueryViewJSONBatchRequest) returns (QueryViewJSONBatchResponse) {
option (google.api.http) = {
post: "/initia/move/v1/view/json/batch"
Expand Down
Loading
Loading