Code Monkey home page Code Monkey logo

vim-flutter's Introduction

vim-flutter

Vim commands for Flutter, including hot-reload-on-save and more.

Demo usage GIF

Usage

Usage documentation can be found both in this README, as well as via calling :h flutter.

Installation

vim-flutter is a Vimscript-only plugin, and makes heavy use of Vim8's async jobs. It can be installed with a package manager like vim-plug , for example.

Though this package doesn't depend on it, having dart-vim-plugin available is recommended, for a better experience.

You may also consider combining package:dart_language_server with a Language Server Protocol client, like ale.

Plug 'dart-lang/dart-vim-plugin'
Plug 'thosakwe/vim-flutter'

" Run :PlugInstall to install the plugin.

Ultimately, installation is up to you.

Options

  • g:flutter_command - The Flutter executable path/name; defaults to 'flutter'.
  • g:flutter_hot_reload_on_save - Whether to auto hot-reload when dart files are saved; defaults to 1.
  • g:flutter_hot_restart_on_save - Whether to auto hot-restart when dart files are saved; defaults to 0.
  • g:flutter_show_log_on_run - Automatically open __Flutter_Output__ when starting flutter using :FlutterRun; it can have one of the following values:
    • "split" or 1: Open the log in a split, this is the default.
    • "tab": Open the log in a new tab.
    • "hidden" or 0: Do not open the log by default, can be opened later with FlutterSplit etc.
  • g:flutter_show_log_on_attach - Identical to g:flutter_show_log_on_run but affecting the :FlutterAttach command.
  • g:flutter_autoscroll - Autoscroll the flutter log when 1, defaults to 0.
  • g:flutter_use_last_run_option - When set to 1 then :FlutterRun will use the arguments from the previous call when no arguments are specified.
  • g:flutter_use_last_attach_option - Identical to g:flutter_use_last_run_option but affecting the :FlutterAttach command.

Provided Commands

  • :FlutterRun <args> - calls flutter run <args>
  • :FlutterAttach <args> - calls flutter attach <args>
  • :FlutterHotReload - triggers a hot reload on the current Flutter process
  • :FlutterHotRestart - triggers a hot restart on the current Flutter process
  • :FlutterScreenshot - takes a screenshot of the current Flutter application and saves it in the project directory
  • :FlutterQuit - quits the current Flutter process
  • :FlutterDevices - opens a new buffer, and writes the output of flutter devices to it
  • :FlutterSplit - opens Flutter output in a horizontal split
  • :FlutterEmulators - Executes a flutter emulators process.
  • :FlutterEmulatorsLaunch - Executes a flutter emulators --launch process, with any provided arguments.
  • :FlutterVisualDebug - Toggles visual debugging in the running Flutter process.

The following are self-explanatory:

  • :FlutterVSplit
  • :FlutterTab

Menu Support

If you are using a GUI Vim Variant, you can add a Flutter menu by calling call FlutterMenu().

Hot Reload on Save

A convenient feature to have when working with Flutter is to automatically hot-reload an app once a file is saved. By default, whenever a dart file is saved, if and only if a Flutter process is running, it will be hot-reloaded.

You can disable this by setting g:hot_reload_on_save=0, before vim-flutter is loaded.

Example .vimrc

Plug 'thosakwe/vim-flutter'
call plug#end()

" Enable Flutter menu
call FlutterMenu()

" Some of these key choices were arbitrary;
" it's just an example.
nnoremap <leader>fa :FlutterRun<cr>
nnoremap <leader>fq :FlutterQuit<cr>
nnoremap <leader>fr :FlutterHotReload<cr>
nnoremap <leader>fR :FlutterHotRestart<cr>
nnoremap <leader>fD :FlutterVisualDebug<cr>

vim-flutter's People

Contributors

datsuns avatar davrack avatar dihak avatar get-me-power avatar insidewhy avatar mracos avatar paulreimer avatar stefanoamorelli avatar studiome avatar thosakwe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.