vim新建文件自动导入模板

自从转为做机器学习相关的东西以后,发现每次用vim新建python文件的时候都要写一大堆东西,问题这些东西我还不一定记得正确,强迫症的我还反复打开之前的python文件看一样。更加恶心的时候新建python文件,还自动生成的内容是php的,还要我全部删除,这太影响效率了。于是我想看看这货是怎样实现的,然后更正并应用python特定模板到python文件上面来。


每次新建python新文件,都生成上面这坨东西,挺让人崩溃的。大哥,我新建的是python文件。

解决办法

由于每个人的环境不一样,所以我就不上定位过程了,直接说我遇到的问题原因,及解决办法。
生成这些东西一般在两个地方:

  • `~/.vimrc文件配置
  • vim安装目录下的插件,跟进不同插件,有不同生成。我的这个是在/home/tools/vim/vim72-64/share/vim/plugin/comdg.vim

添加模板

添加模板常用的有2种办法

  • 文件模板
  • 插入内容
文件模板
  • 新建一个模板目录:~/.vim/template
  • 新建一个python模板:~/.vim/template/python.tpl
  • 添加命令到~/.vimrc即可

** ~/.vim/template/python.tpl 文件内容 **

#!/usr/bin/env python
# -*- coding: utf-8 -*- 
 
######################################################################
# 
# Copyright (c) 2017 kinva.cc, Inc. All Rights Reserved
# 
# @author pengjinhua([email protected])
# 
######################################################################
 
import sys 
 
reload(sys)
sys.setdefaultencoding('utf-8')
 
if __name__ == '__main__':

把你所希望新建文件里面包含的填进去,即可。

** ~/.vimrc 文件内容 **

set nobackup
set encoding=utf-8
set termencoding=utf-8
# ...
# 上面是一些vim自己自定义配置,不用关心
#
# 添加以下内容:

autocmd BufNewFile *.py 0r ~/.vim/template/python.tpl | autocmd! BufNewFile
# 解释一下命令:autocmd是一个命令,BufNewFile 是标记新建文件缓存,*.py是匹配到这种文件,0r,是从头开始read该文件,插入。

我们可以看到这种办法比较简单,但是无法获取到时间,文件名称,到了2018年,还要修改tpl文件。一句话:内容不够丰富,那我们可以试试插入内容的办法。

插入内容

这种办法编写内容较多,但是改动文件最少,步骤也少:

  • 只需要改动~/.vimrc
set nobackup
set encoding=utf-8
set termencoding=utf-8
# ...
# 上面是一些vim自己自定义配置,不用关心
#
# 添加以下内容:
function! GetDate()
    "windows
    let date = system("date /T")
    if (v:shell_error!=0)
        "linux
        let date = system("date +\"%Y/%m/%d %H:%M:%S\" ")
    endif
    if (date[strlen(date)-1]=="\n")
        let date = strpart(date, 0, strlen(date)-1)
    endif
    return date
endfunction

function! GetYear()
    return strftime("%Y")
endfunction

function! GetFileName()
    let fname = expand("%")
    return fname
endfunction

function! GetPythonFileHeader()
    let cur_line = line(".")
    let first_line = getline(cur_line)
    let leading_blank = matchstr(first_line, '\(\s*\)')
    let doc = ""
    let doc = doc. leading_blank."#!/usr/bin/env python\n"
    let doc = doc. leading_blank."# -*- coding: utf-8 -*- \n"
    let doc = doc. leading_blank." \n"
    let doc = doc. leading_blank."######################################################################\n"
    let doc = doc. leading_blank."# \n"
    let doc = doc. leading_blank."# Copyright (c) ".GetYear()." kinva.cc, Inc. All Rights Reserved\n"
    let doc = doc. leading_blank."# \n"
    let doc = doc. leading_blank."# @file ".GetFileName()."\n"
    let doc = doc. leading_blank."# @author ".GetUserName()."(".GetUserName()."@kinva.cc)\n"
    let doc = doc. leading_blank."# @date ".GetDate()."\n"
    let doc = doc. leading_blank."# \n"
    let doc = doc. leading_blank."######################################################################\n"
    let doc = doc. leading_blank." \n"
    let doc = doc. leading_blank."import sys\n"
    let doc = doc. leading_blank." \n"
    let doc = doc. leading_blank."reload(sys)\n"
    let doc = doc. leading_blank."sys.setdefaultencoding('utf-8')\n"
    let doc = doc. leading_blank." \n"
    let doc = doc. leading_blank."if __name__ == '__main__':\n"
    return doc
endfunction

function! GetNthItemFromList(list, n, sep) 
    let itemStart = 0 
    let itemEnd = -1
    let pos = 0 
    let item = ""
    let i = 0 
    while (i != a:n)
        let itemStart = itemEnd + 1 
        let itemEnd = match(a:list, a:sep, itemStart)
        let i = i + 1 
        if (itemEnd == -1) 
            if (i == a:n)
                let itemEnd = strlen(a:list)
            endif
            break
        endif
    endwhile
    if (itemEnd != -1)
        let item = strpart(a:list, itemStart, itemEnd - itemStart)
    endif
    return item
endfunction

function! GetFileHeader()
    let cur_line = line(".")
    let doc = GetPythonFileHeader()
    if (strlen(doc)>0)
        let idx =1
        let li = GetNthItemFromList(doc, idx, "\n")
        while (strlen(li)>0)
            call append( cur_line-1, li.expand(""))
            let idx = idx + 1
            let cur_line = cur_line + 1
            let li = GetNthItemFromList(doc, idx, "\n")
        endwhile
    endif
endfunction

if has("autocmd")
    autocmd BufNewFile *.py :call GetFileHeader() | autocmd! BufNewFile
endif

这种做法是直接仿造插件内容,懂程序应该能看清楚这里的语法,然后后面就可以直接仿造添加别的文件了,更多语法可以看看comdg.vim文件。

** 最后强调一下 **
为啥在autocmd后面加上| autocmd! BufNewFile?和别的博客说的不一样呢,有啥用?
|这个是管道不用细说。autocmd!这个命令是删除后面全部的autocmd命令的意思。
由于我的环境是多人开发,所以机器是没法拿到root权限的,因此无法修改/home/tools/vim/vim72-64/share/vim/plugin/comdg.vim的插件内容,因此要用autocmd!去阻止执行后面的代码,否则插入的代码就乱套了,多次插入。

你可能感兴趣的:(vim新建文件自动导入模板)