Merge remote-tracking branch 'upstream/master'

autoload/ale/code_action.vim

@@ -1,26 +1,33 @@
 " Author: Jerko Steiner <jerko.steiner@gmail.com>
 " Description: Code action support for LSP / tsserver
 
-function! ale#code_action#HandleCodeAction(code_action, should_save) abort
+function! ale#code_action#HandleCodeAction(code_action, options) abort
     let l:current_buffer = bufnr('')
     let l:changes = a:code_action.changes
+    let l:should_save = get(a:options, 'should_save')
+    let l:force_save = get(a:options, 'force_save')
+    let l:safe_changes = []
 
     for l:file_code_edit in l:changes
         let l:buf = bufnr(l:file_code_edit.fileName)
 
         if l:buf != -1 && l:buf != l:current_buffer && getbufvar(l:buf, '&mod')
-            call ale#util#Execute('echom ''Aborting action, file is unsaved''')
+            if !l:force_save
+                call ale#util#Execute('echom ''Aborting action, file is unsaved''')
 
-            return
+                return
+            endif
+        else
+            call add(l:safe_changes, l:file_code_edit)
         endif
     endfor
 
-    for l:file_code_edit in l:changes
+    for l:file_code_edit in l:safe_changes
         call ale#code_action#ApplyChanges(
-        \ l:file_code_edit.fileName,
+        \   l:file_code_edit.fileName,
-        \ l:file_code_edit.textChanges,
+        \   l:file_code_edit.textChanges,
-        \ a:should_save,
+        \   l:should_save,
-        \ )
+        \)
     endfor
 endfunction
 

autoload/ale/completion.vim

@@ -1006,7 +1006,7 @@ function! ale#completion#HandleUserData(completed_item) abort
     \|| l:source is# 'ale-import'
     \|| l:source is# 'ale-omnifunc'
         for l:code_action in get(l:user_data, 'code_actions', [])
-            call ale#code_action#HandleCodeAction(l:code_action, v:false)
+            call ale#code_action#HandleCodeAction(l:code_action, {})
         endfor
     endif
 

autoload/ale/organize_imports.vim

@@ -12,10 +12,13 @@ function! ale#organize_imports#HandleTSServerResponse(conn_id, response) abort
 
     let l:file_code_edits =  a:response.body
 
-    call ale#code_action#HandleCodeAction({
+    call ale#code_action#HandleCodeAction(
-    \   'description': 'Organize Imports',
+    \   {
-    \   'changes': l:file_code_edits,
+    \       'description': 'Organize Imports',
-    \}, v:false)
+    \       'changes': l:file_code_edits,
+    \   },
+    \   {}
+    \)
 endfunction
 
 function! s:OnReady(linter, lsp_details) abort

autoload/ale/rename.vim

@@ -33,9 +33,10 @@ function! ale#rename#HandleTSServerResponse(conn_id, response) abort
         return
     endif
 
-    let l:old_name = s:rename_map[a:response.request_seq].old_name
+    let l:options = remove(s:rename_map, a:response.request_seq)
-    let l:new_name = s:rename_map[a:response.request_seq].new_name
+
-    call remove(s:rename_map, a:response.request_seq)
+    let l:old_name = l:options.old_name
+    let l:new_name = l:options.new_name
 
     if get(a:response, 'success', v:false) is v:false
         let l:message = get(a:response, 'message', 'unknown')
@@ -77,10 +78,16 @@ function! ale#rename#HandleTSServerResponse(conn_id, response) abort
         return
     endif
 
-    call ale#code_action#HandleCodeAction({
+    call ale#code_action#HandleCodeAction(
-    \ 'description': 'rename',
+    \   {
-    \ 'changes': l:changes,
+    \       'description': 'rename',
-    \}, v:true)
+    \       'changes': l:changes,
+    \   },
+    \   {
+    \       'should_save': 1,
+    \       'force_save': get(l:options, 'force_save'),
+    \   },
+    \)
 endfunction
 
 function! s:getChanges(workspace_edit) abort
