Code Linting / Formatting Rules

[shiffman]

Picking up on this comment as part of #264, it might be nice to establish a simple set of standards that are checked in the continuous integration process.

• whitespace (2 spaces?)
• horizontal line length limits
• comment styles

@pearmini maybe you have some thoughts about how to best integrate this?

[pearmini]

@shiffman Hi Dan, I think it's a great idea to include linting as part of our continuous integration workflow. We're already using Prettier for formatting, which covers whitespace and line length:

{
  "tabWidth": 2,
  "printWidth": 80
}

However, Prettier doesn't enforce comment style conventions. To address that, we can use ESLint, which offers helpful rules such as:

• spaced-comment
• capitalized-comments

We could set up a GitHub Action to run on every pull request to automatically check formatting and linting. If it fails, the action would block the PR until the issues are resolved.

If you'd like, I'm happy to set this up!

[shiffman]

Yes, this is a great plan if you want to set it up! I'm guessing it may trigger a lot of errors all over the codebase, perhaps we could clean/fix them all in one branch?

[pearmini]

@shiffman Yes, we can fix them all in one branch! Should we do it after all the active summer branches are merged? Otherwise, fixing them now might cause a lot of conflicts for these branches.