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: add typo detection tool #1461

Merged
merged 1 commit into from
May 16, 2024

Conversation

bodhi-crypo
Copy link
Contributor

@bodhi-crypo bodhi-crypo commented May 14, 2024

Description

  • add automatic typo detection in CI

Additional Notes

  • Blocks all CHANGELOG typos checks, although there are indeed some typos in it, it does not affect the readability of the main code.
  • If we need to check CHANGELOG, we need to add further extend-words eg.ede
error: `ede` should be `edge`
  --> ./domainobjs/CHANGELOG.md:56:64
   |
56 | * **deps-dev:** bump @types/node from 20.11.2 to 20.11.5 ([7698ede](https://github.com/privacy-scaling-explorations/maci/commit/7698edef2b95bc017e54c1fc0d796ccc9da3de85))
   |                                                                ^^^
   |
error: `polution` should be `pollution`
  --> ./crypto/CHANGELOG.md:27:46
   |
27 | * **crypto:** get rid of potential prototype polution ([9b8a97c](https://github.com/privacy-scaling-explorations/maci/commit/9b8a97cc9661e0ee6f535cdcab19b4aa0fa98136))
   |                                              ^^^^^^^^
   |
error: `ede` should be `edge`
  --> ./crypto/CHANGELOG.md:65:64
   |
65 | * **deps-dev:** bump @types/node from 20.11.2 to 20.11.5 ([7698ede](https://github.com/privacy-scaling-explorations/maci/commit/7698edef2b95bc017e54c1fc0d796ccc9da3de85))

Related issue(s)

Original issue: privacy-scaling-explorations/halo2curves#142

Confirmation

Copy link

vercel bot commented May 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview May 16, 2024 2:07pm

@ctrlc03
Copy link
Collaborator

ctrlc03 commented May 14, 2024

Description

  • add automatic typo detection in CI

Additional Notes

  • Blocks all CHANGELOG typos checks, although there are indeed some typos in it, it does not affect the readability of the main code.
  • If we need to check CHANGELOG, we need to add further extend-words eg.ede
error: `ede` should be `edge`
  --> ./domainobjs/CHANGELOG.md:56:64
   |
56 | * **deps-dev:** bump @types/node from 20.11.2 to 20.11.5 ([7698ede](https://github.com/privacy-scaling-explorations/maci/commit/7698edef2b95bc017e54c1fc0d796ccc9da3de85))
   |                                                                ^^^
   |
error: `polution` should be `pollution`
  --> ./crypto/CHANGELOG.md:27:46
   |
27 | * **crypto:** get rid of potential prototype polution ([9b8a97c](https://github.com/privacy-scaling-explorations/maci/commit/9b8a97cc9661e0ee6f535cdcab19b4aa0fa98136))
   |                                              ^^^^^^^^
   |
error: `ede` should be `edge`
  --> ./crypto/CHANGELOG.md:65:64
   |
65 | * **deps-dev:** bump @types/node from 20.11.2 to 20.11.5 ([7698ede](https://github.com/privacy-scaling-explorations/maci/commit/7698edef2b95bc017e54c1fc0d796ccc9da3de85))

Related issue(s)

Original issue: privacy-scaling-explorations/halo2curves#142

Confirmation

Hi @bodhi-crypo thanks for this PR. could you please run prettier on this branch and rebase to our latest dev changes please?

@bodhi-crypo
Copy link
Contributor Author

rebase

@ctrlc03 rebased

@ctrlc03
Copy link
Collaborator

ctrlc03 commented May 14, 2024

rebase

@ctrlc03 rebased

Could you run prettier as well please? pnpm prettier:write 🙏

@bodhi-crypo
Copy link
Contributor Author

rebase

@ctrlc03 rebased

Could you run prettier as well please? pnpm prettier:write 🙏

I know why the preitter failed. The newadded typos.yaml has a format problem, actually need run pnpm prettier:fix

@ctrlc03 ctrlc03 added the devops A DevOps related task label May 14, 2024
Copy link
Collaborator

@0xmad 0xmad left a comment

Choose a reason for hiding this comment

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

@bodhi-crypo thanks, just left some comments

@bodhi-crypo
Copy link
Contributor Author

@bodhi-crypo thanks, just left some comments

fixed && squashed @ctrlc03

Copy link
Collaborator

@0xmad 0xmad left a comment

Choose a reason for hiding this comment

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

@bodhi-crypo thanks!

@ctrlc03 ctrlc03 merged commit e374139 into privacy-scaling-explorations:dev May 16, 2024
20 checks passed
Copy link

gitpoap-bot bot commented May 16, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 MACI Contributor:

GitPOAP: 2024 MACI Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops A DevOps related task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants