From 503878142842c6bfccd48b069c7c3f3b5cdc3cd4 Mon Sep 17 00:00:00 2001 From: emacspace Date: Wed, 18 Dec 2019 14:21:30 +0000 Subject: [PATCH] documentation formatting: Wed Dec 18 14:21:30 UTC 2019 --- layers/+lang/flow-type/README.org | 33 +++++++++++++++++++------------ layers/LAYERS.org | 13 ++++++++++++ 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/layers/+lang/flow-type/README.org b/layers/+lang/flow-type/README.org index e76220873..71f4e3921 100644 --- a/layers/+lang/flow-type/README.org +++ b/layers/+lang/flow-type/README.org @@ -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 | diff --git a/layers/LAYERS.org b/layers/LAYERS.org index cf965261a..b05b68d1f 100644 --- a/layers/LAYERS.org +++ b/layers/LAYERS.org @@ -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]]