From 5650859b6afff025d44dd9f28ed3f8c2d58d0ebe Mon Sep 17 00:00:00 2001 From: Nick Rayburn <52075362+nrayburn-tech@users.noreply.github.com> Date: Mon, 5 Jan 2026 23:05:57 -0600 Subject: [PATCH] docs: Remove configuration examples from the README and link to the examples folder --- README.md | 114 +----------------------------------------------------- 1 file changed, 1 insertion(+), 113 deletions(-) diff --git a/README.md b/README.md index 5a704fe..7751c86 100644 --- a/README.md +++ b/README.md @@ -24,118 +24,6 @@ This extension is available in the extensions view inside the Zed editor. Open ` ## Configuration -Configuration is done within your settings.json file. Below are some example configurations. +Configuration is done within your settings.json file. Examples can be found [here](examples) for oxfmt and oxlint. See https://github.com/oxc-project/oxc/tree/main/crates/oxc_language_server for the options that are supported by the language server. - -### Oxfmt - -```json -{ - "languages": { - "JavaScript": { - "format_on_save": "on", - "formatter": [ - { - "language_server": { - "name": "oxfmt" - } - } - ] - } - }, - "lsp": { - "oxfmt": { - "initialization_options": { - "settings": { - "configPath": null, - "flags": {}, - "fmt.configPath": null, - "fmt.experimental": true, - "run": "onSave", - "typeAware": false, - "unusedDisableDirectives": false - } - } - } - } -} -``` - -### Oxlint - -```json -{ - "languages": { - "JavaScript": { - "format_on_save": "on", - "formatter": [ - { - "code_action": "source.fixAll.oxc" - } - ] - } - }, - "lsp": { - "oxlint": { - "initialization_options": { - "settings": { - "disableNestedConfig": false, - "fixKind": "safe_fix", - "run": "onType", - "typeAware": true, - "unusedDisableDirectives": "deny" - } - } - } - } -} -``` - -### Oxfmt and Oxlint - -```json -{ - "languages": { - "JavaScript": { - "format_on_save": "on", - "formatter": [ - { - "language_server": { - "name": "oxfmt" - } - }, - { - "code_action": "source.fixAll.oxc" - } - ] - } - }, - "lsp": { - "oxlint": { - "initialization_options": { - "settings": { - "disableNestedConfig": false, - "fixKind": "safe_fix", - "run": "onType", - "typeAware": true, - "unusedDisableDirectives": "deny" - } - } - }, - "oxfmt": { - "initialization_options": { - "settings": { - "configPath": null, - "flags": {}, - "fmt.configPath": null, - "fmt.experimental": true, - "run": "onSave", - "typeAware": false, - "unusedDisableDirectives": false - } - } - } - } -} -```