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.

Sign up for GitHub

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

feat: add cairo-lint ci #238

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: add cairo-lint ci #238

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
78c7f38
feat: add cairo-lint ci
okhaimie-dev Oct 1, 2024
19c12b0
fix: cairo-lint ci upgrade
okhaimie-dev Oct 1, 2024
83f1d65
fix: ci fails with lint issue
okhaimie-dev Oct 6, 2024
fbb8b01
retry build
okhaimie-dev Oct 6, 2024
2e5291e
retry
okhaimie-dev Oct 6, 2024
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
15 changes: 15 additions & 0 deletions .github/workflows/check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ jobs:
mdl -s .github/linter/readme_style.rb README.md
mdl -s .github/linter/base_style.rb .github

cairo-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Rust nightly
uses: dtolnay/rust-toolchain@nightly
with:
components: rustfmt, clippy
- name: Install cairo-lint
run: cargo install scarb-cairo-lint --git https://github.com/keep-starknet-strange/cairo-lint

- uses: asdf-vm/actions/install@v3
- run: scarb cairo-lint
Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking the CI check should fail if there are existing Cairo-lint warnings. What do you think?

Copy link
Contributor Author

@okhaimie-dev okhaimie-dev Oct 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I am not sure about this, there are some linting warning I don't think we might want to follow.

Example:

warning: Plugin diagnostic: Leaving `panic!` in the code is discouraged.
  --> /home/runner/work/shinigami/shinigami/packages/engine/src/cond_stack.cairo:90:18
   |
90 |             _ => panic!("Invalid condition")

I think there are some valid panics, so if this type fails might not be the desired result

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll see if there is a way to ignore lints, but I think all the existing lints we want to follow. Even the panic one, we don't want any panic conditions ( and this branch should never be reached anyway ).

- run: scarb cairo-lint --fix
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this run needed? The changes wouldn't persist to the branch right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was also thinking to remove the run: scarb cairo-lint --fix but wanted to here your feedback on this


test:
runs-on: ubuntu-latest
steps:
Expand Down