From e59cd6b7c0ba91c6dcfac5a6ce411e23af7a6252 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 2 May 2018 13:38:52 +0100 Subject: [PATCH] Make the features ALE supports clearer in the README --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 53b6379c..4b3d317e 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,18 @@ back to a filesystem. In other words, this plugin allows you to lint while you type. -In addition to linting support, ALE offers some support for fixing code with -formatting tools, and some Language Server Protocol and `tsserver` features. +ALE offers support for fixing code with command line tools in a non-blocking +manner with the `:ALEFix` feature, supporting tools in many languages, like +`prettier`, `eslint`, `autopep8`, and more. + +ALE acts as a "language client" to support a variety of Language Server Protocol +features, including: + +* Diagnostics (via Language Server Protocol linters) +* Go To Definition (`:ALEGoToDefinition`) +* Completion (`let g:ale_completion_enabled = 1`) +* Finding references (`:ALEFindReferences`) +* Hover information (`:ALEHover`) ## Table of Contents @@ -238,7 +248,8 @@ See `:help ale-completion` for more information. ### 2.iv Go To Definition ALE supports jumping to the definition of words under your cursor with the -`:ALEGoToDefinition` command using any enabled LSP linters and `tsserver`. +`:ALEGoToDefinition` command using any enabled Language Server Protocol linters +and `tsserver`. See `:help ale-go-to-definition` for more information. @@ -247,7 +258,8 @@ See `:help ale-go-to-definition` for more information. ### 2.v Find References ALE supports finding references for words under your cursor with the -`:ALEFindReferences` command using any enabled LSP linters and `tsserver`. +`:ALEFindReferences` command using any enabled Language Server Protocol linters +and `tsserver`. See `:help ale-find-references` for more information. @@ -255,8 +267,9 @@ See `:help ale-find-references` for more information. ### 2.vi Hovering -ALE supports "hover" information for printing brief information about symbols -at the cursor taken from LSP linters with the `ALEHover` command. +ALE supports "hover" information for printing brief information about symbols at +the cursor taken from Language Server Protocol linters and `tsserver` with the +`ALEHover` command. See `:help ale-hover` for more information.