Add support to use Biome in addition to Prettier about orval HOT 12 CLOSED

@oferitz
Oh really. I'm sorry for not being able to tell you more.

@mortezakarimi
Thank you for sharing.

However, I am expecting to add Biome as an option, so I will open this issue and assign it to me.

from orval.

@oferitz
It seemed like a really good idea. I'll consider it. You can also create your own PR. I gladly accept it.

from orval.

And I'm interested in this issue, so I've assigned it to me.

from orval.

I agree with you that there are very few use cases to use both. But the point I'm making here is that there's no real negative impact if both are enabled.

from orval.

@mortezakarimi Nice! That's a perfect solution, no need for introducing new config. I'm closing this issue

from orval.

@soartec-lab That's awesome! glad you are doing that, thanks.

from orval.

@oferitz

orval will be able to use the biome option in the next version by #1321 👍

from orval.

I think if you submit a PR it would be considered. I know @soartec-lab has done a bunch of work recently to fix up Prettier so interested opinion.

from orval.

@soartec-lab What would be the preferred approach in terms of configuration for this feature?
I had in mind the following options:

1. Side by side

// orval.config.ts
{
   prettier: boolean,
   biome: boolean
 } 

Pros: backward compatible
Cons: will have to add check that only one of them is used

2. New formatter option but backward compatible

// orval.config.ts
{
  prettier: boolean,
  formatter: 'prettier' | 'biome'
} 

Pros: backward compatible, unified configuration
Cons: will have to add check that only one of them is used

3. New formatter option but breaking change

// orval.config.ts
{
  formatter: 'prettier' | 'biome'
} 

Pros: unified configuration, more elegant because no need for check
Cons: breaking change

from orval.

@oferitz

Thank you for your suggestion. I prefer pattern 1.
Because, it maintains compatibility and it is clear that it follows the format of the prettier option that originally existed.
Also, it is not necessarily the case that you can only set either prettier or biome. I think it's fine for users to do both if they wish.

from orval.

@soartec-lab

Thanks for the feedback. I'm fine with pattern 1, but I don't see a use case for using both, as they both serve the same purpose. In most cases, one will simply override the other (depending on the order they appear in the code), which could lead to confusion.

from orval.

@oferitz you can use following code to use custom formatter

    hooks: {
      afterAllFilesWrite: ['prettier --write --ignore-unknown'],
    },

for more info view following link https://orval.dev/reference/configuration/hooks#afterallfileswrite

from orval.