Vimscript编程指南

发布

现在你已经掌握了能够编写对很多人都有用的Vim插件了。这个章节会讲解如何如何把你的插件上线并且让他们能够很容易获得,就像推销一样。

放在主机上

你首先需要做得是,把你的插件放到网络上,这样其他的人就可以下载了。官方的放Vim插件的地址是Vim网站的脚本区块

目前的一个趋势是,在Bitbucket或者GitHub这样的公告仓库上。这个方法变得流行可能主要因为两个因素。第一,Pathogen让插件能够很容易的安装在不同的目录下。类似Mercurial和Git的分布式版本控制系统,已经类似Bitbuck和GibHut的公共主机站点的兴起也对这有着影响。

对于很多把代码放在自己的版本控制库的人而言,提供代码库是一件很简单的事情。Mercurial用户可以使用Mercurial的“子仓库”来跟踪插件的版本,Git用户可以使用子模块(虽然是使用其他的仓库,而不是类似Mercurial的子仓库。

对于每个插件有个单独的代码库,当它们出现问题的时候,调试起来是很方便的。你可以使用blame,bisection等其他VSC提供的工具来排查究竟出了什么问题。而且,如果你本地有了代码,就很容易提供修复的代码了。

希望我说服了你,你需要让你的仓库能够被其他用户取到。你用什么服务并不重要,只要你的仓库对其他用户是可见的就可以了。

文档

你已经使用Vim内部文档的格式来给你的插件编写文档了,但是你的工作并没有借宿。你还需要写一个简要的说明来总结一些东西:

    1. 你的插件是做什么的?
    1. 这些用户为什么需要使用它?
    1. 为什么你的插件比其他的更好用(如果有的话)?
    1. 插件的许可证是什么?
    1. 一个到完整文档的链接,这个文档是通过vim-doc渲染的。

这些内容应该放在你的README文档(这个会在你的Bitbucket和GitHub的仓库的首页展示),而且你可以把它用作你的插件在Vim.org上的入口描述上。

放一些截图也是一个很好地注意。虽然Vim是一个文本编辑器,但这并不代表它没有用户界面。

公开宣传

一旦你把你的插件放在网络上的这些位置上:现在可以告诉整个世界了!你可以在Twitter上告诉你的粉丝,发布到Reddit的/r/vim模块,在你的个人网站上挂上入口的链接,也可以在Vim初学者的邮件列表上发布它。

当你把你个人创造的作品发布到外界的时候,你会得到赞赏也会得到批评。不要让消极的文字影响你太多。仔细聆听他们,但是不要因为别人指出一些瑕疵(有效的或者其他的)而影响你的情绪。没人是完美的,这才是真实的互联网,所以如果你需要保持快乐和充满动力的话,那你就不要在意这些。

练习

在Vim.org上创建一个账号,如果你没有的话。

阅读一些你比较喜欢的插件的README文件,看看它们是如何组织的以及它们都包含了哪些信息。

文档