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

Context

by shagabutdinov ST2/ST3

Context checking for plugins

Details

Installs

  • Total 765
  • Win 441
  • OS X 186
  • Linux 138
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 Sep 8 Sep 7 Sep 6
Windows 0 0 1 1 0 0 0 2 1 0 0 0 0 1 1 0 0 0 0 0 1 2 0 1 1 0 0 0 0 1 0 0 1 1 2 3 1 1 1 0 1 0 0 1 0
OS X 0 2 1 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 1 2 0 0 0 0 1 0 0 0 0 0 2 1
Linux 0 2 0 0 0 0 1 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 1 0 1 1 0 0 0 0 0 1 0 0 0 2 0 1 0 1 0

Readme

Source
raw.​githubusercontent.​com

Context

Low-level plugin that provides “check context” functionality for other plugins just like “context” section in .sublime-keymap works.

It also provides several basic contexts that can be used with this library or in .sublime-keymap files. This conexts are listed below.

Installation

This plugin is part of sublime-enhanced plugin set. You can install sublime-enhanced and this plugin will be installed automatically.

If you would like to install this package separately check “Installing packages separately” section of sublime-enhanced package.

Dependecies

None

Api

context.check(view, context)

Check given context in given view. If one of contexts passed to array returns false result of call will be false. If no context key found, exception will be raised.

  • view - view (sublime.View) where context should be checked

  • context - array of dicts with following format:

    [
      {
        "key": key,
        "operator": operator,
        "operand": value,
        "match_all" true/false,
      },
    
      {
        "key": key,
        "operator": operator,
        "operand": value,
      },
    
      // ...
    ]
    
  • key - context key (string) that will be checked by corresponding plugin; refer to context providers plugins to see which keys can be passed to this parameter

  • operator - string that can one following values: 'equal', 'not_equal', 'regex_match', 'not_regex_match', 'regex_contains', 'not_regex_contains'

  • operand - value that should be applied to key with operator

  • match_all - match all cursors with provided context or one is enought

Examples

from Context import context

class TestCommand(sublime_plugin.TextCommand):
  def run(self, edit):
    is_python_file = {
      "key": "file_name",
      "operator": "regex_contains",
      "operand": "py$",
    }

    is_file_in_tests = {
      "key": "file_name",
      "operator": "regex_contains",
      "operand": "/tests/",
    }

    if context.check(self.view, [is_python_file, is_file_in_tests]):
      print("This file is python file in tests directory!")

Provided context keys

  • file_name - is name of file matches provided regexp
  • selection_empty - is selection empty
  • selection_b_greater_or_equal_a - is sel.b >= sel.a
  • selection_b_greater_a - is sel.b > sel.a
  • selection_b_lesser_or_equal_a - is sel.b <= sel.a
  • selection_b_lesser_a - is sel.b < sel.a
  • line_b - line that contains sel.b: view.substr(view.line(sel.b))
  • following_text_a - text to EOL after sel.a
  • following_text_b - text to EOL after sel.b
  • following_text_begin - text to EOL after min(sel.a, sel.b)
  • following_text_end - text to EOL after max(sel.a, sel.b)
  • preceding_text_a - text to BOL before a
  • preceding_text_b - text to BOL before b
  • preceding_text_begin - text to BOL before min(sel.a, sel.b)
  • preceding_text_end - text to BOL before max(sel.a, sel.b)

Conflicts

  • Arctic Type Script - it defines same context values which work differently