metacatui icon indicating copy to clipboard operation
metacatui copied to clipboard

Enforce JS formatting standards to improve readability and encourage collaboration

Open robyngit opened this issue 2 years ago • 4 comments

Describe the feature you'd like Select a code formatting standard, and enforce it using a shared JS formatter tool / linter. Reformat all JS files in MetacatUI to align with this standard. Consider also implementing a pre-commit hook to prevent unstyled code from being committed.

Is your feature request related to a problem? Please describe. Code in MetacatUI uses a combination of tabs and spaces for indenting, and has many other stylistic inconsistencies. The result is that the code tends to be difficult to read, understand, and update. I believe these challenges are a barrier to onboarding new developers and discourage contributions from external developers.

Additional context Given that this will cause major merge conflicts for users who have extended MetacatUI, and that any code that doesn't follow the new standard will not be valid, this should be considered a breaking change. This was discussed as part of the the 3.0.0 release.

robyngit avatar Feb 08 '23 21:02 robyngit