ci: Add spellcheck step (#164)

* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Revert change

* Add constant length check

* Add spellcheck step

* Tweak action

* Fix typos

* More fixes

* Yet more fixes

* Fixes

* Add j1 option

* More and more fixes

* Add missing acronym

* Fix merge

* Fix spelling

* Fix spelling

Author: febo

.github/actions/setup/action.yml

@@ -98,6 +98,12 @@ runs:
         toolchain: ${{ env.TOOLCHAIN_LINT }}
         components: miri
 
+    - name: Install 'cargo-spellcheck'
+      if: ${{ contains(inputs.components, 'spellcheck') }}
+      uses: taiki-e/install-action@v2
+      with:
+        tool: cargo-spellcheck
+
     - name: Cache Cargo Dependencies
       if: ${{ inputs.cargo-cache-key }}
       uses: actions/cache@v4

.github/workflows/main.yml

@@ -35,6 +35,22 @@ jobs:
         id: filter
         run: pnpm tsx ./scripts/setup/members.mts
 
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Environment
+        uses: ./.github/actions/setup
+        with:
+          cargo-cache-key: cargo-spellcheck
+          components: spellcheck
+
+      - name: cargo-spellcheck
+        run: pnpm spellcheck
+
   process:
     name: Check
     needs: sanity

Cargo.toml

@@ -39,3 +39,6 @@ test = "1.84.1"
 pre-release-commit-message = "Publish {{crate_name}} v{{version}}"
 tag-message = "Publish {{crate_name}} v{{version}}"
 consolidate-commits = false
+
+[workspace.metadata.spellcheck]
+config = "scripts/setup/spellcheck.toml"

package.json

@@ -10,6 +10,7 @@
     "lint": "tsx ./scripts/lint.mts",
     "miri": "tsx ./scripts/miri.mts",
     "semver": "tsx ./scripts/semver.mts",
+    "spellcheck": "cargo spellcheck -j1 --code 1",
     "test": "tsx ./scripts/test.mts"
   },
   "devDependencies": {

programs/system/src/instructions/advance_nonce_account.rs

@@ -9,13 +9,13 @@ use pinocchio::{
 ///
 /// ### Accounts:
 ///   0. `[WRITE]` Nonce account
-///   1. `[]` RecentBlockhashes sysvar
+///   1. `[]` Recent blockhashes sysvar
 ///   2. `[SIGNER]` Nonce authority
 pub struct AdvanceNonceAccount<'a> {
     /// Nonce account.
     pub account: &'a AccountInfo,
 
-    /// RecentBlockhashes sysvar.
+    /// Recent blockhashes sysvar.
     pub recent_blockhashes_sysvar: &'a AccountInfo,
 
     /// Nonce authority.

programs/system/src/instructions/initialize_nonce_account.rs

@@ -16,21 +16,21 @@ use pinocchio::{
 ///
 /// ### Accounts:
 ///   0. `[WRITE]` Nonce account
-///   1. `[]` RecentBlockhashes sysvar
+///   1. `[]` Recent blockhashes sysvar
 ///   2. `[]` Rent sysvar
 pub struct InitializeNonceAccount<'a, 'b> {
     /// Nonce account.
     pub account: &'a AccountInfo,
 
-    /// RecentBlockhashes sysvar.
+    /// Recent blockhashes sysvar.
     pub recent_blockhashes_sysvar: &'a AccountInfo,
 
     /// Rent sysvar.
     pub rent_sysvar: &'a AccountInfo,
 
     /// Lamports to withdraw.
     ///
-    /// The account balance muat be left above the rent exempt reserve
+    /// The account balance must be left above the rent exempt reserve
     /// or at zero.
     pub authority: &'b Pubkey,
 }

programs/system/src/instructions/withdraw_nonce_account.rs

@@ -13,7 +13,7 @@ use pinocchio::{
 /// ### Accounts:
 ///   0. `[WRITE]` Nonce account
 ///   1. `[WRITE]` Recipient account
-///   2. `[]` RecentBlockhashes sysvar
+///   2. `[]` Recent blockhashes sysvar
 ///   3. `[]` Rent sysvar
 ///   4. `[SIGNER]` Nonce authority
 pub struct WithdrawNonceAccount<'a> {
@@ -23,7 +23,7 @@ pub struct WithdrawNonceAccount<'a> {
     /// Recipient account.
     pub recipient: &'a AccountInfo,
 
-    /// RecentBlockhashes sysvar.
+    /// Recent blockhashes sysvar.
     pub recent_blockhashes_sysvar: &'a AccountInfo,
 
     /// Rent sysvar.
@@ -34,7 +34,7 @@ pub struct WithdrawNonceAccount<'a> {
 
     /// Lamports to withdraw.
     ///
-    /// The account balance muat be left above the rent exempt reserve
+    /// The account balance must be left above the rent exempt reserve
     /// or at zero.
     pub lamports: u64,
 }

programs/token/src/instructions/freeze_account.rs

@@ -5,7 +5,7 @@ use pinocchio::{
     ProgramResult,
 };
 
-/// Freeze an Initialized account using the Mint's freeze_authority
+/// Freeze an initialized account using the Mint's freeze authority.
 ///
 /// ### Accounts:
 ///   0. `[WRITE]` The account to freeze.

programs/token/src/instructions/initialize_account.rs

@@ -10,7 +10,7 @@ use pinocchio::{
 /// ### Accounts:
 ///   0. `[WRITE]`  The account to initialize.
 ///   1. `[]` The mint this account will be associated with.
-///   2. `[]` The new account's owner/multisignature.
+///   2. `[]` The new account's owner/multi-signature.
 ///   3. `[]` Rent sysvar
 pub struct InitializeAccount<'a> {
     /// New Account.

programs/token/src/instructions/thaw_account.rs

@@ -5,7 +5,7 @@ use pinocchio::{
     ProgramResult,
 };
 
-/// Thaw a Frozen account using the Mint's freeze_authority
+/// Thaw a frozen account using the Mint's freeze authority.
 ///
 /// ### Accounts:
 ///   0. `[WRITE]` The account to thaw.