@@ -111,7 +118,7 @@ endfunction
 function! ale#rename#HandleLSPResponse(conn_id, response) abort
     if has_key(a:response, 'id')
     \&& has_key(s:rename_map, a:response.id)
-        call remove(s:rename_map, a:response.id)
+        let l:options = remove(s:rename_map, a:response.id)
 
         if !has_key(a:response, 'result')
             call s:message('No rename result received from server')
@@ -156,14 +163,20 @@ function! ale#rename#HandleLSPResponse(conn_id, response) abort
             \})
         endfor
 
-        call ale#code_action#HandleCodeAction({
+        call ale#code_action#HandleCodeAction(
-        \   'description': 'rename',
+        \   {
-        \   'changes': l:changes,
+        \       'description': 'rename',
-        \}, v:true)
+        \       'changes': l:changes,
+        \   },
+        \   {
+        \       'should_save': 1,
+        \       'force_save': get(l:options, 'force_save'),
+        \   },
+        \)
     endif
 endfunction
 
-function! s:OnReady(line, column, old_name, new_name, linter, lsp_details) abort
+function! s:OnReady(line, column, options, linter, lsp_details) abort
     let l:id = a:lsp_details.connection_id
 
     if !ale#lsp#HasCapability(l:id, 'rename')
@@ -195,19 +208,16 @@ function! s:OnReady(line, column, old_name, new_name, linter, lsp_details) abort
         \   l:buffer,
         \   a:line,
         \   a:column,
-        \   a:new_name
+        \   a:options.new_name
         \)
     endif
 
     let l:request_id = ale#lsp#Send(l:id, l:message)
 
-    let s:rename_map[l:request_id] = {
+    let s:rename_map[l:request_id] = a:options
-    \   'new_name': a:new_name,
-    \   'old_name': a:old_name,
-    \}
 endfunction
 
-function! s:ExecuteRename(linter, old_name, new_name) abort
+function! s:ExecuteRename(linter, options) abort
     let l:buffer = bufnr('')
     let [l:line, l:column] = getpos('.')[1:2]
 
@@ -215,12 +225,11 @@ function! s:ExecuteRename(linter, old_name, new_name) abort
         let l:column = min([l:column, len(getline(l:line))])
     endif
 
-    let l:Callback = function(
+    let l:Callback = function('s:OnReady', [l:line, l:column, a:options])
-    \ 's:OnReady', [l:line, l:column, a:old_name, a:new_name])
     call ale#lsp_linter#StartLSP(l:buffer, a:linter, l:Callback)
 endfunction
 
-function! ale#rename#Execute() abort
+function! ale#rename#Execute(options) abort
     let l:lsp_linters = []
 
     for l:linter in ale#linter#Get(&filetype)
@@ -245,6 +254,10 @@ function! ale#rename#Execute() abort
     endif
 
     for l:lsp_linter in l:lsp_linters
-        call s:ExecuteRename(l:lsp_linter, l:old_name, l:new_name)
+        call s:ExecuteRename(l:lsp_linter, {
+        \   'old_name': l:old_name,
+        \   'new_name': l:new_name,
+        \   'force_save': get(a:options, 'force_save') is 1,
+        \})
     endfor
 endfunction

doc/ale-supported-languages-and-tools.txt

@@ -456,9 +456,9 @@ Notes:
 * SugarSS
   * `stylelint`
 * Swift
+  * Apple `swift-format`
   * `sourcekit-lsp`
   * `swiftformat`
-  * `swift-format`
   * `swiftlint`
 * Tcl
   * `nagelfar`!!

doc/ale.txt

@@ -3100,6 +3100,12 @@ ALERename                                                           *ALERename*
   The symbol where the cursor is resting will be the symbol renamed, and a
   prompt will open to request a new name.
 
+  ALE will refuse to complete a rename operation if there are files to modify
+  which have not yet been saved in Vim. If the command is run with a bang
+  (`:ALERename!`), all warnings will be suppressed, and files that are still
+  open in Vim and not saved will be ignored and left in a state where symbols
+  in those files will not be updated.
+
 
 ALERepeatSelection                                         *ALERepeatSelection*
 

