Skip to content

document prettier integration better #7615

Closed

Description

@brlewis

Is your proposal related to a problem?

In Formatting Code Automatically the example uses a command-line option to configure prettier to favor single quotes. At the end it directs people to how they might configure their editor. But the editor is going to use prettier defaults, not the command with options that's part of the git hook, so the editor will keep changing to double quotes, making git diff less useful, until changes are committed and it switches back to single quotes.

Describe the solution you'd like

Plan A would be not to include any configuration in the example. This would be most concise and simple. Full disclosure this is partly because I'm personally on a "don't customize anything" kick wanting to just take the defaults on everything wherever possible.

Describe alternatives you've considered

If there's objection to removing the single-quote configuration from the example, plan B would be to add a "prettier" key to the package.json customization in the example. That way the prettier config would be where all integrations could find it.

Additional context

More discussion on prettier defaults

Activity

  1. added a commit that references this issue on Sep 5, 2019
    e1c31d3
  2. brlewis commented on Sep 6, 2019

    @brlewis
    ContributorAuthor

    Although I can't see any comments on #7646 it looks like plan A got rejected. Any thoughts on plan B? And could someone please add tag: documentation? I don't have the ability to add tags.

  3. heyimalex commented on Sep 6, 2019

    @heyimalex
    Contributor

    Oh I just accidentally created the pr as a branch on master when I meant to do it on my own fork, so I closed it and didn't get around to redoing it. If you want you can create the same pr?

  4. locked and limited conversation to collaborators on Sep 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions