Project Tree Templater - Bring templates to your project!

Introduction

This is a simple plugin for Sublime Text 3 to create a template for your project. Imagine that you're creating your project literally from zero. You first have to create a folder called “css” where you will put all your CSS files in. Like before, you'll do a “js” folder, where you'll put your Javascript files in. And finally you'll create also an index.html where you will put your HTML inside of it.

Of course, this could be the probably not-common case of work, but in fact, sometimes happenes, from creating templates to starting little projects.

Today, with this plugin you can automate all your work, with only a few line of meta declarations, and everytime your project file will be saved, it will be reflected to your project folder. Simple as it should be.

How it works

The only thing you have to do is creating a my_project_name_here.stprj file wherever you want, remember that EVERYTHING will be created in the same place where, that file, will be saved.

After that, what you have to do is declaring your project structure as likely you're used to do manually. For example, the project mentioned in the Introduction before, could be written as the following:

css/
js/
index.html

Yes, that's it. Pretty simple and clean! Does it sound familiar? Yeah, Unix path declaration. Nothing more, you have all the basis you would need to use this plugin. Nothing new.

Reference

• To simply place a comment in your source script use the # character as the first character of your line. An example of use would be:

  # Example of comment
  

• To simply remove any file from your project everytime you save place the - character as the first character of your line. An example of use would be:

  -css/style.css
  

  but let we suppose we're going to remove all files inside the folder (and the folder itself), then we have to write:

  -css/*
  

  or you can also write

  -css
  

  since it will autodetect if it's a folder. Notice that this is just the same syntax as -css/*.

• To place a default template for every file which will be created with that extension we will use the ? character as the first character of your line. An example of use would be:

  ?css:path/to/tpl.css
  ...
  css/style.css
  

  remember that global templates MUST be declared before ANY path declaration.

• To place a single template for a single file, overriding also the global template (if it exists), we have to write the : character AFTER the path declaration. An example of use would be:

  css/style.css:path/to/tpl.css
  

• You can now use URLs (http or https) to download resources (even in templates or in single files). Just put your URL after the : charater. An example of use would be:

  js/jquery-latest.min.js:http://code.jquery.com/jquery-latest.min.js
  

• NEW! You can use Groups! It's nothing special, it's just a parent directory that will contain any path inside of it. An example of use woud be:

  foo (
      css/
      js/
      index.html
  )
  

or also

foo/bar (
        css/
        js/
        index.html
    )

And remember!

If you place a / character at the beginning of any path (template or not), the path will be always considered RELATIVE to the project file.

How to install

Soon it will be available to Sublime Package Control. So what you have to do is: press code>Ctrl+Shift+P, type install, press Enter then type ProjectTreeTemplater and finally press again the Enter key.

In the meanwhile, to install it you just have to download a copy of this folder, and copy it to the one of your already existing packages. To find it, simply open Sublime Text and then do

Preferences -> Browse Packages...

and place it inside that folder.

License

See LICENSE.

Last but not least

This plugin is far from perfect, so if you find any bug you're free to contribute :)