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 397
  • Win 144
  • Mac 191
  • Linux 62
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 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22
Windows 2 1 0 0 0 1 0 2 0 1 0 0 0 1 0 0 1 1 0 0 0 0 1 3 0 0 0 1 3 0 2 0 2 1 1 2 1 1 2 0 3 1 7 11 5
Mac 0 0 0 0 1 0 0 0 0 1 0 1 1 1 0 2 0 0 0 0 0 0 1 2 0 2 1 1 2 0 2 1 0 0 0 0 4 6 1 0 3 2 9 20 14
Linux 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 1 0 3 0 4 5 1

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"
}