Fix typos in CLI docstrings

[arthurgousset]

Description

Typos found in this PR:

• Docs: fix typos docs#1246

Context here:

Great finds 💯 The docs/cli/* typos need to be fixed in the celo-org/developer-tooling repo, because the CLI docs are automatically generated from TS docstrings there, and later sync'ed here. Unless the changes are made there, the typos will be reintroduced when the CLI docs are generated next.

I opened a PR for that there:

• Fix typos in CLI docstrings developer-tooling#232

Other changes

Describe any minor or "drive-by" changes here.

Tested

An explanation of how the changes were tested or an explanation as to why they don't need to be.

Related issues

• Fixes #[issue number here]

Backwards compatibility

Brief explanation of why these changes are/are not backwards compatible.

Documentation

The set of community facing docs that have been added/modified because of this change

---

PR-Codex overview

This PR updates descriptions and addresses typos in CLI commands and documentation.

Detailed summary

• Updated descriptions in CLI commands for accuracy and clarity
• Corrected typos in command descriptions and documentation
• Improved consistency in naming conventions for transferred and transferred
• Fixed spelling errors in various files

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

[changeset-bot]

⚠️ No Changeset found

Latest commit: ceac069

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[arthurgousset]

The tests were failing, because of a build error. The linter mistakenly deleted an any type in this commit 7ad2099 when saving.

The quick fix was to disable formatOnSave in .vscode/settings.json:

"[typescript]": {
+    "editor.formatOnSave": false,
-    "editor.formatOnSave": true,

But it feels like disabling that isn't the solution I'm looking for. There must be some rule that makes the any declaration disappear.

I found this rule in .eslintrc.js

developer-tooling/.eslintrc.js

Line 93 in 7ad2099

'@typescript-eslint/no-explicit-any': 'off',

Interestingly, the any declaration is deleted in cli > get-metadata.ts

developer-tooling/packages/cli/src/commands/account/get-metadata.ts

Lines 42 to 43 in 11f6e0a

	} catch (error: any) {
	console.error(`Metadata could not be retrieved from ${metadataURL}: ${error.toString()}`)

But not deleted in sdk > contractkit > verify.ts 🤔

developer-tooling/packages/sdk/contractkit/src/identity/claims/verify.ts

Lines 52 to 55 in 7ad2099

	} catch (error: any) {
	return `Metadata could not be fetched for ${
	claim.address
	} at ${metadataURL}: ${error.toString()}`

The linting rules are the same

1. packages/cli/.eslintrc.js
2. packages/sdk/contractkit/.eslintrc.js

One thing I thought is maybe tsconfig.json, but I can't see anything useful there:

1. packages/cli/tsconfig.json
2. packages/sdk/contractkit/tsconfig.json

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.70%. Comparing base (eeb44f3) to head (ceac069).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #232   +/-   ##
=======================================
  Coverage   71.70%   71.70%           
=======================================
  Files         199      199           
  Lines        8275     8275           
  Branches     1241     1251   +10     
=======================================
  Hits         5934     5934           
+ Misses       2265     2245   -20     
- Partials       76       96   +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[arthurgousset]

Currently, the docs command (yarn docs) does not seem to update the automatically generated CLI docs, which have the fixed typos. I'm blocked until that's fixed.

[arthurgousset]

Note-to-self: Not sure what the status of the PR is that synchronises docs output in celo-org/developer-tooling > docs/command-line-interface with celo-org/docs > docs/cli.

Edit: It's here

• docs ci: manually copy the files rather than use the postinstall hook #214

[aaronmgdr]

it works!