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

Wholistic: Setup and Organize Project Linting Standards #477

Open
frozenfrank opened this issue Nov 10, 2024 · 1 comment
Open

Wholistic: Setup and Organize Project Linting Standards #477

frozenfrank opened this issue Nov 10, 2024 · 1 comment
Assignees
Labels
clean-up Something in the code is a mess and needs refactoring enhancement New feature or request

Comments

@frozenfrank
Copy link
Contributor

Overview

Linters and code formatters are standard, and they lead to consistency in project development over time.

Discussion

This will require putting in effort and collaborating with others to agree on a reasonable rule set. It's likely that we'll all have to give some concessions from our personal coding style, but that is to be expected when contributing to a team.

Intelli-J offers built-in code formatters called "Inspectors." They can be run in bulk over the whole project to get things set up, and then can be evaluated on each save. Using these would be convenient since they are built in, and because Intelli-J is our preferred editor. It means that development on non-Intelli-J IDE's will not have the consistent linting rules. It also means it will be difficult to automatically perform the linting checks in a CI environment.

Would we prefer:

  1. Convenient systems in Intelli-J
  2. Robust and widely available manually installed systems
@frozenfrank frozenfrank added enhancement New feature or request clean-up Something in the code is a mess and needs refactoring labels Nov 10, 2024
@frozenfrank frozenfrank self-assigned this Nov 10, 2024
@ThanGerlek
Copy link
Contributor

ThanGerlek commented Nov 14, 2024

I think it should be possible to add them to CI/CD using Qodana. There's a limited-functionality free version that still supports Java (but not TypeScript--sorry Dallin), and I believe it works with GitHub Actions, but I'm not sure. That being said, I don't think a CI/CD workflow is high priority here; as long as we can define a standard for everyone locally, that should be sufficient.

Especially since we've explicitly decided to focus on IntelliJ, I would vote we stick to that ecosystem, all else being equal

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up Something in the code is a mess and needs refactoring enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants