predragnikolic / InlineFold

A Sublime Text plugin that is useful to fold regions into a single line.
MIT License
7 stars 2 forks source link
fold plugin sublime-text tailwindcss

InlineFold

A Sublime Text plugin that is useful to fold regions into a single line.
It can be useful to hide long strings (for example, TailwindCSS classes).

If the cursor is on the same line where the text was folded because of the "inline_fold.rules",
the text will be shown,
else the text will be folded.

output

Set Fold Regions Globally

From the top menu, select Preferences > Settings and specify the "inline_fold.rules" setting:

// Preferences.sublime-settings
{
    "inline_fold.rules": [
        {
            // Example: <div class="..."></div>
            "fold_selector": "string.quoted.single - punctuation.definition.string, string.quoted.double - punctuation.definition.string",
            "preceding_text": "class,className",
        }
    ]
}

Set Fold Regions per Syntax

If a rule is specific to a particular syntax, for example, Python. Open a Python file. Click Preferences > Settings - Syntax Specific and specify the "inline_fold.rules". Those rules will only apply to Python files:

// Python.sublime-settings
{
    "inline_fold.rules": [
        {
            // Example: view.run_command(...)
            // The `- punctuation.section.arguments.begin` will not fold the open bracket
            // The `- punctuation.section.arguments.end` will not fold the close bracket
            "fold_selector": "meta.function-call.arguments.python - punctuation.section.arguments.begin - punctuation.section.arguments.end",
        }
    ]
}

Examples

Here is a few examples:

{
    "inline_fold.rules": [
        // Fold TailwindCSS class names
        // Example: <div class="..."></div>
        {
            "fold_selector": "string.quoted.single - punctuation.definition.string, string.quoted.double - punctuation.definition.string",
            "preceding_text": "class,className",
        },

        // [Python] Fold docstring except for the first line of the docs string.
        // class Person:
        //     """
        //     Some really long docs string. ..."""
        {
            "fold_selector": "comment.block.documentation.python - punctuation.definition.comment",
        }
    ]
}

For more example go here.