Skip to content

docs: add recommended configuration section to README #83

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

Open
kevmoo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add recommended configuration section to README #83

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
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,43 @@

A [Dart](https://dart.dev/) extension for [Zed](https://zed.dev).

## Recommended Configuration

To make the most of the Dart LSP in Zed, you can configure it to automatically organize imports and apply fixes on format.

### Settings (`settings.json`)

Add the following to your `settings.json` to enable productivity features like organizing imports on save:

```json
{
"languages": {
"Dart": {
"format_on_save": "on",
"code_actions_on_format": {
"source.organizeImports": true,
"source.fixAll": true
}
}
}
}
```

### Key Bindings (`keymap.json`)

You can bind specific LSP actions to keyboard shortcuts. For example, to manually trigger "Sort Members":

```json
[
{
"context": "Editor && mode == full && language == Dart",
"bindings": {
"ctrl-alt-s": ["editor:apply_code_action", "source.sortMembers"]
}
}
]
```

## Documentation

See:
Expand Down