From: Simon Ruderich <simon@ruderich.org>
Date: Mon, 15 Oct 2012 20:09:59 +0000 (+0200)
Subject: vimrc: Display a warning when editing auto-generated files.
X-Git-Url: https://ruderich.org/simon/gitweb/?p=config%2Fdotfiles.git;a=commitdiff_plain;h=e02e55ec3000ba54a785b286ed2dd56e32bb7b9f

vimrc: Display a warning when editing auto-generated files.

Searches for "do not edit" (ignoring the case).
---

diff --git a/vimrc b/vimrc
index 96fb449..3b77e8e 100644
--- a/vimrc
+++ b/vimrc
@@ -836,6 +836,23 @@ if has('autocmd')
             autocmd InsertLeave * set   ignorecase
         endif
 
+" Display a warning when editing a file which contains "do not edit" (ignoring
+" the case, \c), for example template files which were preprocessed or
+" auto-generated files. Especially useful when the header is not displayed on
+" the first screen, e.g. when the old position is restored. Not for vimrc
+" though.
+        function! s:SearchForDoNotEditHeader()
+            if search('\cdo not edit', 'n') == 0
+                    \ || expand('<afile>:t') =~# '^.\?vimrc$'
+                return
+            endif
+
+            echohl WarningMsg
+            echo 'Do not edit this file! (Maybe a template file.)'
+            echohl None
+        endfunction
+        autocmd BufRead * call <SID>SearchForDoNotEditHeader()
+
 " AFTER/FTPLUGIN AUTO COMMANDS
 
 " Disable spell checking for files which don't need it.