documentation formatting: Wed Dec 18 14:21:30 UTC 2019

This commit is contained in:
emacspace 2019-12-18 14:21:30 +00:00 committed by Eugene Yaremenko
parent 473d019b47
commit 5038781428
2 changed files with 33 additions and 13 deletions

View file

@ -2,11 +2,18 @@
#+TAGS: framework|layer|programming
* Table of Contents :TOC_5_gh:noexport:
- [[#table-of-contents][Table of Contents]]
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
* Table of Contents
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
* Description
This layer adds support for [[https://flowtype.org/][flow]] to spacemacs.
@ -25,7 +32,7 @@ add =flow-type= to the existing =dotspacemacs-configuration-layers= list.
In addition you also need to flow binary installed best with npm like shown below.
#+BEGIN_SRC sh
npm install -g flow-bin
npm install -g flow-bin
#+END_SRC
The type under the cursor is shown automatically using eldoc. You may find this
@ -33,7 +40,7 @@ a little sluggish, depending on your setup - if so, you can disable it by settin
=flow-type-enable-eldoc-type-info= to =nil=.
#+BEGIN_SRC emacs-lisp
(flow-type :variables flow-type-enable-eldoc-type-info nil)
(flow-type :variables flow-type-enable-eldoc-type-info nil)
#+END_SRC
You can always show types manually using =flow-minor-type-at-pos=,
@ -41,10 +48,10 @@ bound to =SPC m f t= by default.
* Key bindings
| Key binding | Description |
|-------------+---------------------------------------------------------|
| ~SPC m f b~ | jump back from definition |
| ~SPC m f c~ | run `flow status' as a compiler |
| ~SPC m f d~ | jump to the definition of the variable under the cursor |
| ~SPC m f f~ | show flow suggestions |
| ~SPC m f o~ | print coverage information |
| Key binding | Description |
|-------------+---------------------------------------------------------|
| ~SPC m f b~ | jump back from definition |
| ~SPC m f c~ | run `flow status' as a compiler |
| ~SPC m f d~ | jump to the definition of the variable under the cursor |
| ~SPC m f f~ | show flow suggestions |
| ~SPC m f o~ | print coverage information |

View file

@ -110,6 +110,7 @@
- [[#frameworks][Frameworks]]
- [[#django][Django]]
- [[#emberjs][Emberjs]]
- [[#flow-type][Flow-type]]
- [[#phoenix][Phoenix]]
- [[#react][React]]
- [[#ruby-on-rails][Ruby on rails]]
@ -1525,6 +1526,18 @@ Features:
- Key bindings for generators and also easily revert generator actions
- Ability to build, start server, and run tests
*** Flow-type
[[file:+lang/flow-type/README.org][+lang/flow-type/README.org]]
This layer adds support for [[https://flowtype.org/][flow]] to spacemacs.
Features:
- Syntax highlighting
- Linting
- Code-completion
- Eldoc integration for flow-types
- Compilation
*** Phoenix
[[file:+frameworks/phoenix/README.org][+frameworks/phoenix/README.org]]