plugin/ale.vim

@@ -238,7 +238,7 @@ command! -bar ALEComplete :call ale#completion#GetCompletions('ale-manual')
 command! -bar ALEImport :call ale#completion#Import()
 
 " Rename symbols using tsserver and LSP
-command! -bar ALERename :call ale#rename#Execute()
+command! -bar -bang ALERename :call ale#rename#Execute({'force_save': '<bang>' is# '!'})
 
 " Organize import statements using tsserver
 command! -bar ALEOrganizeImports :call ale#organize_imports#Execute()

supported-tools.md

@@ -465,9 +465,9 @@ formatting.
 * SugarSS
   * [stylelint](https://github.com/stylelint/stylelint)
 * Swift
+  * [Apple swift-format](https://github.com/apple/swift-format)
   * [sourcekit-lsp](https://github.com/apple/sourcekit-lsp)
   * [swiftformat](https://github.com/nicklockwood/SwiftFormat)
-  * [swift-format](https://github.com/apple/swift-format)
   * [swiftlint](https://github.com/realm/SwiftLint)
 * Tcl
   * [nagelfar](http://nagelfar.sourceforge.net) :floppy_disk:

test/completion/test_ale_import_command.vader

@@ -65,8 +65,8 @@ Before:
     return g:server_started_value
   endfunction
 
-  function! ale#code_action#HandleCodeAction(code_action, should_save) abort
+  function! ale#code_action#HandleCodeAction(code_action, options) abort
-    Assert !a:should_save
+    Assert !get(a:options, 'should_save')
 
     call add(g:code_action_list, a:code_action)
   endfunction

test/completion/test_completion_events.vader

@@ -50,8 +50,8 @@ Before:
   let g:handle_code_action_called = 0
   function! MockHandleCodeAction() abort
     " delfunction! ale#code_action#HandleCodeAction
-    function! ale#code_action#HandleCodeAction(action, should_save) abort
+    function! ale#code_action#HandleCodeAction(action, options) abort
-      AssertEqual v:false, a:should_save
+      Assert !get(a:options, 'should_save')
       let g:handle_code_action_called += 1
     endfunction
   endfunction

test/test_code_action.vader

@@ -85,7 +85,8 @@ Execute(It should modify and save multiple files):
   \ 'import D from "D"',
   \], g:file2, 'S')
 
-  call ale#code_action#HandleCodeAction({
+  call ale#code_action#HandleCodeAction(
+  \ {
   \   'changes': [{
   \      'fileName': g:file1,
   \      'textChanges': [{
@@ -122,8 +123,10 @@ Execute(It should modify and save multiple files):
   \       },
   \       'newText': "import {A, B} from 'module'\n\n",
   \     }]
-  \  }],
+  \   }],
-  \}, v:true)
+  \ },
+  \ {'should_save': 1},
+  \)
 
   AssertEqual [
   \ 'class Value {',
@@ -153,7 +156,8 @@ Execute(Beginning of file can be modified):
   \]
   call writefile(g:test.text, g:file1, 'S')
 
-  call ale#code_action#HandleCodeAction({
+  call ale#code_action#HandleCodeAction(
+  \ {
   \   'changes': [{
   \      'fileName': g:file1,
   \      'textChanges': [{
@@ -168,7 +172,9 @@ Execute(Beginning of file can be modified):
   \        'newText': "type A: string\ntype B: number\n",
   \      }],
   \   }]
-  \}, v:true)
+  \ },
+  \ {'should_save': 1},
+  \)
 
   AssertEqual [
   \  'type A: string',
@@ -184,22 +190,25 @@ Execute(End of file can be modified):
   \]
   call writefile(g:test.text, g:file1, 'S')
 
