Extension Registry Help

Help for using the Brackets Extension Registry

How do I write an extension?

Take a look at the How to write extensions wiki page.

How do I publish my extension in the registry?

First, make sure you have your extension in the extension package format which is basically a .zip file with a package.json file in it. If your extension is on GitHub, you'll find a link to a zip file in the navigation elements on the right-hand side of your repository.

1. Go to the Registry site
2. Log in with your GitHub credentials. We never see your GitHub password and your extension itself doesn't need to be on GitHub (see below).
3. Drag and drop your zip file onto the big upload square, or click the square to browse to your zip file

How do I update my extension?

Just follow the exact same steps you used to upload your extension in the first place. Make sure that you've increased the version number in package.json. The Registry will detect that you're updating an extension.

Do I have to have my code on GitHub?

No. Right now, the Registry requires a GitHub account in order to identify you to the registry. You can use any source repository and zip utility to create the extension package file that you upload.

Is the Registry open source?

Yes! It has its own repository on GitHub.

How do I prevent further installs of my extension?

If there's some issue with your extension and you want to keep people from downloading it, create an update to your extension by increasing your extension's version number and setting the engines.brackets value in package.json to restrict installations to earlier Brackets versions. For example, let's say that the current Brackets version is 0.30.0. You can stop installations on that version of Brackets by adding this to your package.json:

"engines": {
    "brackets": "<0.30.0"
}

How do I remove an extension from the Registry?

At present, there is no (automated) way to remove an extension from the registry. See the section above for preventing further installs of an extension, as that will suffice for many people who are trying to pull an extension from the registry.

You could also upload an update to your extension that contains an empty main.js so that your extension basically does nothing.

I need some other help!

If you have questions that are not answered here, feel free to ask on the email list. If you have a question or concern that cannot be addressed publicly, feel free to contact Kevin Dangoor (dangoor at adobe.com).