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

ci: fixing typos programmatically #5975

Merged
merged 19 commits into from
May 9, 2024
Merged

ci: fixing typos programmatically #5975

merged 19 commits into from
May 9, 2024

Conversation

sdankel
Copy link
Member

@sdankel sdankel commented May 8, 2024

Description

Adds a CI check for typos and fixes all* typos in code, comments, and docs.

*found by typos-cli

typos doesn't catch everything, but it seems to work better than codespell and cargo-spellcheck (fewer false positives).

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@sdankel sdankel changed the title ci: spellcheck comments with codespell ci: fixing typos programmatically May 8, 2024
Copy link

github-actions bot commented May 8, 2024

Benchmark for cb6dadc

Click to view benchmark
Test Base PR %
code_action 5.5±0.03ms 5.6±0.11ms +1.82%
code_lens 326.5±9.12ns 288.8±8.02ns -11.55%
compile 6.9±0.05s 6.9±0.11s 0.00%
completion 5.1±0.15ms 5.1±0.15ms 0.00%
did_change_with_caching 6.3±0.10s 6.3±0.07s 0.00%
document_symbol 1027.2±17.50µs 945.0±25.08µs -8.00%
format 88.6±1.05ms 88.5±1.23ms -0.11%
goto_definition 351.1±4.37µs 354.4±12.74µs +0.94%
highlight 9.1±0.15ms 9.1±0.02ms 0.00%
hover 588.4±7.37µs 589.4±7.07µs +0.17%
idents_at_position 118.8±0.44µs 119.1±0.59µs +0.25%
inlay_hints 656.6±15.93µs 665.9±12.16µs +1.42%
on_enter 503.8±35.61ns 519.8±16.43ns +3.18%
parent_decl_at_position 3.7±0.03ms 3.8±0.15ms +2.70%
prepare_rename 351.8±3.66µs 350.5±6.70µs -0.37%
rename 9.8±0.10ms 9.7±0.17ms -1.02%
semantic_tokens 1036.4±19.44µs 1068.0±12.82µs +3.05%
token_at_position 342.6±3.17µs 345.8±2.83µs +0.93%
tokens_at_position 3.7±0.03ms 3.7±0.03ms 0.00%
tokens_for_file 418.8±2.81µs 419.7±1.86µs +0.21%
traverse 51.1±0.73ms 50.8±1.09ms -0.59%

@sdankel sdankel marked this pull request as ready for review May 8, 2024 23:42
@sdankel sdankel requested a review from kayagokalp as a code owner May 8, 2024 23:42
@sdankel sdankel requested review from a team and IGI-111 May 8, 2024 23:42
Copy link
Member

@kayagokalp kayagokalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Member

@JoshuaBatty JoshuaBatty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@JoshuaBatty JoshuaBatty merged commit f8e8d35 into master May 9, 2024
42 checks passed
@JoshuaBatty JoshuaBatty deleted the sophie/codespell branch May 9, 2024 00:21
This was referenced May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants