ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Tmpl

by kairyou ST2/ST3

Create File From Templates for ST2/ST3.

Labels file creation

Details

Installs

  • Total 134K
  • Win 106K
  • OS X 19K
  • Linux 9K
Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22
Windows 7 55 59 44 72 36 37 53 119 57 59 74 18 52 53 73 72 61 62 29 39 50 55 51 61 44 22 36 69 65 48 46 55 36 34 49 58 63 44 68 42 25 60 50 59 49
OS X 0 7 8 8 9 7 8 5 6 13 13 11 3 5 5 10 8 6 9 2 2 5 9 6 8 7 5 3 14 10 9 10 8 5 1 5 10 6 10 7 6 5 8 9 4 8
Linux 0 4 3 5 2 5 4 2 3 5 4 3 4 1 0 1 1 6 2 0 2 1 3 1 3 2 3 4 0 4 2 4 4 5 1 3 5 3 2 3 2 4 4 3 4 4

Readme

Source
raw.​githubusercontent.​com

SublimeTmpl

A Sublime Text 2/3 plugin for create file from templates.

Installation

Github

Go to the “Packages” directory (Preferences / Browse Packages). Then clone this repository:

$ git clone https://github.com/kairyou/SublimeTmpl.git

Package Control

Install Package Control. Then Package Control: Install Package, look for SublimeTmpl / tmpl and install it.

Usage

  • Create file with menu File - New File (SublimeTmpl)

  • Create file with command use cmd+shift+p then look for tmpl:

Settings

Default Settings: Preferences > Packages Settings > SublimeTmpl > Settings - Default

Custom settings (*Recommend): Preferences > Package Settings > SublimeTmpl > Settings - User

Default template files: Packages/SublimeTmpl/templates

Custom template files (Recommend): Packages/User/SublimeTmpl/templates/

Project-specific template files (ST3 only): via settings: SublimeTmpl: template_folder key within your sublime-project file (see “Features added” below)

Default key bindings

ctrl+alt+h html
ctrl+alt+j javascript
ctrl+alt+c css
ctrl+alt+p php
ctrl+alt+r ruby
ctrl+alt+shift+p python

Disable shortcuts

If you’re unhappy with default keymap, you can disable keyboard shortcuts with disable_keymap_actions preference of SublimeTmpl.sublime-settings.

Use a comma-separated list of action names which default keyboard shortcuts should be disabled. For example, if you want to disable creat html and css shortcuts, your must set the following value:

"disabled_keymap_actions": "html, css"

To disable all default shortcuts, set value to all.

Features added

  • custom template files

    put your custom template files in Packages/User/SublimeTmpl/templates Project-specific template files can be specified in project files, along with overriding other templating options.

  • *.tmpl file support ${date} variable

    default “date_format” : “%Y-%m-%d %H:%M:%S” .

  • *.tmpl file support ${saved_filename}, ${saved_filepath} on save file

    Enable: SublimeTmpl > settings - user add "enable_file_variables_on_save": true,

  • *.tmpl file support ${project_base_name}, ${project_path} and ${platform}

    NOTE: This will only work with SublimeText 3.0 or above.

    Enable: SublimeTmpl > settings - user add "enable_project_variables": true,

It is recommended that you put your own custom settings in settings - user. Please see note below in “*Detailed Instructions for Sublime Newbies”

  • custom variables: attr

    custom the attr variables in settings, example:

"attr": {
        "author": "Your Name" ,
        "email": "you@example.org",
        "link": "http://example.org",
        "hello": "word"
    }
> The `*.tmpl` file will support `${author}` `${email}` `${link}` `${hello}` variables.
  • Project specific overrides via SublimeTmpl attribute in sublime-project file. >
"settings":
    {
        "SublimeTmpl":
        {
            "template_folder": "Path\\to\\some\\custom\\template\\folder",
            "template_replace_pattern": "{{%s}}",
            "enable_project_variables": true,
            "enable_file_variables_on_save": true,
            "attr": {  // Fully overrides "attr" settings (i.e. elements missing here will not attempt to be replaced in template)
                "author": "Alternative Name"
            },
            "project_variables": {
                // Allows for use with other template formats, provide mapping here
                // "tmpl_formatted_name": "current_template_name"
                "project_base_name": "projectbase",
                "project_path": "projectpath",
                "platform": "plat"
            },

            "file_variables_on_save": {
                // Allows for use with other template formats, provide mapping here
                // "tmpl_formatted_name": "current_template_name"
                "saved_filename": "name",
                "saved_filepath": "filepath"
            },
        },
    },

*Detailed Instructions for Sublime Newbies

Sublime Text keeps settings in bunch of files in a folder. For example, OS X, it is located at

/Users/yourusername/Library/Application Support/Sublime Text 3/Packages

You can navigate to it easily by using the following menu item in Sublime, for example: Sublime Text>Preferences>Browse Packages

Now go to Packages\SublimeTmpl folder and open the file SublimeTmpl.sublime-settings. Save the file with the same file name under Packages\User. Delete everything except the variables that are custom to you. By the time you are finished, the file might look as simple as this (JSON format):

{
    "attr": {
        "author": "Chuck Norris" ,
        "email": "chuck@kickbutt.com",
    }
}

If you don't want the "link" and "hello" variables to show up, you should copy the (for example) python.tmpl file to Packages/User/SublimeTmpl/templates and remove those elements from it.

Contributors

Donate

PayPal donate button

FAQ

  • SublimeTmpl not work after update the package.

    Please open Preferences / Settings - User, remove “SublimeTmpl” from ignored_packages.


Source: https://github.com/kairyou/SublimeTmpl

Docs: 中文文档