Can i add date time for sublime snippet?

user_770721 0
Viewed 17577

I want to create a snippet that will add a file comment, but I want the snippet to create the DateTime automatically. Can a sublime snippet do that?

<snippet>
    <content><![CDATA[
/**
 * Author:      $1
 * DateTime:    $2
 * Description: $3
 */

]]></content>
    <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
    <tabTrigger>/header</tabTrigger>
    <!-- Optional: Set a scope to limit where the snippet will trigger -->
    <scope>source.css,source.js,source.php</scope>
</snippet>
sublimetext2
7 Answers

I just implement this function (on sublime3) by a simple plugin and the metadata file (.tmPreference file), but I don't know whether this is efficient. There is the way,

1. create a .tmPreference file, put some variables you want to use in snippets. There is an example, you can save the cotent in Packages/User/Default.tmPreference

<plist version="1.0">
<dict>
    <key>name</key>
    <string>Global</string>
    <key>scope</key>
    <string />
    <key>settings</key>
    <dict>
        <key>shellVariables</key>
        <array>
            <dict>
                <key>name</key>
                <string>TM_YEAR</string>
                <key>value</key>
                <string>2019</string>
            </dict>
            <dict>
                <key>name</key>
                <string>TM_DATE</string>
                <key>value</key>
                <string>2019-06-15</string>
            </dict>
            <dict>
                <key>name</key>
                <string>TM_TIME</string>
                <key>value</key>
                <string>22:51:16</string>
            </dict>
        </array>
    </dict>
</dict>
</plist>

2. create a plugin, which will update the shell variables in .tmPreference file when the plugin loaded.

import sublime, sublime_plugin
import time
from xml.etree import ElementTree as ET

# everytime when plugin loaded, it will update the .tmPreferences file.
def plugin_loaded():
    # res = sublime.load_resource('Packages/User/Default.tmPreferences')
    # root = ET.fromstring(res)
    meta_info = sublime.packages_path() + '\\User\\Default.tmPreferences'
    tree = ET.parse(meta_info)
    eles = tree.getroot().find('dict').find('dict').find('array').findall('dict')

    y = time.strftime("%Y", time.localtime())
    d = time.strftime("%Y-%m-%d", time.localtime())
    t = time.strftime("%H:%M:%S", time.localtime())

    for ele in eles:
        kvs = ele.getchildren()
        if kvs[1].text == 'TM_YEAR':
            if kvs[3].text != y:
                kvs[3].text = y
                continue
        elif kvs[1].text == 'TM_DATE':
            if kvs[3].text != d:
                kvs[3].text = d
                continue
        elif kvs[1].text == 'TM_TIME':
            if kvs[3].text != t:
                kvs[3].text = t
                continue

    tree.write(meta_info)

3. use the shell variable you defined in .tmPreference file.

<snippet>
    <content><![CDATA[
/**
  ******************************************************************************
  * \brief      ${1:}
  * \file       $TM_FILENAME
  * \date       $TM_DATE
  * \details    
  ******************************************************************************
  */

${0:}

/****************************** Copy right $TM_YEAR *******************************/
        ]]></content>
    <!-- Optional: Tab trigger to activate the snippet -->
    <tabTrigger>cfc</tabTrigger>
    <!-- Optional: Scope the tab trigger will be active in -->
    <scope>source.c, source.c++</scope>
    <!-- Optional: Description to show in the menu -->
    <description>c file comment</description>
</snippet>
user_68443190

It solved in https://github.com/ngocjr7/sublime-snippet-timestamp

Copy all file to Packages/User directory of sublime text.

Configure sublime-snippet file as you want ( cpp_template.sublime-snippet for c++ and py_template.sublime-snippet for python)

Now you can create a simple snippet and the date will be updated every time you press command + s. command + s still has the function to save files.

Explaination

Because snippet doesnot support dynamic variable, I use static variable DATE define in Default.tmPreferences and update this variable when we want to create snippet.

I use a plugin (command) updatetm to update DATE in Default.tmPreferences.

I want the date and time to be updated automatically or at least passive. So I added a function that called updatetm command for keystrockes command + s. To do this, I use another plugin is chain.py to call multiple command on a keymap (both updatetm command and the default command (save). Keymap defined in Default (OSX).sublime-snippet file.

user_82710120
Related