Lint document and add linting step

[tyler36]

This PR does some minor cleanup:

• standardize indenting
• remove duplicate word

[rfay]

Looks good to me. Do you have an automated way of linting that you could do a PR for?

[tyler36]

I manually updated it. If I find a github action, I'll make another PR.

[rfay]

I really apologize about this being all conflicted now because the other one got in there before you. If you can find a way to automate it this time even if you have to do run it manually, that may be a step forward.

Note that Goland did not complain about the existing format.

[tyler36]

I have added a "prettier" action. I set the action to lint JSON, as well as JS and MD files.

Prettier is considered opinionated so you may want to change the options. (https://prettier.io/docs/en/configuration.html)
Requesting re-review as not sure if the rules conflict with what @mattstein is doing/planning for docs.

[rfay]

Please add instructions to the README about how to manually prettify. Thanks!

[mattstein]

I turn Prettier off in VS Code when I’m editing Markdown because it’s too opinionated and bossy. We’ve been here before with a quick auto-formatting change wrecking intentional line breaks and adding confusion, and I’m not keen on applying this everywhere to see what breaks. (With the write option enabled, there’d also be no way to fix it!)

That said, if everybody else is a fan go for it!

[rfay]

I don't think the commit is going to work at all for forked PRs, so perhaps just providing the way to reformat is the way?

@mattstein do you object to the actual results of prettier on this json file?

[mattstein]

No objection at all @rfay!

[rfay]

@tyler36 I'm pretty sure the best path is to change the prettier formatting to a check instead of a commit, and then just require people to have it in that format, so the README can say how.

[tyler36]

Instructions added

[tyler36]

If we target jsonc files, we should probably target json as well.
An earlier commit updated JavaScript files, so I've added that to the workflow and manual run.

I turn Prettier off in VS Code when I’m editing Markdown

Currently, NOT targetting markdown.

[rfay]

I don't understand really why anything matters besides the remote-config.jsonc, and don't understand why this touches that file if it was already properly formatted.

[rfay]

This does seem to have trouble @tyler36 - it doesn't pass its own tests A branch or tag with the name '2023092_linting' could not be found - is it unable to do forked PRs, or ... ???

[rfay]

Yay!

[tyler36]

Anything else?

[bmartinez287]

We may want to grab the latest version of remote-config.jsonc. Otherwise, some of the tips will be deleted.

[tyler36]

@bmartinez287

Thanks for the heads up. File was synced with current tips.

[rfay]

Thanks for all the hard work on this @tyler36 .