voidzero-dev / voidzero-dev/vite-plus

EditorConfig support as a "Generic" option for editor setup

Offen
#1,964 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
pending triage
Vorherrschende Sprache
Rust
Sterne
5.8k
Forks
262
Ø Merge
1 T. 34 Min.
Gemergte PRs (30 T.)
135

Beschreibung

### 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
cli, developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.