提交Sublime Text 插件到Package Control

最近写了一个lua智能提示的插件LuaSmartTips。这个插件一直都是自己一个人在用，昨天突然想把插件提交到Package Control，如果其他的人有这样的需求就可以直接安装。

Package Control网站上已经给出了很详细的提交步骤，不过是英文版的，英语好的可以直接读Submitting a Package。

下面主要介绍一下针对于代码托管在Github上面的插件提交。

1.审查现有的插件

访问Search Page寻找类似的插件。作者建议如果有可以改善的插件的话，尽可能的和插件的原作者进行沟通，尽量不要去新增一个。

2.选择一个名字

名字中不要带单词sublime，不要使用太接近的名字，不要使用符号。

3.代码托管

代码托管有很多种方式，这里推荐使用Github，注意目录结构，确保Github根目录就是你插件的根目录。

4.版本控制

在Github你的插件项目中，建立一个Tag，tag的名字是你的版本号，规则遵从http://semver.org/。

5.检查你的插件

删掉所有的.pyc文件，插件加载时会自动生成这些文件。

删掉package-metadata.json，这是插件安装后自动生成的。

检查文件命名

如果有使用第三方库，在.sublime-package这个文件中说明。

6.测试你的插件

提交到Package Control之前，我们要先测试一下，保证提交的内容符合作者的想法。

fork Package Control Channel，并clone到你的机器上。使用Sublime Text打开这个文件夹。

repository/是插件的配置信息，按照首字母分为不同的文件保存，把你的插件信息放在对应的位置

{
    "name": "Alignment",
    "details": "https://github.com/wbond/sublime_alignment",
    "releases": [
        {
            "sublime_text": "*",
            "tags": true
        }
    ]
}

7.增加平台信息

如果插件只支持os x和linux就这样写

{
    "name": "Alignment",
    "details": "https://github.com/wbond/sublime_alignment",
    "releases": [
        {
            "sublime_text": "*",
            "platforms": ["osx", "linux"],
            "tags": true
        }
    ]
}

如果插件只支持windows就这样写

{
    "name": "Alignment",
    "details": "https://github.com/wbond/sublime_alignment",
    "releases": [
        {
            "sublime_text": "*",
            "platforms": ["windows"],
            "tags": true
        }
    ]
}

8.执行测试

用Package Control安装 ChannelRepositoryTools插件。

然后执行ChannelRepositoryTools: Test Default Channel command。windows 下ctrl + shift + p 可以找到ChannelRepositoryTools: Test Default Channel command。

这里可能会有一些错误信息，可能是你的插件位置放的不对，也可能是语法有错误。修改你的代码直到没有报错，这样插件就测试完成了。

9.Pull Request

然后就是最后一步了，把你修改后的Package Control Channel文件Pull到作者那里，等待作者审核。