https://github.com/tscpp/xit-vscode
Language support for todo lists with xit syntax.
https://github.com/tscpp/xit-vscode
Last synced: 8 months ago
JSON representation
Language support for todo lists with xit syntax.
- Host: GitHub
- URL: https://github.com/tscpp/xit-vscode
- Owner: tscpp
- License: mit
- Created: 2022-04-02T18:07:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-23T18:14:29.000Z (over 2 years ago)
- Last Synced: 2025-02-26T02:17:50.375Z (10 months ago)
- Language: TypeScript
- Size: 31.3 KB
- Stars: 6
- Watchers: 1
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# xit!
This extension provides language support for [xit!](https://xit.jotaen.net/).
- [Syntax Highlighting](#syntax-highlighting)
- [Shortcuts](#shortcuts)
- [Snippets](#snippets)
## Syntax Highlighting
### Customization
If the colors and looks of the syntax highlighting is not correct or as fancy as you want to, you can try to edit the `tokenColorCustomizations` in the user settings.
```json
{
"editor.tokenColorCustomizations": {
"textMateRules": [{
// Replace this with the scope you want to edit.
// Available scopes are:
// - markup.other.task.title.xit
// - markup.other.task.checkbox.open.xit
// - markup.other.task.checkbox.ongoing.xit
// - markup.other.task.checkbox.checked.xit
// - markup.other.task.checkbox.obsolete.xit
// - markup.other.task.checkbox.inquestion.xit
// - markup.other.task.description.closed.xit
// - markup.other.task.priority.xit
// - markup.other.task.date.xit
// - markup.other.task.tag.xit
"scope": "markup.other.task.checkbox.open.xit",
"settings": {
// Customize open checkbox color
"foreground": "#00FF00",
// ... and the fontStyle
"fontStyle": "bold"
}
}]
}
}
```
### Strikethrough Not Working?
If closed tasks (completed/obsolete) are not striketroughed, then you may want to explicitly specify that the strikethrough scope is striketroughed. This is happening because your theme did not specify the striketrough rule.
```json
{
"editor.tokenColorCustomizations": {
"[Theme That Is Not Working]": {
"textMateRules": [
{
"scope": "markup.strikethrough",
"settings": {
"fontStyle": "strikethrough"
}
}
]
}
}
}
```
## Shortcuts
The extension provides shortcuts for toggling/shuffling checkbox state. The shortcuts are configured by default as shown below:
- `ctrl+space` - Toggle checkboxes if available, else trigger editor suggestions.
- `ctrl+alt+x` - Toggle all selected checkboxes.
- `ctrl+alt+d` - Shuffle all selected checkboxes. This will shift the checkbox state to `' ' -> '@' -> '~' -> 'x'`.
## Snippets
- `u` - Unchecked (`[ ] `)
- `a`/`@` - Ongoing (`[@] `)
- `o`/`~` - Obsolete (`[~] `)
- `x` - Checked (`[x] `)
- `q` - Question (`[?] `)