Skip to content

Prettier should pick up .editorconfig by default or via configuration #1186

New issue
New issue
Open
#2364
Open
Prettier should pick up .editorconfig by default or via configuration#1186
#2364
Labels
enhancement
@theodm

Description

@theodm
theodm
opened on Apr 26, 2022

Feature Request:

Prettier usually picks up the '.editorconfig'-File of the project. The following variables will be evaluated:

  • end_of_line
  • indent_style
  • indent_size/tab_width
  • max_line_length

As far as I can see the .editorconfig of the project is currently not being picked up. There's no way to configure spotless to explicitly use a .editorconfig-File. As workaround I currently reconfigure the desired properties:

<...>.config(prettierConfig)

val prettierConfig = mapOf("tabWidth" to 4, "printWidth" to 80)

So my proposal is to ideally support .editorconfig without dedicated config, as alternative the .editorconfig could be supplied as another configuration parameter.

Activity

theodm
changed the title [-]Make prettier pick up .editorconfig[/-] [+]Prettier should pick up .editorconfig by default or via configuration[/+] on Apr 26, 2022
nedtwigg
added
enhancement
on Apr 27, 2022
nedtwigg

nedtwigg commented on Apr 27, 2022

@nedtwigg
nedtwigg
on Apr 27, 2022
Member

the .editorconfig of the project is currently not being picked up

This is correct. If it were being accounted for, it would have to be included as part of this class

spotless/lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java

Lines 61 to 66 in 3ec902c

private static class State extends NpmFormatterStepStateBase implements Serializable {
private static final long serialVersionUID = -539537027004745812L;
private final PrettierConfig prettierConfig;
State(String stepName, Map<String, String> devDependencies, File buildDir, NpmPathResolver npmPathResolver, PrettierConfig prettierConfig) throws IOException {

so that it could be taken into consideration for up-to-date checks. Probably you would have to declare something like prettier().editorConfig() to trigger a search for .editorconfig files in this or a parent directory.

Happy to take a PR for such a feature.

skuznets0v
linked a pull request that will close this issue on Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @nedtwigg@theodm

      Issue actions
        Prettier should pick up .editorconfig by default or via configuration · Issue #1186 · diffplug/spotless