Skip to content

Commit 8be8055

Browse files
committed
lint all Md files
1 parent 28b7782 commit 8be8055

18 files changed

+141
-143
lines changed

README.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ things, but I've been using it full time since April 2022.
4444

4545
## Download
4646

47-
| Platform / Package | Links | Notes |
48-
| ----------| ----- | ----- |
49-
| macOS | [Tip ("Nightly")](https://github.com/mitchellh/ghostty/releases/tag/tip) | MacOS 12+ Universal Binary |
50-
| Linux | [Build from Source](#developing-ghostty) | |
51-
| Windows | n/a | Not supported yet |
47+
| Platform / Package | Links | Notes |
48+
| ------------------ | ------------------------------------------------------------------------ | -------------------------- |
49+
| macOS | [Tip ("Nightly")](https://github.com/mitchellh/ghostty/releases/tag/tip) | MacOS 12+ Universal Binary |
50+
| Linux | [Build from Source](#developing-ghostty) | |
51+
| Windows | n/a | Not supported yet |
5252

5353
### Configuration
5454

@@ -134,12 +134,12 @@ to support many of the features that
134134

135135
The currently support shell integration features in Ghostty:
136136

137-
* We do not confirm close for windows where the cursor is at a prompt.
138-
* New terminals start in the working directory of the previously focused terminal.
139-
* Complex prompts resize correctly by allowing the shell to redraw the prompt line.
140-
* The cursor at the prompt is turned into a bar.
141-
* The `jump_to_prompt` keybinding can be used to scroll the terminal window
142-
forward and back through prompts.
137+
- We do not confirm close for windows where the cursor is at a prompt.
138+
- New terminals start in the working directory of the previously focused terminal.
139+
- Complex prompts resize correctly by allowing the shell to redraw the prompt line.
140+
- The cursor at the prompt is turned into a bar.
141+
- The `jump_to_prompt` keybinding can be used to scroll the terminal window
142+
forward and back through prompts.
143143

144144
#### Shell Integration Installation and Verification
145145

@@ -208,15 +208,15 @@ goes for any other shell.
208208

209209
The high-level ambitious plan for the project, in order:
210210

211-
| # | Step | Status |
212-
|:---:|------|:------:|
213-
| 1 | [Standards-compliant terminal emulation](docs/sequences.md) | ⚠️ |
214-
| 2 | Competitive performance | |
215-
| 3 | Basic customizability -- fonts, bg colors, etc. | |
216-
| 4 | Richer windowing features -- multi-window, tabbing, panes | |
217-
| 5 | Native Platform Experiences (i.e. Mac Preference Panel) | ⚠️ |
218-
| 6 | Windows Terminals (including PowerShell, Cmd, WSL) | |
219-
| N | Fancy features (to be expanded upon later) | |
211+
| # | Step | Status |
212+
| :-: | ----------------------------------------------------------- | :----: |
213+
| 1 | [Standards-compliant terminal emulation](docs/sequences.md) | ⚠️ |
214+
| 2 | Competitive performance | |
215+
| 3 | Basic customizability -- fonts, bg colors, etc. | |
216+
| 4 | Richer windowing features -- multi-window, tabbing, panes | |
217+
| 5 | Native Platform Experiences (i.e. Mac Preference Panel) | ⚠️ |
218+
| 6 | Windows Terminals (including PowerShell, Cmd, WSL) | |
219+
| N | Fancy features (to be expanded upon later) | |
220220

221221
Additional details for each step in the big roadmap below:
222222

@@ -261,10 +261,10 @@ Ghostty is a cross-platform terminal emulator but we don't aim for a
261261
least-common-denominator experience. There is a large, shared core written
262262
in Zig but we do a lot of platform-native things:
263263

264-
* The macOS app is a true SwiftUI-based application with all the things you
264+
- The macOS app is a true SwiftUI-based application with all the things you
265265
would expect such as real windowing, menu bars, a settings GUI, etc.
266-
* macOS uses a true Metal renderer with CoreText for font discovery.
267-
* The Linux app is built with GTK.
266+
- macOS uses a true Metal renderer with CoreText for font discovery.
267+
- The Linux app is built with GTK.
268268

269269
There are more improvements to be made. The macOS settings window is still
270270
a work-in-progress. Similar improvements will follow with Linux.
@@ -310,11 +310,11 @@ tasks.
310310

311311
Other useful commands:
312312

313-
* `zig build test` for running unit tests.
314-
* `zig build run -Dconformance=<name>` runs a conformance test case from
315-
the `conformance` directory. The `name` is the name of the file. This runs
316-
in the current running terminal emulator so if you want to check the
317-
behavior of this project, you must run this command in ghostty.
313+
- `zig build test` for running unit tests.
314+
- `zig build run -Dconformance=<name>` runs a conformance test case from
315+
the `conformance` directory. The `name` is the name of the file. This runs
316+
in the current running terminal emulator so if you want to check the
317+
behavior of this project, you must run this command in ghostty.
318318

319319
### Compiling a Release Build
320320

README_TESTERS.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -42,28 +42,28 @@ or even pair (time permitting) if you're interested.
4242

4343
This is the priority of bugs:
4444

45-
1. Crashes. 💥 These are just unacceptable and I'll drop everything to
46-
fix a crash.
45+
1. Crashes. 💥 These are just unacceptable and I'll drop everything to
46+
fix a crash.
4747

48-
2. Escape sequence logic or rendering issues. These are almost as bad as
49-
crashes because they usually make your workflow unusable. This includes
50-
unsupported escape sequences that impact your workflow.
48+
2. Escape sequence logic or rendering issues. These are almost as bad as
49+
crashes because they usually make your workflow unusable. This includes
50+
unsupported escape sequences that impact your workflow.
5151

52-
3. Anything else...
52+
3. Anything else...
5353

5454
## Let's Talk!
5555

5656
You likely landed in the Discord community first, if for some reason you're not
57-
in there, join [here](https://discord.gg/ghostty). Discord is a great place to
57+
in there, join [here](https://discord.gg/ghostty). Discord is a great place to
5858
share feedback, discuss issues, ask questions and talk to other testers.
5959

6060
## Other FAQ
6161

6262
### Can I Invite a Friend?
6363

64-
To the Discord, go for it! [discord.gg/ghostty](https://discord.gg/ghostty).
65-
Initially, they'll land in a public Discord channel. As mentioned, testers
66-
are being added slowly as bugs are fixed. Discord is being used as a sort-of
64+
To the Discord, go for it! [discord.gg/ghostty](https://discord.gg/ghostty).
65+
Initially, they'll land in a public Discord channel. As mentioned, testers
66+
are being added slowly as bugs are fixed. Discord is being used as a sort-of
6767
waitlist, and people are added to the project as testers from there,
6868
so just send them the link and they will be added at some point.
6969

TODO.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
Performance:
22

3-
* for scrollback, investigate using segmented list for sufficiently large
3+
- for scrollback, investigate using segmented list for sufficiently large
44
scrollback scenarios.
5-
* Loading fonts on startups should probably happen in multiple threads
6-
* `deleteLines` is very, very slow which makes scroll region benchmarks terrible
5+
- Loading fonts on startups should probably happen in multiple threads
6+
- `deleteLines` is very, very slow which makes scroll region benchmarks terrible
77

88
Correctness:
99

10-
* test wrap against wraptest: https://github.com/mattiase/wraptest
10+
- test wrap against wraptest: https://github.com/mattiase/wraptest
1111
- automate this in some way
12-
* Charsets: UTF-8 vs. ASCII mode
12+
- Charsets: UTF-8 vs. ASCII mode
1313
- we only support UTF-8 input right now
1414
- need fallback glyphs if they're not supported
1515
- can effect a crash using `vttest` menu `3 10` since it tries to parse
1616
ASCII as UTF-8.
1717

1818
Improvements:
1919

20-
* scrollback: configurable
20+
- scrollback: configurable
2121

2222
Mac:
2323

24-
* Preferences window
24+
- Preferences window
2525

2626
Major Features:
2727

28-
* Bell
29-
* Sixels: https://saitoha.github.io/libsixel/
28+
- Bell
29+
- Sixels: https://saitoha.github.io/libsixel/

docs/sequences.md

+32-33
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,44 @@
11
# Control and Escape Sequences
22

3-
⚠️ **This is super out of date. Ghostty's support is much better
3+
⚠️ **This is super out of date. Ghostty's support is much better
44
than this document seems. TODO to update this.** ⚠️
55

6-
76
This is the list of control and escape sequences known in the ecosystem
87
of terminal emulators and their implementation status in ghostty. Note that
98
some control sequences may never be implemented in ghostty. In these scenarios,
109
it is noted why.
1110

1211
Status meanings:
1312

14-
* ✅ - Implementation is complete and considered 100% accurate.
15-
* ⚠️ - Implementation works, but may be missing some functionality. The
16-
details of how well it works or doesn't are in the linked page. In many
17-
cases, the missing functionality is very specific or esoteric. Regardless,
18-
we don't consider a sequence a green checkmark until all known feature
19-
interactions are complete.
20-
* ❌ - Implementation is effectively non-functional, but ghostty continues
21-
in the face of it (probably in some broken state).
22-
* 💥 - Ghostty crashes if this control sequence is sent.
13+
- ✅ - Implementation is complete and considered 100% accurate.
14+
- ⚠️ - Implementation works, but may be missing some functionality. The
15+
details of how well it works or doesn't are in the linked page. In many
16+
cases, the missing functionality is very specific or esoteric. Regardless,
17+
we don't consider a sequence a green checkmark until all known feature
18+
interactions are complete.
19+
- ❌ - Implementation is effectively non-functional, but ghostty continues
20+
in the face of it (probably in some broken state).
21+
- 💥 - Ghostty crashes if this control sequence is sent.
2322

24-
| ID | ASCII | Name | Status |
25-
|:---:|:-----:|:-----|:------:|
26-
| `ENQ` | `0x05` | [Enquiry](sequences/enq.md) | |
27-
| `BEL` | `0x07` | [Bell](sequences/bel.md) | |
28-
| `BS` | `0x08` | [Backspace](sequences/bs.md) | ⚠️ |
29-
| `TAB` | `0x09` | [Tab](sequences/tab.md) | ⚠️ |
30-
| `LF` | `0x0A` | [Linefeed](sequences/lf.md) | ⚠️ |
31-
| `VT` | `0x0B` | [Vertical Tab](sequences/vt.md) | |
32-
| `FF` | `0x0C` | [Form Feed](sequences/ff.md) | |
33-
| `CR` | `0x0D` | [Carriage Return](sequences/cr.md) | ⚠️ |
34-
| `SO` | `0x0E` | [Shift Out](#) | |
35-
| `SI` | `0x0F` | [Shift In](#) | |
36-
| `CAN` | `0x18` | [Cancel Parsing](sequences/can.md) | |
37-
| `SUB` | `0x1A` | [Cancel Parsing (Alias)](sequences/can.md) | |
38-
| `IND` | `ESC D` | [Index](sequences/ind.md) | |
39-
| `NEL` | `ESC E` | [Next Line](sequences/nel.md) | |
40-
| `HTS` | `ESC H` | [Horizontal Tab Set](sequences/hts.md) | |
41-
| `RI` | `ESC M` | [Reverse Index](sequences/ri.md) | ⚠️ |
42-
| `SS2` | `ESC N` | [Single Shift 2](#) | |
43-
| `SS3` | `ESC O` | [Single Shift 3](#) | |
44-
| `SPA` | `ESC V` | [Start Protected Area](#) | |
45-
| `EPA` | `ESC W` | [End Protected Area](#) | |
23+
| ID | ASCII | Name | Status |
24+
| :---: | :-----: | :----------------------------------------- | :----: |
25+
| `ENQ` | `0x05` | [Enquiry](sequences/enq.md) | |
26+
| `BEL` | `0x07` | [Bell](sequences/bel.md) | |
27+
| `BS` | `0x08` | [Backspace](sequences/bs.md) | ⚠️ |
28+
| `TAB` | `0x09` | [Tab](sequences/tab.md) | ⚠️ |
29+
| `LF` | `0x0A` | [Linefeed](sequences/lf.md) | ⚠️ |
30+
| `VT` | `0x0B` | [Vertical Tab](sequences/vt.md) | |
31+
| `FF` | `0x0C` | [Form Feed](sequences/ff.md) | |
32+
| `CR` | `0x0D` | [Carriage Return](sequences/cr.md) | ⚠️ |
33+
| `SO` | `0x0E` | [Shift Out](#) | |
34+
| `SI` | `0x0F` | [Shift In](#) | |
35+
| `CAN` | `0x18` | [Cancel Parsing](sequences/can.md) | |
36+
| `SUB` | `0x1A` | [Cancel Parsing (Alias)](sequences/can.md) | |
37+
| `IND` | `ESC D` | [Index](sequences/ind.md) | |
38+
| `NEL` | `ESC E` | [Next Line](sequences/nel.md) | |
39+
| `HTS` | `ESC H` | [Horizontal Tab Set](sequences/hts.md) | |
40+
| `RI` | `ESC M` | [Reverse Index](sequences/ri.md) | ⚠️ |
41+
| `SS2` | `ESC N` | [Single Shift 2](#) | |
42+
| `SS3` | `ESC O` | [Single Shift 3](#) | |
43+
| `SPA` | `ESC V` | [Start Protected Area](#) | |
44+
| `EPA` | `ESC W` | [End Protected Area](#) | |

docs/sequences/bel.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Bell
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ------ |
55
| Text | |
6-
| Hex | `0x07` |
6+
| Hex | `0x07` |
77

88
Rings a "bell" to alert the operator to some condition.
99

1010
## Implementation Details
1111

12-
* ghostty logs "BELL"
12+
- ghostty logs "BELL"
1313

1414
## TODO
1515

16-
* Add a configurable visual bell -- common in most terminal emulators --
17-
to flash the border.
18-
* Mark the window as requesting attention, most operating systems support
19-
this. For example, Windows windows will flash in the toolbar.
20-
* Support an audible bell.
16+
- Add a configurable visual bell -- common in most terminal emulators --
17+
to flash the border.
18+
- Mark the window as requesting attention, most operating systems support
19+
this. For example, Windows windows will flash in the toolbar.
20+
- Support an audible bell.
2121

2222
## References
2323

24-
* https://vt100.net/docs/vt100-ug/chapter3.html
24+
- https://vt100.net/docs/vt100-ug/chapter3.html

docs/sequences/bs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Backspace
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ------ |
55
| Text | |
6-
| Hex | `0x08` |
6+
| Hex | `0x08` |
77

88
Move the cursor left one cell.
99

1010
TODO: Details about how this interacts with soft wrapping.
1111

1212
## Implementation Details
1313

14-
* ghostty implements this naively as `cursor.x -|= 1` (`-|=` being a
15-
saturating subtraction).
14+
- ghostty implements this naively as `cursor.x -|= 1` (`-|=` being a
15+
saturating subtraction).
1616

1717
## TODO
1818

19-
* Soft wrap integration
19+
- Soft wrap integration

docs/sequences/can.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Cancel Parsing
22

3-
| | |
4-
| --- | --- |
5-
| Text | |
6-
| Hex | `0x18` or `0x1A` |
3+
| | |
4+
| ---- | ---------------- |
5+
| Text | |
6+
| Hex | `0x18` or `0x1A` |
77

88
Cancels sequence parsing. Any partially completed sequence such as `ESC`
99
can send `0x18` and revert back to an unparsed state. The sequence characters

docs/sequences/cr.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Carriage Return
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ------ |
55
| Text | |
6-
| Hex | `0x0D` |
6+
| Hex | `0x0D` |
77

88
Moves the cursor to the left-most column and resets any pending wrap flags.
99

1010
## TODO
1111

12-
* Integration with left/right scrolling margins
13-
* Integration with origin mode
12+
- Integration with left/right scrolling margins
13+
- Integration with origin mode

docs/sequences/enq.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Enquiry (Answerback)
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ------ |
55
| Text | |
6-
| Hex | `0x05` |
6+
| Hex | `0x05` |
77

88
Sends an answerback string. In the VT100, this was configurable by the
99
operator.
1010

1111
## Implementation Details
1212

13-
* ghostty always sends `""`
13+
- ghostty always sends `""`
1414

1515
## TODO
1616

17-
* Make the answerback configurable
17+
- Make the answerback configurable
1818

1919
## References
2020

21-
* https://vt100.net/docs/vt100-ug/chapter3.html
21+
- https://vt100.net/docs/vt100-ug/chapter3.html

docs/sequences/ff.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Form Feed
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ------ |
55
| Text | |
6-
| Hex | `0x0C` |
6+
| Hex | `0x0C` |
77

88
Equivalent to [linefeed](lf.md).

docs/sequences/hts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Horizontal Tab Set
22

3-
| | |
4-
| --- | --- |
3+
| | |
4+
| ---- | ----------- |
55
| Text | `ESC H` |
66
| Hex | `0x18 0x48` |
77

0 commit comments

Comments
 (0)