-  call ale#code_action#HandleCodeAction({
+  call ale#code_action#HandleCodeAction(
+  \ {
   \   'changes': [{
-  \      'fileName': g:file1,
+  \    'fileName': g:file1,
-  \      'textChanges': [{
+  \    'textChanges': [{
-  \        'start': {
+  \      'start': {
-  \          'line': 4,
+  \        'line': 4,
-  \          'offset': 1,
+  \        'offset': 1,
-  \        },
+  \      },
-  \        'end': {
+  \      'end': {
-  \          'line': 4,
+  \        'line': 4,
-  \          'offset': 1,
+  \        'offset': 1,
-  \        },
+  \      },
-  \        'newText': "type A: string\ntype B: number\n",
+  \      'newText': "type A: string\ntype B: number\n",
-  \      }],
+  \     }],
   \   }]
-  \}, v:true)
+  \ },
+  \ {'should_save': 1},
+  \)
 
   AssertEqual g:test.text + [
   \  'type A: string',
@@ -219,7 +228,8 @@ Execute(Current buffer contents will be reloaded):
   execute 'edit ' . g:file1
   let g:test.buffer = bufnr(g:file1)
 
-  call ale#code_action#HandleCodeAction({
+  call ale#code_action#HandleCodeAction(
+  \ {
   \   'changes': [{
   \      'fileName': g:file1,
   \      'textChanges': [{
@@ -234,7 +244,9 @@ Execute(Current buffer contents will be reloaded):
   \        'newText': "type A: string\ntype B: number\n",
   \      }],
   \   }]
-  \}, v:true)
+  \ },
+  \ {'should_save': 1},
+  \)
 
   AssertEqual [
   \  'type A: string',
@@ -256,11 +268,11 @@ Execute(Cursor will not move when it is before text change):
   let g:test.changes = g:test.create_change(2, 3, 2, 8, 'value2')
 
   call setpos('.', [0, 1, 1, 0])
-  call ale#code_action#HandleCodeAction(g:test.changes, v:true)
+  call ale#code_action#HandleCodeAction(g:test.changes, {'should_save': 1})
   AssertEqual [1, 1], getpos('.')[1:2]
 
   call setpos('.', [0, 2, 2, 0])
-  call ale#code_action#HandleCodeAction(g:test.changes, v:true)
+  call ale#code_action#HandleCodeAction(g:test.changes, {'should_save': 1})
   AssertEqual [2, 2], getpos('.')[1:2]
 
 # ====C====
@@ -271,7 +283,7 @@ Execute(Cursor column will move to the change end when cursor between start/end)
     call WriteFileAndEdit()
     call setpos('.', [0, 2, r, 0])
     AssertEqual '  value: string', getline('.')
-    call ale#code_action#HandleCodeAction(g:test.changes, v:true)
+    call ale#code_action#HandleCodeAction(g:test.changes, {'should_save': 1})
     AssertEqual '  value2: string', getline('.')
     AssertEqual [2, 9], getpos('.')[1:2]
   endfor
@@ -283,7 +295,9 @@ Execute(Cursor column will move back when new text is shorter):
   call setpos('.', [0, 2, 8, 0])
   AssertEqual '  value: string', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(2, 3, 2, 8, 'val'), v:true)
+  \ g:test.create_change(2, 3, 2, 8, 'val'),
+  \ {'should_save': 1},
+  \)
   AssertEqual '  val: string', getline('.')
   AssertEqual [2, 6], getpos('.')[1:2]
 
@@ -295,7 +309,7 @@ Execute(Cursor column will move forward when new text is longer):
   call setpos('.', [0, 2, 8, 0])
   AssertEqual '  value: string', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(2, 3, 2, 8, 'longValue'), v:true)
+  \ g:test.create_change(2, 3, 2, 8, 'longValue'), {'should_save': 1})
   AssertEqual '  longValue: string', getline('.')
   AssertEqual [2, 12], getpos('.')[1:2]
 
@@ -307,7 +321,7 @@ Execute(Cursor line will move when updates are happening on lines above):
   call setpos('.', [0, 3, 1, 0])
   AssertEqual '}', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(1, 1, 2, 1, "test\ntest\n"), v:true)
+  \ g:test.create_change(1, 1, 2, 1, "test\ntest\n"), {'should_save': 1})
   AssertEqual '}', getline('.')
   AssertEqual [4, 1], getpos('.')[1:2]
 
