voidzero-dev / voidzero-dev/vite-plus

EditorConfig support as a "Generic" option for editor setup

Open
#1,964 0 comments 1 reaction 0 assignees View on GitHub
pending triage
Dominant language
Rust
Stars
5.8k
Forks
262
Avg merge
1d 34m
Merged PRs (30d)
135

Description

### 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](https://spec.editorconfig.org/), 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

- [x] Read the [Contributing Guidelines](https://github.com/voidzero-dev/vite-plus/blob/main/CONTRIBUTING.md).
- [x] Confirm this request is for Vite+ itself and not for Vite, Vitest, tsdown, Rolldown, or Oxc.
- [x] Check that there isn't already an issue requesting the same feature.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the existing editor setup options for VS Code and Zed, then inspect the vp fmt and vp format entry points. Compare the current Oxfmt configuration with the requested .editorconfig behavior and define how conflicts should be reported or synchronized. Done means the scope and behavior of a Generic or EditorConfig option are implemented and verified.

Written by the indexing model from the issue text.

Assessment

Domain
cli, developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.