Skip to content

Commit a74438b

Browse files
tscpptscpp
committed
Initial import
0 parents  commit a74438b

17 files changed

Lines changed: 531 additions & 0 deletions

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
*.vsix
3+
dist

‎.vscode/launch.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Extension",
6+
"type": "extensionHost",
7+
"request": "launch",
8+
"args": [
9+
"--extensionDevelopmentPath=${workspaceFolder}"
10+
],
11+
"outFiles": [
12+
"${workspaceFolder}/dist/**/*.js"
13+
],
14+
"preLaunchTask": "${defaultBuildTask}"
15+
}
16+
]
17+
}

‎.vscode/settings.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"search.exclude": {
3+
"dist": true
4+
},
5+
"typescript.tsc.autoDetect": "off"
6+
}

‎.vscode/tasks.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"type": "npm",
6+
"script": "watch",
7+
"problemMatcher": "$tsc-watch",
8+
"isBackground": true,
9+
"presentation": {
10+
"reveal": "never"
11+
},
12+
"group": {
13+
"kind": "build",
14+
"isDefault": true
15+
}
16+
}
17+
]
18+
}

‎.vscodeignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.vscode/**
2+
.vscode-test/**
3+
src/**
4+
.gitignore
5+
vsc-extension-quickstart.md
6+
tsconfig.json

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
All notable changes to the "xit" extension will be documented in this file.
4+
5+
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
6+
7+
## [Unreleased]
8+
9+
- Initial release

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Elias Skogevall
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# xit!
2+
3+
This extension provides language support for [xit!](https://xit.jotaen.net/).
4+
5+
- [Syntax Highlighting](#syntax-highlighting)
6+
- [Shortcuts](#shortcuts)
7+
- [Snippets](#snippets)
8+
9+
## Syntax Highlighting
10+
11+
![screenshot showing the syntax highlighting](assets/screenshots/01.png)
12+
13+
### Customization
14+
15+
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.
16+
17+
```json
18+
{
19+
"editor.tokenColorCustomizations": {
20+
"textMateRules": [{
21+
// Replace this with the scope you want to edit.
22+
// Available scopes are:
23+
// - markup.other.task.title.xit
24+
// - markup.other.task.checkbox.open.xit
25+
// - markup.other.task.checkbox.ongoing.xit
26+
// - markup.other.task.checkbox.checked.xit
27+
// - markup.other.task.checkbox.obsolete.xit
28+
// - markup.other.task.description.closed.xit
29+
// - markup.other.task.priority.xit
30+
// - markup.other.task.date.xit
31+
// - markup.other.task.tag.xit
32+
"scope": "markup.other.task.checkbox.open.xit",
33+
"settings": {
34+
// Customize open checkbox color
35+
"foreground": "#00FF00",
36+
// ... and the fontStyle
37+
"fontStyle": "bold"
38+
}
39+
}]
40+
}
41+
}
42+
```
43+
44+
### Strikethrough Not Working?
45+
46+
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.
47+
48+
```json
49+
{
50+
"editor.tokenColorCustomizations": {
51+
"[Theme That Is Not Working]": {
52+
"textMateRules": [
53+
{
54+
"scope": "markup.strikethrough",
55+
"settings": {
56+
"fontStyle": "strikethrough"
57+
}
58+
}
59+
]
60+
}
61+
}
62+
}
63+
```
64+
65+
## Shortcuts
66+
67+
The extension provides shortcuts for toggling/shuffling checkbox state. The shortcuts are configured by default as shown below:
68+
69+
- `ctrl+space` - Toggle checkboxes if available, else trigger editor suggestions.
70+
- `ctrl+alt+x` - Toggle all selected checkboxes.
71+
- `ctrl+alt+d` - Shuffle all selected checkboxes. This will shift the checkbox state to `' ' -> '@' -> '~' -> 'x'`.
72+
73+
## Snippets
74+
75+
- `u` - Unchecked (`[ ] `)
76+
- `a`/`@` - Ongoing (`[@] `)
77+
- `o`/`~` - Obsolete (`[~] `)
78+
- `x` - Unchecked (`[x] `)

‎assets/screenshots/01.png‎

17.1 KB
Loading

0 commit comments

Comments
 (0)