1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:20:06 +08:00
SpaceVim/docs/layers/lang/dart.md
2021-06-21 20:39:29 +08:00

106 lines
2.9 KiB
Markdown

---
title: "SpaceVim lang#dart layer"
description: "This layer is for Dart development, provides autocompletion, syntax checking and code formatting for Dart files."
---
# [Available Layers](../../) >> lang#dart
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Features](#features)
- [Install](#install)
- [Layer](#layer)
- [Syntax checking && Code formatting](#syntax-checking--code-formatting)
- [Install dart-repl](#install-dart-repl)
- [Layer options](#layer-options)
- [Key bindings](#key-bindings)
- [Inferior REPL process](#inferior-repl-process)
- [Running current script](#running-current-script)
- [Code formatting](#code-formatting)
- [Flutter integration](#flutter-integration)
<!-- vim-markdown-toc -->
## Description
This layer is for Dart development.
## Features
- code completion
- syntax checking
- code formatting
- REPL
- code runner
- flutter integration
## Install
### Layer
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
name = "lang#dart"
```
### Syntax checking && Code formatting
To enable syntax checking and code formatting in spacevim,
you need to install [dart sdk](https://github.com/dart-lang/sdk).
### Install dart-repl
You need to install the dart_repl via pub, pub is a build-in package manager in dart-sdk:
```sh
pub global activate dart_repl
```
## Layer options
- `dart_sdk_path`: Set the path of dart sdk, by default, it is `''`.
## Key bindings
### Inferior REPL process
Start a `dart.repl` inferior REPL process with `SPC l s i`.
Send code to inferior process commands:
| Key Bindings | Descriptions |
| ------------ | ------------------------------------------------ |
| `SPC l s b` | send buffer and keep code buffer focused |
| `SPC l s l` | send line and keep code buffer focused |
| `SPC l s s` | send selection text and keep code buffer focused |
### Running current script
To run a ruby script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Code formatting
The code formatting is provided by the `format` layer, and it will run `dartfmt` asynchronously.
| Key Bindings | Descriptions |
| ------------ | --------------------- |
| `SPC b f` | format current buffer |
### Flutter integration
When editing a dart file, the following key bindings are available for running flutter commands.
| Key bindings | Descriptions |
| ------------ | -------------------------------- |
| `SPC l f D` | Display flutter doctor result |
| `SPC l f E` | Launch to a flutter emulators id |
| `SPC l f d` | Display flutter devices result |
| `SPC l f e` | Display flutter emulators list |
| `SPC l f l` | Reload flutter app |
| `SPC l f r` | Run `flutter run` command |
| `SPC l f s` | Restart flutter app |
| `SPC l f q` | Quit current flutter process |