FileHeader
A powerful file templating plugin for Sublime Text
Details
Installs
- Total 49K
- Win 31K
- Mac 10K
- Linux 7K
| May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | Apr 29 | Apr 28 | Apr 27 | Apr 26 | Apr 25 | Apr 24 | Apr 23 | Apr 22 | Apr 21 | Apr 20 | Apr 19 | Apr 18 | Apr 17 | Apr 16 | Apr 15 | Apr 14 | Apr 13 | Apr 12 | Apr 11 | Apr 10 | Apr 9 | Apr 8 | Apr 7 | Apr 6 | Apr 5 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 3 | 0 | 1 | 3 | 6 | 4 | 1 | 0 | 0 | 3 | 1 | 2 | 0 | 1 | 4 | 0 | 1 | 0 | 0 | 4 | 2 | 2 | 3 | 1 | 0 | 0 | 2 | 1 | 0 | 0 | 3 | 2 | 0 | 4 | 3 | 1 | 0 | 1 | 0 | 1 | 3 | 5 | 2 | 2 | 2 | 1 |
| Mac | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 1 | 3 | 0 | 0 | 2 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 2 | 0 | 0 | 1 | 6 | 0 | 0 | 1 | 0 | 3 | 0 | 1 | 0 | 0 | 0 | 1 | 0 |
| Linux | 2 | 1 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 1 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
FileHeader
FileHeader is a powerful file templating plugin for SublimeText 2 and SublimeText 3. It makes it easier to create new file with initial contents. It also can add new header to an existed file or directory.
Features
- Add new file with initial contents.
- Auto detect New File action from SulimeText or other plugin.
- Add header to an existed file or directory.
- Batch add header to files in the specified directory.
- Auto update file last modified time and last modified by.
- Auto detect file type.
- Powerful template with Jinja2.
- Custom templates supported.
- Rich languages supported.
- Support both Sublime Text 2 and Sublime Text 3.
Installation
Package Control
Install Package Control. Then Package Control: Install Package, look for FileHeader and install it.
Source Installation
Go to the "Packages" directory (Preferences / Browse Packages). Then clone this repository:
git clone git@github.com:shiyanhui/FileHeader.git
Or download zip from Github, and put it in "Packages" directory (Preferences / Browse Packages).
Usage
Create a new file
Sidebar Menu
Shortcuts
The default shortcuts is super+alt+n on OS X, ctrl+alt+n on Windows and Linux.
Context Menu
Similar to Sidebar Menu.
Add header to an existed file
Sidebar Menu
Shortcuts
The default shortcuts is super+alt+a on OS X, ctrl+alt+a on Windows and Linux.
Context Menu
Similar to Sidebar Menu.
Add header to files in the specified directory
Sidebar Menu
A very important feature of FileHeader is that it can automatically update last_modified_time and last_modified_by (see options below). Just look this picture, take care of the @Last modified time: before save and after save:
Settings
There are two kinds of arguments: options and kinds of languages variables settings. options is the functional setting, Default is the default language variables settings. Language variables setting will cover that in Default.
Open Preferences => Package Settings => File Header => Settings - Default for more details.
Template
FileHeader use Jinja2 template, find out how to use it here.
The template is made up of header and body. You also can write you own templates. Take the Python template header Python.tmpl for example.
{{ }} is variable, you can set it in setting files. create_time will be set when you create a new file using FileHeader, last_modified_time and last_modified_by will be update every time you save your file.
You can define your functions and classes or other contents in your body file. Also take Python template body for example.
class MyClass(object): pass if __name__ == '__main__': pass
FAQ
How to customize my headers?
Set custom_template_header_path to your path of customized header in user-settings, for example, ~/header/
NOTE: DO NOT modify directly that in Packages/FileHeader
What if FileHeader conflicts with other file template plugin?
For example, FileHeader and Javatar conflicts in files with extension .java.
The solution is, open any file with extension .java in sublime text, and open Preferences ==> Settings - More ==> Syntax Specific - User, then add "enable_add_template_to_empty_file": false.
What if key-map of FileHeader conflicts with others?
Just change that of FileHeader or others.
Other Editors
If you have any questions, please let me know. 🙂