Skip to content

A magic command for sublime. Manage multiple commands with the same hotkey based on advanced contexts.

License

Notifications You must be signed in to change notification settings

mreq/SublimeMagic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

dc93c28 · Jan 7, 2017

History

34 Commits
Jan 7, 2017
Jan 7, 2017
Oct 30, 2016
Jan 7, 2017
Jan 7, 2017
Dec 26, 2016
Oct 30, 2016
Jan 7, 2017
Dec 26, 2016
Jul 23, 2016
Dec 26, 2016
Jan 7, 2017
Dec 26, 2016
Dec 26, 2016

Repository files navigation

★ SublimeMagic

A magic command for sublime. Create a spellbook, cast spells on your code, make magic happen.

What?

SublimeMagic provides a sublime_magic command, which looks through user-defined actions and performs the first matching one.

Use the spell hotkey!

Default keybind is alt + spacebar but you can set your own. To use the plugin, you have to bind the sublime_magic command.

Regular example:

{
  "keys": ["ctrl+,"],
  "command": "sublime_magic"
}

Vintageous example:

{
  "keys": [" ", " "],
  "command": "sublime_magic",
  "context": [{ "key": "vi_command_mode_aware" }]
}

Create your spellbook!

The spellbook (your sublime-settings file) consists of a single spells array containing the user-defined spells:

{
  "spells": []
}

The spells are iterated one-by-one and the first one matching the context conditions is casted. When there's no spell matching, nothing happens. When there are multiple matching spells, only the top-most one is performed.

Spell

Each spell consists of the following required fields:

Spells can be limited by settings a context (similar to key bindings, though not using the same syntax). Known context keys:

  • scope - an array of required scope names (using regexp) - all patterns must match
  • line_matches - an array of patterns that the current line must match
  • selection_empty - when true, some text has to be selected; when false, there must be no selection
  • selection_matches - an array of patterns that the currently selected text must match
  • need more? - make an issue, or even better a PR :)

Spell example

{
  "name": "Replace single quoted content with clipboard",
  "context": {
    "scope": ["string\\.quoted\\.single"]
  },
  "spell": "replace_text",
  "args": {
    "where": "inside",
    "delimiter": "'",
    "replacement": "$clipboard"
  }
}

Available spells

Example spellbook

Have a nice spellbook? Create a pull request and let me add a link here!

Spellbooks:

A simple example:

{
  "spells": [
    {
      "name": "Replace single quoted content with clipboard",
      "context": {
        "scope": ["string\\.quoted\\.single"]
      },
      "spell": "replace_text",
      "args": {
        "where": "inside",
        "delimiter": "'",
        "replacement": "$clipboard"
      }
    },
    {
      "name": "Replace double quoted content with clipboard",
      "context": {
        "scope": ["string\\.quoted\\.double"]
      },
      "spell": "replace_text",
      "args": {
        "where": "inside",
        "delimiter": "\"",
        "replacement": "$clipboard"
      }
    },
    {
      "name": "Replace content after colon with clipboard",
      "context": {
        "line_matches": [": "]
      },
      "spell": "replace_text",
      "args": {
        "where": "after",
        "delimiter": ": ",
        "replacement": "$clipboard"
      }
    }
  ]
}

About

A magic command for sublime. Manage multiple commands with the same hotkey based on advanced contexts.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages