quickref

#快速入门 本文档介绍 aucommand 的基本使用方式，通过简单的例子让你快速上手。

##目录 - [安装](#a1) - [使用说明](#a2) - [1.设置调用快捷键](#a2_0) - [2.前置函数](#a2_1) - [3.针对文件类型](#a2_2) - [4.自定义命令](#a2_3) - [5.创建自定义配置文件](#a2_4) - [6.禁用命令自动转码](#a2_5) - [高级内容](#a3) - [1.调试模式](#a3_0) - [2.参考](#a3_1) ##安装

需求

• python 2.x 支持
• vim 7.3x

将 plugin 目录拷贝至对应的 vim 默认目录。

##使用说明 ###1.设置调用快捷键 *autocommand 没有默认快捷键，你必须指定快捷键。

在vim配置文件中增加如下配置项：

let g:acmd_call_key='<c-s>'

定义一个全局变量 acmd_call_key ，该变量的值会被映射为快捷键。当按下 Ctrl+s 快捷键时， autocommand 会自动保存该文件并执行对应的命令。

###2.前置函数

在vim配置文件中增加如下配置项：

fu! Autocommand_before(fullFileName)
  let shortFileName=expand('%:t')
  let isUnderline=match(shortFileName,'_')
  if isUnderline==0
    sil up
    retu 0
  el
    retu 1
  en
endf

你可以声明一个名为 Autocommand_before 的函数对当前文件进行预处理。参数 fullFileName 是当前文件的全路径名称，函数须返回 0 或 1 的返回值，返回 0 会终止命令执行。

###3.针对文件类型

在vim配置文件中增加如下配置项：

let g:acmd_filetype_list=['haml', 'sass', 'less', 'coffee', 'jade']

上面的配置表示针对 haml、sass、less、coffee、jade 等类型文件执行命令，autocommand 默认针对 haml、sass、less、coffee、jade 等类型的文件调用命令。默认命令如下：

#haml
haml -nq #{$fileName}.haml #{$fileName}.html

sass
sass #{$fileName}.sass #{$fileName}.css

less
lessc #{$fileName}.less>#{$fileName}.css

coffee
coffee -p #{$fileName}.coffee>#{$fileName}.js

jade
jade -P #{$fileName}.jade

*#{$fileName}表示当前文件名

###4.自定义命令

在vim配置文件中增加如下配置项：

" 自定义命令
fu! Autocommand_usercmd(fileType)
  if a:fileType=="jade"
    let ret="jade #{$fileName}.jade -PO ./"
  el
    let ret=""
  en
  retu l:ret
endf

你可以声明一个名为 Autocommand_usercmd 的函数，定义不同类型文件应该执行的默认命令。参数 fileType 是当前文件的类型，返回的字符串将被当作命令执行，返回空字符表示不做任何处理。

###5.创建自定义配置文件

打开vim执行如下命令：

:AcmdInitConfig

会在当前 vim 当前目录下创建名为 _config 的配置文件，配置文件使用json描述，默认文件内容如下：

{
  "haml": {
    "command": "haml -nq #{$fileName}.haml #{$fileName}.html"
    /* 执行命令 */
  },
  "sass": {
    "command": "sass #{$fileName}.sass #{$fileName}.css"
    /* 执行命令 */
  },
  "less": {
    "command": "lessc #{$fileName}.less>#{$fileName}.css"
    /* 执行命令 */
  },
  "coffee": {
    "command": "coffee -bp #{$fileName}.coffee>#{$fileName}.js"
    /* 执行命令 */
  },
  "jade": {
    "command": "jade #{$fileName}.jade -PO ./"
    /* 执行命令 */
  }
}

你可以修改以上的配置文件添加自己需要的选项或文件类型。command 可以声明为一个 JavaScript 数组，autocommand 会依次执行数组中的每条命令。例如：

"sass": {
  "command": [
    "sass --style compact #{$fileName}.sass ../css/#{$fileName}.css",
    "replaceIndent ../css/#{$fileName}.css",
    "cp ../css/#{$fileName}.css ../../../public/css/"
  ]
  /* 执行命令 */
},

以上示例摘自本人开发的项目配置。首先调用 sass 将 .sass 类型的文件转换为 css，再利用 replaceIndent 脚本将文件中的2个空格替换为4个空格（项目需要），再调用 cp 命令将文件拷贝一份至项目根录目的 public/css 目录下。

###6.禁用命令自动转码

au FileType haml,sass let w:acmd_auto_encode=0

autocommand 插件从 vim 获取文件信息，调用系统命令行去处理。当 vim 默认编码和命令行编码不一致时，autocommand 会自动进行转换（处理文件名和路径中的中文字符）。某些情况下，自动转换并不能达到预期的效果，此时可关闭自动转换功能。例如：在 os 版本为 windows，ruby 版本为1.9x的环境下 haml、sass 被 autocommand 调用时传入的参数编码须为 vim 内部编码（虽然 window 命令行编码默认为cp936）。这种情况下，针对 haml、sass 类型的文件定义一个针对窗口的变量 w:acmd_auto_encode。当变量的值为 0 时 autocommand 不会对命令进行编码转换。

##高级内容 ###1.调试模式

待添加

###2.参考

待添加