Skip to content

Commit 9868a04

Browse files
committed
chore: improve docs and scripts consistency
- Update issue template formatting for clarity and consistency. - Use italics instead of bold for notes in README for better style. - Enhance npm scripts to run Prettier with lint/fix commands. - Remove unnecessary blank line in GitHub Actions workflow.
1 parent be21257 commit 9868a04

4 files changed

Lines changed: 24 additions & 23 deletions

File tree

.github/ISSUE_TEMPLATE/issue-report.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

109
**Describe the issue**
1110
A clear and concise description of the problem.
1211

1312
**To Reproduce**
1413
Steps to reproduce the behavior:
14+
1515
1. Go to '...'
1616
2. Open this file '....'
1717
3. Run this command '....'
@@ -21,21 +21,23 @@ Steps to reproduce the behavior:
2121
A clear and concise description of what you expected to happen.
2222

2323
**Versions of relevant software**
24-
- vim:
25-
- coc.nvim:
26-
- coc-java:
27-
- vimspector:
28-
- java:
29-
- maven:
24+
25+
- vim:
26+
- coc.nvim:
27+
- coc-java:
28+
- vimspector:
29+
- java:
30+
- maven:
3031

3132
**Relevant logs and error messages**
32-
* View the trace logging output for the Java language server:
33-
* Set `{ "java.trace.server": "verbose" }` in `:CocSettings`.
34-
* Run the command `:CocCommand workspace.showOutput java`.
35-
* Are there any errors?
36-
* View the Vimspector log `:VimspectorShowOutput Vimspector`.
37-
* Are the any errors?
38-
* After running the command `:CocCommand java.debug.vimspector.start` Do you see a message like `[coc.nvim] Java debug server started on port` in the output of `:messages`?
33+
34+
- View the trace logging output for the Java language server:
35+
- Set `{ "java.trace.server": "verbose" }` in `:CocSettings`.
36+
- Run the command `:CocCommand workspace.showOutput java`.
37+
- Are there any errors?
38+
- View the Vimspector log `:VimspectorShowOutput Vimspector`.
39+
- Are the any errors?
40+
- After running the command `:CocCommand java.debug.vimspector.start` Do you see a message like `[coc.nvim] Java debug server started on port` in the output of `:messages`?
3941

4042
**Additional context**
4143
Add any other context about the problem here.

.github/workflows/node.js.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ on:
1010

1111
jobs:
1212
build:
13-
1413
runs-on: ubuntu-latest
1514

1615
strategy:

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -213,13 +213,13 @@ Add the following contents to the `.vimspector.json` file in the root directory
213213
}
214214
```
215215

216-
*Review the [Vimspector config][12] docs for what's possible within this file.*
216+
_Review the [Vimspector config][12] docs for what's possible within this file._
217217

218218
##### Configure Vim
219219

220220
This extension provides `:CocCommand java.debug.vimspector.start` to simplify launching Vimspector.
221221

222-
*Note, it does not start your Java process in remote debug mode. An example of how to do that is covered below.*
222+
_Note, it does not start your Java process in remote debug mode. An example of how to do that is covered below._
223223

224224
To further simplify, launching Vimspector, add the following config to your `~/.vimrc` file or wherever appropriate for
225225
your Vim setup.
@@ -263,11 +263,11 @@ the breakpoint you set.
263263

264264
That's it! You may now [step debug][20] your way through a Java program from within Vim.
265265

266-
*Note, if you use a Java debug port different than `5005` you will need to change that value in your `.vimspector.json`
266+
_Note, if you use a Java debug port different than `5005` you will need to change that value in your `.vimspector.json`
267267
file. It is also possible to configure this port dynamically in Vimspector in the same manner as the debug adapter
268-
port.*
268+
port._
269269

270-
*Also note, if you use Maven for builds you may start [remote debugging][14] for tests and then run Vimspector.*
270+
_Also note, if you use Maven for builds you may start [remote debugging][14] for tests and then run Vimspector._
271271

272272
```sh
273273
mvn test -Dmaven.surefire.debug
@@ -278,7 +278,7 @@ mvn test -Dmaven.surefire.debug
278278
If you'd prefer to launch the Vimspector plugin directly with your own configuration then add something similar the
279279
following config to your `~/.vimrc` file or wherever appropriate for your Vim setup.
280280

281-
*Note, this will bypass using the `:CocCommand` documented above to start the debug session.*
281+
_Note, this will bypass using the `:CocCommand` documented above to start the debug session._
282282

283283
```viml
284284
function! JavaStartDebugCallback(err, port)

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131
"scripts": {
3232
"build": "node esbuild.mjs",
3333
"clean": "rimraf lib",
34-
"fix": "eslint --fix .",
35-
"lint": "eslint .",
34+
"fix": "eslint --fix && prettier --write .",
35+
"lint": "eslint && prettier --check .",
3636
"prepare": "npm-run-all clean build",
3737
"release": "np --no-tests",
3838
"watch": "node esbuild.mjs --watch"

0 commit comments

Comments
 (0)