Skip to content

Commit c3c56ae

Browse files
SertionSertion
committed
2.3.1 - Updating readme with new improved (?) format
1 parent 333d7db commit c3c56ae

File tree

1 file changed

+125
-36
lines changed

1 file changed

+125
-36
lines changed

‎README.md‎

Lines changed: 125 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,42 +15,131 @@ See Git Blame information in the status bar for the currently selected line.
1515

1616
# Configuration
1717

18-
- `gitblame.commitUrl` (`string`, default `"guess"`)
19-
- url where you can see the commit by hash
20-
- `"guess"` will try to guess the URL based on your remote origin
21-
- Can only support servers that fulfill the following requirements:
22-
- Url has https
23-
- No auth or port required
24-
- `"no"` will not guess and will not show a link
25-
- available tokens:
26-
- `${hash}` - the commit hash
27-
- _Example:_ `https://github.com/Sertion/vscode-gitblame/commit/${hash}`
28-
- `gitblame.ignoreWhitespace` (`boolean`, default `false`)
29-
- use the git blame `-w` flag
30-
- `gitblame.infoMessageFormat` (`string`, default `"${commit.hash} ${commit.summary}"`)
31-
- message that appears when the `gitblame.quickInfo` command executes (when you click the status bar message)
32-
- [available tokens](#message-tokens)
33-
- `gitblame.statusBarMessageFormat` (`string`, default `"Blame ${author.name} ( ${time.ago} )"`)
34-
- message in the status bar about the current line's git blame commit
35-
- [available tokens](#message-tokens)
36-
- `gitblame.statusBarMessageNoCommit` (`string`, default `"Not Committed Yet"`)
37-
- message in the status bar about the current line when no commit can be found
38-
- available tokens:
39-
- _No available tokens_
40-
- `gitblame.statusBarPositionPriority` (`number`)
41-
- priority where the status bar view should be placed
42-
- Higher value should be placed further to the left
43-
- `gitblame.progressSpinner` (`array` of `string`, default `["$(sync~spin)"]`)
44-
- an array of strings that will be displayed in sequence to denote progress while blaming files in larger repositories
45-
- supports [Octoicons](https://octicons.github.com/) with the `~spin` suffix for spin action
46-
- when the array only contains one item that item is rendered once instead of every 100ms
47-
- `gitblame.logLevel` (`array` of `string`, default `["info", "error", "command", "critical"]`)
48-
- an array of levels to log to the extension log
49-
- available levels:
50-
- `"info"`
51-
- `"error"`
52-
- `"command"`
53-
- `"critical"`
18+
<table>
19+
<thead>
20+
<tr>
21+
<th>Setting</th>
22+
<th>Type</th>
23+
<th>Default Value</th>
24+
</tr>
25+
<tr>
26+
<th colspan="3">Description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td><code>gitblame.commitUrl</code></td>
32+
<td><code>string</code></td>
33+
<td><code>"guess"</code></td>
34+
</tr>
35+
<tr>
36+
<td colspan="3">
37+
<ul>
38+
<li>Url where you can see the commit by hash</li>
39+
<li><code>"guess"</code> will try to guess the URL based on your remote origin
40+
<ul>
41+
<li>Can only support servers that fulfill the following requirements:
42+
<ul>
43+
<li>Url is https</li>
44+
<li>No auth or port required</li>
45+
</ul>
46+
</li>
47+
</ul>
48+
<li><code>"no"</code> will not guess and will not show a link</li>
49+
<li>Available tokens:
50+
<ul>
51+
<li><code>${hash}</code> - the commit hash</li>
52+
</ul>
53+
</li>
54+
<li><em>Example:</em> <code>https://github.com/Sertion/vscode-gitblame/commit/${hash}</code></li>
55+
</ul>
56+
</tr>
57+
<tr>
58+
<td><code>gitblame.ignoreWhitespace</code></td>
59+
<td><code>boolean</code></td>
60+
<td><code>false</code></td>
61+
</tr>
62+
<tr>
63+
<td colspan="3">
64+
Use the git blame <code>-w</code> flag
65+
</td>
66+
</tr>
67+
<tr>
68+
<td><code>gitblame.infoMessageFormat</code></td>
69+
<td><code>string</code></td>
70+
<td><code>"${commit.hash} ${commit.summary}"</code></td>
71+
</tr>
72+
<tr>
73+
<td colspan="3">
74+
Message that appears when the <code>gitblame.quickInfo</code> command executes (when you click the status bar message). <a href="#message-tokens">Available tokens</a>.
75+
</tr>
76+
<tr>
77+
<td><code>gitblame.statusBarMessageFormat</code></td>
78+
<td><code>string</code></td>
79+
<td><code>"Blame ${author.name} ( ${time.ago} )"</code></td>
80+
</tr>
81+
<tr>
82+
<td colspan="3">
83+
Message in the status bar about the current line's git blame commit. <a href="#message-tokens">Available tokens</a>.
84+
</td>
85+
</tr>
86+
<tr>
87+
<td><code>gitblame.statusBarMessageNoCommit</code></td>
88+
<td><code>string</code></td>
89+
<td><code>"Not Committed Yet"</code></td>
90+
</tr>
91+
<tr>
92+
<td colspan="3">
93+
Message in the status bar about the current line when no commit can be found. <em>No available tokens</em>.
94+
</td>
95+
</tr>
96+
<tr>
97+
<td><code>gitblame.statusBarPositionPriority</code></td>
98+
<td><code>number</code></td>
99+
<td><code>undefined</code></td>
100+
</tr>
101+
<tr>
102+
<td colspan="3">
103+
Priority where the status bar view should be placed. Higher value should be placed further to the left.
104+
</td>
105+
</tr>
106+
<tr>
107+
<td><code>gitblame.progressSpinner</code></td>
108+
<td><code>string[]</code></td>
109+
<td><code>["$(sync~spin)"]</code></td>
110+
</tr>
111+
<tr>
112+
<td colspan="3">
113+
<ul>
114+
<li>An array of strings that will be displayed in sequence to denote progress while blaming files in larger repositories.</li>
115+
<li>Supports <a href="https://octicons.github.com/">Octoicons</a> with the <code>~spin</code> suffix for spin action.</li>
116+
<li>When the array only contains one item that item is rendered once instead of every 100ms.</li>
117+
</ul>
118+
</td>
119+
</tr>
120+
<tr>
121+
<td><code>gitblame.logLevel</code></td>
122+
<td><code>string[]</code></td>
123+
<td><code>["info", "error", "command", "critical"]</code></td>
124+
</tr>
125+
<tr>
126+
<td colspan="3">
127+
<ul>
128+
<li>An array of levels to log to the extension log.</li>
129+
<li>Available levels:
130+
<ul>
131+
<li><code>"info"</code></li>
132+
<li><code>"error"</code></li>
133+
<li><code>"command"</code></li>
134+
<li><code>"critical"</code></li>
135+
</ul>
136+
</li>
137+
</ul>
138+
</td>
139+
</tr>
140+
<tr>
141+
</tbody>
142+
</table>
54143

55144
## Message Tokens
56145

0 commit comments

Comments
 (0)