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

docs: add opinions to readme #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add opinions to readme #1

wants to merge 1 commit into from

Conversation

mojoaxel
Copy link
Member

No description provided.

@mojoaxel mojoaxel requested a review from josurzyn July 11, 2022 09:08

We (still) use `arrowParens: avoid`

Prettier recently made the very hard change from `avoid` to `always` in v2](https://prettier.io/docs/en/options.html#arrow-function-parentheses). While we think the change makes sense we want to keep out code bases consistend for now.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The v2 link is broken!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems okay to me?


We set `singleQuote: true`.

We don't use jsx or other abominations, and also don't thing you should put long strings inside you code. So for us singel quotes are just more lightweight and improve readability when used together with string-templates, that we use for most strings.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*think
*your code
us,
*single
string-templates -> is the 'proper' term template literals?
that which

I find 'abominations' maybe reads a bit too opinionated, but that's also just my opinion! 😄


We set `useTabs: true` and we have a very strong opinion about this!

Why the hell would you use spaces for indentation? That's just very unprofessional! https://www.youtube.com/watch?v=SsoOG6ZeyUI

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also find the phrasing here on the too opinionated side - for example, if someone hasn't ever come across the tabs/spaces debate (and let's be honest, it's not exactly the first thing you need to learn), then calling them unprofessional reads a bit mean, and probably does more to put them off, rather than 'convert' them.

Maybe there's a way to have the strong opinion in a less confrontational way?


We use a `printWidth` of `100` instead of the default `80`

While this is explicitly discurraged in [the prettier docs](https://prettier.io/docs/en/options.html#print-width) we acknowledge that screens are much wider than high, nowadays.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*discouraged
but isn't it more about readability than screen size?


While this is explicitly discurraged in [the prettier docs](https://prettier.io/docs/en/options.html#print-width) we acknowledge that screens are much wider than high, nowadays.

We just prefer a little less broken up lines in our code. This is not a strong opinion but instead of putting a big warning-block inside their docs prettier should acknowledge that a lot of projects currently overwrite the default of 80! Not every developer is using vim...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little

I think the comment in the prettier docs is actually quite useful


We (still) use `arrowParens: avoid`

Prettier recently made the very hard change from `avoid` to `always` in v2](https://prettier.io/docs/en/options.html#arrow-function-parentheses). While we think the change makes sense we want to keep out code bases consistend for now.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems okay to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants