Space inside parens () , brackets [] {}

[annalogue-codes]

Dears, thank you for making biome!

I am copying this over from a prettier issue, which reflects a very common coding style.
This has also been discussed on the prettier issues page

It has become a very common coding style among many frameworks to include spaces inside braces and brackets.
Biome provides the option javascript.formatter.bracketSpacing but that does not include braces, i.e. spaces around function parameters and arguments.

Examples

Function arguments

function foo( one, two, three ) {

Instead of

function foo(one, two, three) {

Arrays

const array = [ 1, 2, 3, 4 ]

instead of:

const array = [1, 2, 3, 4]

Methods

array.slice( 0, 1 )

instead of

array.slice(0, 1)

Rationale

• This coding style strongly increases readability for many developers.
• It is an actual option in ESLint.
• It is used by Wordpress and more than Wordpress 50 000 addons.
• It is part of Idiomatic.js by @rwaldron, a fairly popular Javascript style guide that has over 12 000 stars.

[arendjr]

I’m not a fan of this option per se, but it does appear there is indeed quite the demand for it. I’m not sure we should prioritize it right now, but I think if someone would be willing to create a PR for this we can accept it.

[ematipico]

I would hold on to that, please, and first discuss it.

[ematipico]

FYI https://biomejs.dev/formatter/option-philosophy/

[annalogue-codes]

1. It is used in many major frameworks (e.g. Wordpress, jQuery, ... see above).
2. It is more consistent with other rules regarding spaces (see above).
3. It is a profound improvement for a significant number of people with reading dyslexia (and, as the examples under 1. indicate, for a large number of people in general).

How can you just ignore these arguments?

[annalogue-codes]

Here is a style guide for dyslexia friendly written English that highlights the importance of spacing:

https://www.bdadyslexia.org.uk/advice/employers/creating-a-dyslexia-friendly-workplace/dyslexia-friendly-style-guide

[ematipico]

Thank you, I am going to read the article.

I didn't read the prettier discussion. I just did and it didn't give more information other than the ones you shared here, so you did a good summary.

Btw, please don't assume I am ignoring your arguments. We need to be good at justifying new options, find good arguments, and "because it's used in another tool" isn't one of them, for example. So we need to be good at that! The link might be useful.

[jonlepage]

Apologies, but I was looking for something more insightful like discussions or articles regarding the proposal, how a space before parentheses can affect people with disabilities. The two messages gave me nothing, other than just an impression of mocking me.

As you know, Biome formatter is meant to replace Prettier, not Eslint. Also, eslint deprecated stylistic rules.

So, if we are really able to justify really well a new option, we could implement it.

hi, sorry for my inappropriate humor, I was a bit exhausted and my response was probably out of place.
My intention was not to make you feel mocked. If that's the emotion I have given you, I apologize .

The idea is not to criticize but simply to inform you that the choice of including spaces or not is not really about good practice but rather about a medical condition to varying degrees.
English is not my native language, so I wouldn't dare to discuss this topic in a language I don't master well, for fear of expressing myself incorrectly.
However, to provide additional information, here are some articles that discuss the necessity of including spaces to facilitate reading for dyslexic individuals.
Dyslexia has several levels and is sometimes difficult to identify, which can result in a significant decrease in reading efficiency. Generally, a reading task that takes ~1 second to read can take me 5 to 15 seconds and requires a tremendous amount of energy to read text correctly without spaces.

Here some science paper about the sujets:

Extra-large letter spacing improves reading in dyslexia
https://pubmed.ncbi.nlm.nih.gov/22665803/

The effects of letter spacing and coloured overlays on reading speed and accuracy in adult dyslexia
https://pubmed.ncbi.nlm.nih.gov/27629067/

Influence of increased letter spacing and font type on the reading ability of dyslexic
https://pubmed.ncbi.nlm.nih.gov/30094714/

french: Dyslexic reading improves when letters are more spaced out.
https://www.ledevoir.com/societe/sante/351667/la-lecture-des-dyslexiques-amelioree-quand-les-lettres-sont-plus-espacees

thanks

[jonlepage]

btw, regarding article 2.
"The effects of letter spacing and coloured overlays on reading speed and accuracy in adult dyslexia"

People like me often use very colorful syntax to aid in landmarks.
Strangely, this can be very unsettling for those with color blindness or who prefer monochrome, as it often creates too much confusion in their minds.

Without all those colors and spacing, I feel completely lost in my code readings 😅

[ematipico]

The core team and maintainers discussed the proposal, and we agree that we have a strong reasons to implement the feature. The main reason is the accessibility concerns.

Now, for the people that are interested in the proposal, I would ask you to lay down a concrete proposal, possibly an RFC, so we can discuss it and come up with a solid plan.

At the moment we don't have the manpower to implement the feature straightaway, and there are still a lot of things to discuss. Here's some pointers:

• We would prefer to have one option to control all the spaces. Dprint has a spaceAround option we could borrow.
• Come up with a name for the option
• Show ALL cases affected by the option. I know it's a lot, but when we will implement the feature, we will need to know where to implement it. For example, the current proposal doesn't cover computed properties. e.g. should the option cover this snippet { [someVar]: "" }? If so, how?

[ematipico]

Feel free to send a PR @orballo

[sirreal]

Automattic has maintained a fork of prettier (wp-prettier) for some time to add the spacing rules expected by the WordPress community. It may be helpful to look at the changes in that repository, it's a few commits on top of a prettier release commit.

[Eveeifyeve]

A while ago, me and @luisherranz, wrote a POC of sorts to see if we could modify Biome to support WordPress coding standard. If I remember correctly, most (if not all) of the changes were related to spacing as it is being discussed here.

Just in case it helps, at least in knowing where to look in the code, here is the PR: https://github.com/orballo/biome/pull/1/files

At the time, we tested the PR against the codebase of Gutenberg, and it seemed to cover all the spacing rules of WP.

I think this should a community thing not a offical support biome in my opinion as wp-prettier is not really used by a lot of users.

[orballo]

I didn't mean to imply with my comment that Biome should support WP coding standards.

I shared a POC I worked on because it is related to what is being discussed here, which is to support a different spacing style. It happens that the spacing style is used in the WP coding standards, but that's it.

Also, I'm afraid I won't work on a proper implementation. I just shared the PR with the hope that the person interested in doing so, finds it somewhat helpful.

[sirreal]

I'm planning to work with @luisherranz to get a PR ready for this soon, work will start this week.