Submit the sublime Text plugin to the package Control

Recently wrote the plugin luasmarttips for a LUA smart hint. This plugin has always been a person in use, yesterday suddenly want to put the plug-in to the package Control, if other people have such needs can be installed directly.

The package control site has been given a very detailed submission steps, but English version, English can be directly read submitting a package.

Here's a look at the plugin submission for code hosting on GitHub.

1. Review the existing plugins

Visit the search page to find a similar plugin. The author suggests that if there is a plugin that can be improved, communicate with the original author of the plugin as much as possible, and try not to add a new one.

2. Select a name

Do not take the word sublime in the name, do not use the name too close, do not use the symbol.

3. Code Hosting

There are many ways to code hosting, and it is recommended to use GitHub, note the directory structure, and make sure that the GitHub root directory is the root of your plugin.

4. Version control

In GitHub your plugin project, build a Tag,tag name is your version number, rules follow http://semver.org/.

5. Check your plugin

Delete all the. pyc files, which are automatically generated when the plug-in is loaded.

Delete the Package-metadata.json, which is automatically generated after the plugin is installed.

Check file naming

If a third-party library is used, it is described in the. sublime-package file.

6. Test your Plugin

Before submitting to the package control, we need to test it to ensure that the content submitted conforms to the author's ideas.

Fork the package Control Channel and clone it to your machine. Use sublime text to open this folder.

repository/is the configuration information of the plug-in, according to the first letter divided into different files saved, put your plugin information in the corresponding location

{    "name": "Alignment",    "Details": "Https://github.com/wbond/sublime_alignment",     "Releases": [        {            "sublime_text": "*",            true        }    ]}

7. Add Platform Information

If the plugin only supports OS X and Linux, write this

{    "name": "Alignment",    "Details": "Https://github.com/wbond/sublime_alignment",     "Releases": [        {            "sublime_text": "*",            "platforms": ["OSX", "Linux"],             true         }    ]}

If the plugin only supports windows, write this

{    "name": "Alignment",    "Details": "Https://github.com/wbond/sublime_alignment",     "Releases": [        {            "sublime_text": "*",            "platforms": ["Windows"],             true         }    ]}

8. Perform the test

Install the Channelrepositorytools plugin with the package control.

Then execute the channelrepositorytools:test Default Channel command. Windows CTRL + SHIFT + P can find the channelrepositorytools:test Default Channel command.

There may be some error messages, perhaps the wrong location of your plugin, or a syntax error. Modify your code until there is no error, so the plugin will be tested.

9.Pull Request

And then the final step, pull your modified package Control channel file to the author and wait for the author to review it.

Submit the sublime Text plugin to the package Control