Skip to content

EditorConfig support as a "Generic" option for editor setup #1964

Description

@KTrain5169

Description

EditorConfig is a standard for configuring editors through one file (.editorconfig) instead of multiple (.vscode, .zed, .idea, etc)

A while ago, I suggested on the VoidZero Discord the idea of adding a generic option for editor setup, which would automatically create a .editorconfig file with as many formatting options that overlaps with Oxfmt.

Image

I took a bit of a look at the specification, and admittedly it is quite small, so I'm not sure if this is something the team wants to take on and maintain. I'm willing to help if I can get some help in being pointed in the right direction to implement this.

Suggested solution

Like the image above tries to illustrate, there could be a new "Generic" or "EditorConfig" button that, when applied, creates a .editorconfig file that matches the default/current Oxfmt config (as much as possible).

When vp fmt/vp format is ran, it would check the EditorConfig file and the current Oxfmt file. If relevant configurations conflict from both .editorconfig and the Oxfmt config, there could be a printed warning that states that the configuration is not in sync and to run a command to sync the config? This part might be the fuzziest part of EditorConfig support to be honest.

Alternative

Selecting all the options in the menu, which is currently quite limited (as of writing, only contains VS Code and Zed)

Additional context

No response

Validations

  • Read the Contributing Guidelines.
  • Confirm this request is for Vite+ itself and not for Vite, Vitest, tsdown, Rolldown, or Oxc.
  • Check that there isn't already an issue requesting the same feature.

Metadata

Metadata

Assignees

No one assigned

    Priority

    None yet

    Start date

    None yet

    Target date

    None yet

    Effort

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions