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

xit!

by jotaen ST3

[x]it! support for working with todo and check list files in Sublime Text

Details

Installs

  • Total 208
  • Win 69
  • Mac 99
  • Linux 40
May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2
Windows 0 0 0 0 1 0 2 0 2 0 1 0 1 1 1 2 0 2 1 2 1 2 1 0 1 0 1 2 0 2 1 0 0 0 0 1 0 1 1 2 2 2 5 12 4 10
Mac 3 0 0 1 0 0 0 0 0 0 0 0 0 1 0 1 0 0 2 0 0 0 0 0 0 1 1 0 2 0 1 0 3 2 2 0 7 1 1 1 4 4 12 14 5 23
Linux 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 1 1 1 1 0 0 0 0 1 0 0 1 0 1 0 2 0 1 0 0 0 0 3 0 0 1 2 5 16

Readme

Source
raw.​githubusercontent.​com

[x]it! for Sublime Text

This Sublime Package provides syntax-highlighting, shortcuts, and auto-completions for [x]it! files.

[x]it! demo

Features

  • Syntax highlighting
  • Shortcut commands for toggling the item status
  • Smart completions for due dates
    • Type e.g. 5w and have auto-complete resolve it to the date in 5 weeks from now. Works with d (days), w (weeks), m (months), and y (years), and any number prefix.
  • Some sensible default settings (e.g. indentation style)

Configuration

Keybindings for Commands

The following commands are available for you to put into your Default.sublime-keymap file. The key combination is up to you, of course.

[
    // Toggle checkbox status of the item.
    // It cycles through the statuses given in the
    // `xit_toggle` setting.
    { "keys": ["ctrl+shift+t"], "command": "xit_toggle" },

    // Set item status to checked [x]
    { "keys": ["ctrl+shift+x"], "command": "xit_check" },

    // Set item status to open [ ]
    { "keys": ["ctrl+shift+o"], "command": "xit_open" },

    // Set item status to ongoing [@]
    { "keys": ["ctrl+shift+a"], "command": "xit_ongoing" },

    // Set item status to obsolete [~]
    { "keys": ["ctrl+shift+n"], "command": "xit_obsolete" },
]

Settings (Syntax Specific)

The following settings can be overriden via your syntax-specific xit.sublime-settings file. The values shown below are the default ones.

{
    // Auto-save after toggling checkboxes (via the commands `xit_check`, etc.).
    "xit_auto_save": true,

    // The checkbox statuses that the `xit_toggle` command
    // should cycle through.
    "xit_toggle": ["[ ]", "[x]"],
}

Syntax Highlighting / Colour overrides

The pre-defined syntax highlighting should look meaningful in most available colour schemes.

For [x]it! specific customisations or fixes, you can specify the following colour overrides:

  • markup.other.title.xit For the item group title
  • markup.other.checkbox.open.xit For an open checkbox: [ ]
  • markup.other.checkbox.checked.xit For a checked checkbox: [x]
  • markup.other.checkbox.ongoing.xit For an ongoing checkbox: [@]
  • markup.other.checkbox.obsolete.xit For an obsolete checkbox: [~]
  • markup.other.priority.exclamation.xit For the exclamation mark of the priority: !
  • markup.other.priority.dot.xit For the dot of the priority: .
  • markup.other.description.xit For the item description
  • markup.other.due_date.xit For the due date within the description: -> 2022-03-27
  • markup.other.tag.name.xit For a tag: #example
  • markup.other.tag.value.xit For the value of a tag: #example=value

Additionally, you can reference the following meta scopes to make adjustments based on the item status:

  • meta.item.status.open.xit
  • meta.item.status.checked.xit
  • meta.item.status.ongoing.xit
  • meta.item.status.obsolete.xit

Please also see here for a complete colouring example based on a dark scheme.

You can also configure Sublime to always use a specific colour scheme with [x]it!. This is especially useful if the default colours don’t work out in your regular colour scheme. You can specify this in your syntax-specific xit.sublime-settings file:

{
    // Always use the Monokai scheme for [x]it!
    "color_scheme": "Monokai.sublime-color-scheme"
}