UMM-CSci-3601 / intro-to-git

A group exercise practicing with various git ideas and tools
MIT License
2 stars 7 forks source link

Add default formatting #119

Closed NicMcPhee closed 8 months ago

NicMcPhee commented 8 months ago

This turns on editor.formatOnSave in VS Code, so that when files are saved they will be automatically reformatted to a shared standard formatting so we have consistent formatting across everyone's work on this lab.

I'm using the RedHat Java formatter and MarkdownLint for Markdown files.

It turned out that several of the Markdown files had some issues, so I fixed those and am committing them as well while I'm here.

Fixes #112 Closes #101

NicMcPhee commented 8 months ago

If you switch to this branch and then do some "weird" things in VSCode, you can see it automatically "fix" them when you save.

As an example, there were concerns (#101) that Checkstyle wasn't being consistent about spacing around curly braces. So I tried things like:

String[] strings = { "Hello", "world" };

If I remove the spaces between, for example, the open curly brace and "Hello" and save, the space will magically re-appear.

The RedHat Java formatter that I'm using here is less aggressive than the Prettier formatter. Prettier changed the formatting in several other places in the Java code. In particular it reformatted the big strings in the tests so that each component was on its own line. We'll see that in action when I add Prettier to the iteration template.

Does that help?

NicMcPhee commented 8 months ago

Good point on the tense and phrasing. I'll make a new issue for that and see if I can get this guy merged in.

sonarcloud[bot] commented 8 months ago

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud