From 302f69e933b85628c688a1b16eab5dd2e7976e99 Mon Sep 17 00:00:00 2001
From: Martin Tournoij <martin@arp242.net>
Date: Sat, 23 Dec 2017 13:13:55 +0000
Subject: [PATCH] Add ALEFixPre and ALEFixPost events

To run autocmd before and after every fix cycle.

Fixes #623 (`ALELintPre` was added in #1203).
---
 README.md                   |  8 +++++---
 autoload/ale/fix.vim        |  4 ++++
 doc/ale.txt                 |  6 ++++--
 test/fix/test_ale_fix.vader | 15 +++++++++++++++
 4 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index d5335e2..1e5a725 100644
--- a/README.md
+++ b/README.md
@@ -502,15 +502,17 @@ Will give you:
 ### 5.viii. How can I execute some code when ALE starts or stops linting?
 
 ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html)
-events whenever has a linter is started and has been successfully executed and
-processed. These events can be used to call arbitrary functions before and after
-ALE stops linting.
+events when a lint or fix cycle are started and stopped. These events can be
+used to call arbitrary functions before and after ALE stops linting.
 
 ```vim
 augroup YourGroup
     autocmd!
     autocmd User ALELintPre  call YourFunction()
     autocmd User ALELintPost call YourFunction()
+
+    autocmd User ALEFixPre   call YourFunction()
+    autocmd User ALEFixPost  call YourFunction()
 augroup END
 ```
 
diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim
index 9111db3..398f57d 100644
--- a/autoload/ale/fix.vim
+++ b/autoload/ale/fix.vim
@@ -54,6 +54,8 @@ function! ale#fix#ApplyQueuedFixes() abort
         let l:should_lint = l:data.changes_made
     endif
 
+    silent doautocmd <nomodeline> User ALEFixPost
+
     " If ALE linting is enabled, check for problems with the file again after
     " fixing problems.
     if g:ale_enabled
@@ -463,6 +465,8 @@ function! ale#fix#Fix(...) abort
     call ale#fix#RemoveManagedFiles(l:buffer)
     call ale#fix#InitBufferData(l:buffer, l:fixing_flag)
 
+    silent doautocmd <nomodeline> User ALEFixPre
+
     call s:RunFixer({
     \   'buffer': l:buffer,
     \   'input': g:ale_fix_buffer_data[l:buffer].lines_before,
diff --git a/doc/ale.txt b/doc/ale.txt
index 2e98cd7..b16528f 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2304,9 +2304,11 @@ b:ale_linted                                                     *b:ale_linted*
 
 ALELintPre                                                 *ALELintPre-autocmd*
 ALELintPost                                               *ALELintPost-autocmd*
+ALEFixPre                                                   *ALEFixPre-autocmd*
+ALEFixPost                                                 *ALEFixPost-autocmd*
 
-  These |User| autocommands are triggered before and after every lint cycle.
-  They can be used to update statuslines, send notifications, etc.
+  These |User| autocommands are triggered before and after every lint or fix
+  cycle. They can be used to update statuslines, send notifications, etc.
   The autocmd commands are run with |:silent|, so |:unsilent| is required for
   echoing messges.
 
diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader
index 5b66c92..0321cba 100644
--- a/test/fix/test_ale_fix.vader
+++ b/test/fix/test_ale_fix.vader
@@ -17,6 +17,14 @@ Before:
   \ 'testft': [],
   \}
 
+  let g:pre_success = 0
+  let g:post_success = 0
+  augroup VaderTest
+    autocmd!
+    autocmd User ALEFixPre let g:pre_success = 1
+    autocmd User ALEFixPost let g:post_success = 1
+  augroup end
+
   if !has('win32')
     let &shell = '/bin/bash'
   endif
@@ -171,6 +179,7 @@ After:
   unlet! g:ale_emulate_job_failure
   unlet! b:ale_fixers
   unlet! b:ale_fix_on_save
+  augroup! VaderTest
   delfunction AddCarets
   delfunction AddDollars
   delfunction DoNothing
@@ -664,3 +673,9 @@ Expect(The lines in the JSON should be used):
   x
   y
   z
+
+Execute(ALEFix should apply autocmds):
+  let g:ale_fixers.testft = ['AddCarets']
+  ALEFix
+  AssertEqual g:pre_success, 1
+  AssertEqual g:post_success, 1