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

Add linting and formatting to repo #372

Open
marceljay opened this issue Aug 8, 2023 · 5 comments
Open

Add linting and formatting to repo #372

marceljay opened this issue Aug 8, 2023 · 5 comments
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request

Comments

@marceljay
Copy link
Contributor

marceljay commented Aug 8, 2023

The project should ideally have standardized rules for our code enforced via tooling.
This issue should serve as the initial discussion of these rules.

Here are some suggestions for tools to be used:

  • JS/TS linting: ESLint
  • Formatting: Prettier
  • Solidity Linting: Solhint, Prettier Plugin for Solidity

Open Questions to be discussed (can be extended):

  1. Which tools should we use?
  2. What rules can we agree on? (One of the most important ones for now might be the printWidth (columns).
@marceljay marceljay added enhancement New feature or request dependencies Pull requests that update a dependency file labels Aug 15, 2023
@marceljay
Copy link
Contributor Author

Initial work has been done by PR: #377

@marceljay
Copy link
Contributor Author

@asimpk @arthurka-o Do you have any input or a strategy on how we deal with the various "rules" applied in the different packages?

@arthurka-o
Copy link
Contributor

Not really. I don't have a lot of experience in linters.
What do you mean by various "rules" applied in the different packages? Do you mean .eslintrc.json in every TS package?

@marceljay
Copy link
Contributor Author

I meant that different packages do not seem to have the same rules (e.g. max-line-length) and thus depending on the rule, many issues will occur.

@arthurka-o
Copy link
Contributor

Maybe we can set up the biggest value of all packages for every rule?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants