Offer an option for YAML indent option

[myermian]

I came across issue #4723 wherein the community decided on the indentation style for yaml mappings. It seems that the community voted to indent sequences, which is how the tool currently works. I recently started implementing prettier in my repositories, but this is causing a problem.

Microsoft's documentation examples are all based on "do not indent".

Example: https://docs.microsoft.com/en-us/azure/devops/pipelines/process/runtime-parameters?view=azure-devops&tabs=script#use-parameters-in-pipelines

parameters:
- name: image
  displayName: Pool Image
  type: string
  default: ubuntu-latest
  values:
  - windows-latest
  - vs2017-win2016
  - ubuntu-latest
  - ubuntu-16.04
  - macOS-latest
  - macOS-10.14

trigger: none

jobs:
- job: build
  displayName: build
  pool: 
    vmImage: ${{ parameters.image }}
  steps:
  - script: echo building $(Build.BuildNumber) with ${{ parameters.image }}

---

I'm now stuck with a dilemma. Do I keep prettier "as-is", which will format all of my yml files, as well as yml code blocks in my markdown files or do I utilize prettierignore to ignore the Azure Pipeline yml files, and any markdown files related to Azure Pipelines?

One of my repositories houses over 100 yml files (Azure Pipeline YAML templates), as well as markdown files which document and give examples of those pipeline files. On top of that, I have a lot of repositories that contain an azure-pipelines.yml and azurepipelines-coverage.yml file.

I realize that Prettier is very opionionated about code formatting, but is this a possible option that can be added?

[lydell]

Hi!

This is Wikipedia’s definition of “dilemma”:

A dilemma is a problem offering two possibilities, neither of which is unambiguously acceptable or preferable.

I can see that you have two possibilities – to format or not to format, that is the question – but you didn’t mention the pros and cons of each choice? To me it sounds like you’re into the concept of having automatic formatting, so running Prettier on all those files is the clear winner. Without more details it’s hard for us to give any advice. What exactly is the problem you have?

[myermian]

Well, leaving aside if I used the word 'dilemma' properly, I will say that yes, I see two options:

• Use prettier as-is, which will reformat all of my YAML pipeline files, as well as all of my markdown files which contain YML code blocks. I would gain other auto-formatting rules that come with prettier.
• Set up my prettierignore file to ignore YAML pipeline (.yml) and markdown files (.md), keeping YAML sequence indentation in tact. If I go onto Azure DevOps and generate a YAML file the files are generated this way. This would keep my YAML pipeline files consistent across those environments, but I lose other formatting options since prettier is no longer applied.

My ultimate preference it the best of both worlds... to use prettier, but to have an option for YAML sequence indentation rules.

[lydell]

I don’t see how the indent option is going to help you? You’ll still have cases where Prettier changes the generated yaml files because of other little formatting differences.

(Note: I wasn’t trying to nitpick on the word “dilemma” – I meant that it didn’t seem like you had a dilemma given the info your provided. “Use Prettier as-is” was the clear winner.)

[myermian]

I don’t see how the indent option is going to help you? You’ll still have cases where Prettier changes the generated yaml files because of other little formatting differences.

I thought my examples were clear, so I'm not sure what else to add to them.

[lydell]

Ok. Since the option philosophy states that the bar for new options is very high, I’ll close this then if we don’t have a super clear reason for it.