Skip to content

docs: Remove configuration examples from the README and link to the examples folder #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nrayburn-tech merged 1 commit into from
Jan 6, 2026
+1 −113
Merged

docs: Remove configuration examples from the README and link to the examples folder #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 1 addition & 113 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
}
}
```