@@ -319,7 +333,7 @@ Execute(Cursor line and column will move when change on lines above and just bef
   call setpos('.', [0, 2, 2, 0])
   AssertEqual '  value: string', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(1, 1, 2, 1, "test\ntest\n123"), v:true)
+  \ g:test.create_change(1, 1, 2, 1, "test\ntest\n123"), {'should_save': 1})
   AssertEqual '123  value: string', getline('.')
   AssertEqual [3, 5], getpos('.')[1:2]
 
@@ -331,7 +345,7 @@ Execute(Cursor line and column will move at the end of changes):
   call setpos('.', [0, 2, 10, 0])
   AssertEqual '  value: string', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(1, 1, 3, 1, "test\n"), v:true)
+  \ g:test.create_change(1, 1, 3, 1, "test\n"), {'should_save': 1})
   AssertEqual '}', getline('.')
   AssertEqual [2, 1], getpos('.')[1:2]
 
@@ -342,14 +356,14 @@ Execute(Cursor will not move when changes happening on lines >= cursor, but afte
   call setpos('.', [0, 2, 3, 0])
   AssertEqual '  value: string', getline('.')
   call ale#code_action#HandleCodeAction(
-  \ g:test.create_change(2, 10, 3, 1, "number\n"), v:true)
+  \ g:test.create_change(2, 10, 3, 1, "number\n"), {'should_save': 1})
   AssertEqual '  value: number', getline('.')
   AssertEqual [2, 3], getpos('.')[1:2]
 
 Execute(It should just modify file when should_save is set to v:false):
   call WriteFileAndEdit()
   let g:test.change = g:test.create_change(1, 1, 1, 1, "import { writeFile } from 'fs';\n")
-  call ale#code_action#HandleCodeAction(g:test.change, v:false)
+  call ale#code_action#HandleCodeAction(g:test.change, {})
   AssertEqual 1, getbufvar(bufnr(''), '&modified')
   AssertEqual [
   \ 'import { writeFile } from ''fs'';',

test/test_organize_imports.vader

@@ -57,9 +57,9 @@ Before:
     call add(g:expr_list, a:expr)
   endfunction
 
-  function! ale#code_action#HandleCodeAction(code_action, should_save) abort
+  function! ale#code_action#HandleCodeAction(code_action, options) abort
     let g:handle_code_action_called = 1
-    AssertEqual v:false, a:should_save
+    Assert !get(a:options, 'should_save')
     call add(g:code_actions, a:code_action)
   endfunction
 

test/test_rename.vader

@@ -57,9 +57,9 @@ Before:
     call add(g:expr_list, a:expr)
   endfunction
 
-  function! ale#code_action#HandleCodeAction(code_action, should_save) abort
+  function! ale#code_action#HandleCodeAction(code_action, options) abort
     let g:handle_code_action_called = 1
-    AssertEqual v:true, a:should_save
+    Assert get(a:options, 'should_save')
     call add(g:code_actions, a:code_action)
   endfunction
 
@@ -269,7 +269,7 @@ Execute(tsserver rename requests should be sent):
   \   }]
   \ ],
   \ g:message_list
-  AssertEqual {'42': {'old_name': 'somelongerline', 'new_name': 'a-new-name'}},
+  AssertEqual {'42': {'old_name': 'somelongerline', 'new_name': 'a-new-name', 'force_save': 0}},
   \ ale#rename#GetMap()
 
 Given python(Some Python file):
@@ -470,7 +470,7 @@ Execute(LSP rename requests should be sent):
   let b:ale_linters = ['pyls']
   call setpos('.', [bufnr(''), 1, 5, 0])
 
-  ALERename
+  ALERename!
 
   " We shouldn't register the callback yet.
   AssertEqual '''''', string(g:Callback)
@@ -500,5 +500,5 @@ Execute(LSP rename requests should be sent):
   \ ],
   \ g:message_list
 
-  AssertEqual {'42': {'old_name': 'foo', 'new_name': 'a-new-name'}},
+  AssertEqual {'42': {'old_name': 'foo', 'new_name': 'a-new-name', 'force_save': 1}},
   \ ale#rename#GetMap()