AutoSetSyntax

by jfcherng ST3

This plugin automatically sets the syntax for your file if possible.

Details

Version 1.10.8
Homepage github.com
Issues github.com
Modified 3 months ago
Last Seen 2 hours ago
First Seen 5 years ago

Installs

Total 7K
Win 4K
Mac 1K
Linux 906

	Oct 24	Oct 23	Oct 22	Oct 21	Oct 20	Oct 19	Oct 18	Oct 17	Oct 16	Oct 15	Oct 14	Oct 13	Oct 12	Oct 11	Oct 10	Oct 9	Oct 8	Oct 7	Oct 6	Oct 5	Oct 4	Oct 3	Oct 2	Oct 1	Sep 30	Sep 29	Sep 28	Sep 27	Sep 26	Sep 25	Sep 24	Sep 23	Sep 22	Sep 21	Sep 20	Sep 19	Sep 18	Sep 17	Sep 16	Sep 15	Sep 14	Sep 13	Sep 12	Sep 11	Sep 10	Sep 9
Windows	1	4	1	1	2	2	4	1	2	3	4	8	1	3	2	4	1	4	4	1	3	0	4	1	1	1	0	2	1	2	4	2	4	1	0	4	1	6	4	3	5	0	8	1	5	3
Mac	1	0	0	1	1	2	0	0	0	2	2	0	0	0	2	0	1	2	0	0	0	1	1	2	1	0	0	1	0	0	2	3	1	3	1	1	0	0	0	1	0	0	0	0	0	2
Linux	0	0	1	0	2	0	0	0	0	2	1	2	0	0	2	1	1	0	1	0	2	0	0	2	0	0	0	1	0	0	1	0	0	0	0	0	1	2	0	0	1	0	0	1	1	1

Readme

Source: raw.githubusercontent.com

ST-AutoSetSyntax

This plugin automatically sets the syntax for your file if possible. The original thought comes from here.

Installation

This package is available on Package Control by the name of AutoSetSyntax.

Examples

Guess the Syntax After Stripping Unimportant File Extensions

try-strip-file-exts

config_gitlab.yml.example -> config_gitlab.yml -> Ah! .yml should use the YAML syntax.
See try_filename_remove_exts settings for details.

PHP Tag

php-tag

Create a new tab.
Type <?php.
The syntax will be set to PHP automatically. (triggered by on_modified_async)

Colored Git Log

git-log

Prerequisites: ANSIescape and SideBarGit.
Set your colored git log command. I personally set git config --global alias.l "log --graph --date=short --color --pretty=format:'%C(yellow bold)%h%Creset%C(auto)%d%Creset - %s %C(green bold)[%an]%Creset %C(blue bold)(%ad, %cr)%Creset'".
Add "ANSIescape/ANSI.tmLanguage": ["^\\s*\\[SideBarGit@.*\\] git \\b"] to syntax_mapping.
Add source.diff to working_scope like "working_scope": "(?x)^(text.plain | source.diff)\\b".
Execute your customized git log command. In this example, it is git l as set in the previous step.
The output syntax will be set to ANSI which provides ANSI color rendering. (triggered by on_modified_async)

More Creative Usages To Share

Feel free to create an issue or a pull request.

User Settings

Click to expand

{
    // When should this plugin work?
    "event_listeners": {
        // called when a view gains input focus
        "on_activated_async": true,
        // called when a view is cloned from an existing one
        "on_clone_async": true,
        // called when the file is finished loading
        "on_load_async": true,
        // called after changes have been made to a view
        "on_modified_async": true,
        // called when a new buffer is created
        "on_new_async": true,
        // called after there is a paste operation
        "on_post_paste": true,
        // called just before a view is saved
        "on_pre_save_async": true,
    },
    // The max lookup length for the first line.
    // A negative number means no limitation.
    "first_line_length_max": 80,
    // How detailed log messages should be?
    // "CRITICAL" (very few), "ERROR", "WARNING", "INFO", "DEBUG" (most tedious) or "NOTHING" (no log)
    "log_level": "INFO",
    /**
     * The syntax maaping rules.
     *
     * @key The partial (or full) resource path of a syntax file.
     * @value Regexes to match the first line.
     */
    "syntax_mapping": {
        // "Packages/PHP/PHP.sublime-syntax": [
        //     "<\\?php",
        //     "<\\?=",
        // ],
    },
    // The partial (or full) resource path of the syntax file used when creating a new file.
    // Nothing would happen if this is a empty string.
    "new_file_syntax": "",
    // The scope that this plugin should work (regex).
    // Leave it blank will result in matching any scope.
    "working_scope": "^text\\.plain\\b",
    // Try to remove these file extensions from the file name
    // so a syntax may be assigned due to a stripped file name.
    "try_filename_remove_exts": [
        "-dev",
        "-development",
        "-dist",
        "-prod",
        "-production",
        "-test",
        ".backup",
        ".bak",
        ".default",
        ".dist",
        ".example",
        ".inc",
        ".include",
        ".local",
        ".sample",
        ".test",
        ".tpl",
    ],
}

Commands

You may disable all event_listeners in your user settings and add a key binding to set syntax.

{ "keys": ["ctrl+alt+s", "ctrl+alt+s"], "command": "auto_set_syntax" },

How It Works

When this plugin is loaded:

Construct the syntax mappings.
1. Read all syntax definition files.
2. Try to find following informations.

- `first_line_match` in `.sublime-syntax`s and `firstLineMatch` in `.tmLanguage`s.
  - `file_extensions` in `.sublime-syntax`s and `fileTypes` in `.tmLanguage`s.

Merge syntax_mapping with results from the previous step.
1. If the scope is text.plain, try to remove some extensions from the file name basing on try_filename_remove_exts. A syntax may be assigned due to a stripped file name matches.

When an event is triggered:

May check conditions like cursor counts, cursor position and etc…
Make sure working_scope matches the scope of the first character.
Call command auto_set_syntax.

When command auto_set_syntax is called:

Match extensions with the file name.
Match the first line with file content.
If there is any luck, set the corresponding syntax for the user.

Debug

Debug messages are printed to your Sublime Text console (Ctrl+`), which looks like

AutoSetSyntax: [ERROR] regex compilation failed in user settings "working_scope": ^text.plain\b+
AutoSetSyntax: [WARNING] "event_listeners -> on_pre_save_async" is not set in user settings (assumed true)
AutoSetSyntax: [INFO] match syntax file "php-grammar/PHP." with "Packages/php-grammar/PHP.sublime-syntax"

Auto​Set​Syntax