Sublime Forum

Open-sourcing user's Sublime Text packages

#1

Hi, everyone.

People have been developing plugins and packages for a little while
now, and we’re going to try to bring them all together in a central
location.

I’ve set up an open-source project here;

code.google.com/p/sublime-text-c … -packages/

That’s right, our very own google code CVS repository. My hope is that
the CVS will give us some more safety, and Jon more visibility and
control over the code. So, rather than the definitive copy of the
auto-backup plugin being on my laptop, it’s now in google’s CVS.

== WHO OWNS THE CODE? ==

I’ve chosen the new BSD licence, which means Jon is free to
incorporate anything there straight into Sublime Text, no licencing
problems. I’m a project owner, as is Nick (sublimator) and of course
Jon, ST’s developer. Our board usernames are SteveCooperOrg,
sublimator, and jps.

== CAN I CONTRIBUTE? ==

If you want to start a package on the CVS, give us a shout by PM .
Put your email address in that PM if you want a faster
conversation! :wink:

== HOW DOES THIS AFFECT SUBLIME TEXT’S DEVELOPMENT? ==

Jon is free to incorporate any of the contents of the repository
directly into ST. So anything that is well-coded and generally useful
may get folded in to ST’s core. Otherwise, it’s an entirely different
line of development.

== BUILDING PACKAGES AUTOMATICALLY ==

The package downloader plugin
(sublimetextwiki.com/pages/Pa … oader.html) will
retreive the contents of the repository as sublime packages.

After committing code to the repository, you can deploy the new
changes to the Package Downloader by visiting this link;

sublimetextwiki.com/sublime- … ackages.py

after a short delay you’ll see the build messages for the packages –
something like this;

Building
clearing staging directory
deleting .svn/tmp/text-base

deleting PackageDownloader
getting packages from SVN

A /kunden/homepages/25/d96254051/htdocs/packages/AutomaticBackups

A /kunden/homepages/25/d96254051/htdocs/packages/PackageDownloader/README.txt
Checked out revision 9.
Zipping AutomaticBackups
Zipping PackageDownloader
2 packages built

which means the packages have been dragged out of CSV, zipped into
.sublime-package files, and dropped into the folder where the package
downloader will find them.

If you include a README.txt file (case-sensitive) this is incorporated into the wiki as user-guide information. You don’t need to worry about keeping both the wiki and your package up-to-date; the package always wins.

Which means, the build process now looks like this;

  1. commit your changes to the google CVS.
  2. visit the makeSublimePackages.py to build the CVS to the wiki folder
  3. Um… that’s it. You can get downloading from here.

== SUBVERSION NOTES ==

I’ve been using tortoise SVN, which works fine. I’ve been using this
nice little guide to get stuff up onto the site;

internetducttape.com/2007/03/03/ … rtoisesvn/

0 Likes

#2

So, some updates to the SVN system, for your convenience.

README.txt files

If you include a README.txt in the package, the text will be included on sublimetextwiki.com; to announce your plugin, then, all you really need to do is include a readme. Henceforth, that page will be kept in sync with your README.txt. Of course, this means your README.txt must be in Markdown markup…

sublime-distro files

If you put the file main.sublime-distro into your package, the package will be downloaded by the package downloader. That is, it’s part of a core distribution of plugins.

If you put not-for-distribution.sublime-distro into your package, this package is not built into those available for download. This means you can develop using source control, and share with other developers, without having that package available to users.

0 Likes

#3

I have just updated the information above to reflect the changes over at http://www.sublimetextwiki.com.

Read more about those changes here; https://forum.sublimetext.com/t/sublimetextwiki-is-now-a-package-repository/136/1

0 Likes

#4

An improvement to the package repository; whenever someone checks in, it’ll automatically update the package repository at sublimetextwiki.com. So that site will always be perfectly up-to-date with the google subversion repository.

0 Likes