turbo-editors/turbo-moonbit · ask-about-code.md

turbo-editors/turbo-moonbitpublic⑂ Fork 0

⑂ main

ask-about-code.md · 72 lines · 3.5 KBmarkdown    Blame HistoryRaw
📦 Turbo MoonBit   1# How to ask what the code means
3This guide shows how to follow a name through a project: where it is declared, what implements it, everywhere it is used, and what is wrong with it. It assumes Turbo MoonBit is installed and a language server is running — the status bar says `LSP: ready` when it is.
5For moving around a file — searching, jumping to a line, switching windows — see [How to move around a file](navigate-code.md) instead.
7## Put the cursor on a name
9Any character of it will do. Every question below asks about the **position of the cursor**, not about a selection, so there is nothing to highlight first.
13| To find | Do | Shortcut |
14| --- | --- | --- |
15| What it is | **Code ▸ Describe symbol** | `F1` |
16| Where it is declared | **Code ▸ Go to definition** | `F12` |
17| Where its *type* is declared | **Code ▸ Go to type definition** | |
18| What implements it | **Code ▸ Find implementations…** | |
19| Everywhere it is used | **Code ▸ Find references…** | `Shift-F12` |
21**Two of these five report nothing with moon-lsp.** The server advertises neither `typeDefinition` nor `implementation`, so **Go to type definition** and **Find implementations** answer nothing found however good the code is. The other three, and the two symbol searches below, all work. See [colouring and completion](../explanation/colouring-and-completion.md) for why this is written down rather than hidden behind a greyed-out menu item.
23One answer takes you straight there. Several open a list showing each file, its line, and the text of that line:
26References (3)
27  main.mbt:1    fn helper() -> Int {
28  main.mbt:7      helper()
29  main.mbt:12     helper() + 1
32Move with the arrow keys, `Enter` to go, `Esc` to stay where you are.
34## When nothing comes back
36Three different things look alike, and the status bar tells them apart:
38| It says | Meaning |
39| --- | --- |
40| `No references found` | The server answered, and there are none |
41| Anything else, such as `Loading…` | The server has not finished indexing. Wait a moment and ask again. |
42| `LSP: off` on the status bar | No server is running. See [How to enable completion](enable-completion.md). |
44The middle one is worth knowing: a server still indexing answers every question with nothing, and that is indistinguishable from a real answer unless the editor says so.
46## Find something by name instead
48- **Code ▸ Symbol in file…** lists what the file in front declares, indented, with each symbol's kind — an outline you can walk.
49- **Code ▸ Symbol in project…** (`Ctrl-T`) asks for a name and searches everywhere. What counts as a match is the server's decision; moon-lsp matches loosely, so a few letters usually do.
51## See what is wrong
53**Code ▸ Problems…** lists every problem the server has reported, for **every file it has loaded** — usually more than the one you are editing. Choosing one goes to the line.
55Lines with a problem carry a mark in the gutter, beside the line number:
57| Mark | Meaning |
58| --- | --- |
59| `×` | An error |
60| `!` | A warning |
61| `i` | Information |
62| `·` | A hint |
64A line with more than one problem shows the worst of them.
66**The marks need the line numbers.** They sit in the column that separates the numbers from the text, so hiding the gutter with **Options ▸ Line numbers** hides them too.
68## See also
70- Every item and its key: [Menus](../reference/menus.md)
71- Getting a server running: [How to enable completion](enable-completion.md)
72- What the editor asks, and why: [Colouring and completion](../explanation/colouring-and-completion.md)

📦 Turbo MoonBit cc1f595 k33g 13h ago	1	# How to ask what the code means
	2
	3	This guide shows how to follow a name through a project: where it is declared, what implements it, everywhere it is used, and what is wrong with it. It assumes Turbo MoonBit is installed and a language server is running — the status bar says `LSP: ready` when it is.
	4
	5	For moving around a file — searching, jumping to a line, switching windows — see [How to move around a file](navigate-code.md) instead.
	6
	7	## Put the cursor on a name
	8
	9	Any character of it will do. Every question below asks about the position of the cursor, not about a selection, so there is nothing to highlight first.
	10
	11	## Ask
	12
	13	\| To find \| Do \| Shortcut \|
	14	\| --- \| --- \| --- \|
	15	\| What it is \| Code ▸ Describe symbol \| `F1` \|
	16	\| Where it is declared \| Code ▸ Go to definition \| `F12` \|
	17	\| Where its type is declared \| Code ▸ Go to type definition \| \|
	18	\| What implements it \| Code ▸ Find implementations… \| \|
	19	\| Everywhere it is used \| Code ▸ Find references… \| `Shift-F12` \|
	20
	21	Two of these five report nothing with moon-lsp. The server advertises neither `typeDefinition` nor `implementation`, so Go to type definition and Find implementations answer nothing found however good the code is. The other three, and the two symbol searches below, all work. See [colouring and completion](../explanation/colouring-and-completion.md) for why this is written down rather than hidden behind a greyed-out menu item.
	22
	23	One answer takes you straight there. Several open a list showing each file, its line, and the text of that line:
	24
	25	```
	26	References (3)
	27	main.mbt:1 fn helper() -> Int {
	28	main.mbt:7 helper()
	29	main.mbt:12 helper() + 1
	30	```
	31
	32	Move with the arrow keys, `Enter` to go, `Esc` to stay where you are.
	33
	34	## When nothing comes back
	35
	36	Three different things look alike, and the status bar tells them apart:
	37
	38	\| It says \| Meaning \|
	39	\| --- \| --- \|
	40	\| `No references found` \| The server answered, and there are none \|
	41	\| Anything else, such as `Loading…` \| The server has not finished indexing. Wait a moment and ask again. \|
	42	\| `LSP: off` on the status bar \| No server is running. See [How to enable completion](enable-completion.md). \|
	43
	44	The middle one is worth knowing: a server still indexing answers every question with nothing, and that is indistinguishable from a real answer unless the editor says so.
	45
	46	## Find something by name instead
	47
	48	- Code ▸ Symbol in file… lists what the file in front declares, indented, with each symbol's kind — an outline you can walk.
	49	- Code ▸ Symbol in project… (`Ctrl-T`) asks for a name and searches everywhere. What counts as a match is the server's decision; moon-lsp matches loosely, so a few letters usually do.
	50
	51	## See what is wrong
	52
	53	Code ▸ Problems… lists every problem the server has reported, for every file it has loaded — usually more than the one you are editing. Choosing one goes to the line.
	54
	55	Lines with a problem carry a mark in the gutter, beside the line number:
	56
	57	\| Mark \| Meaning \|
	58	\| --- \| --- \|
	59	\| `×` \| An error \|
	60	\| `!` \| A warning \|
	61	\| `i` \| Information \|
	62	\| `·` \| A hint \|
	63
	64	A line with more than one problem shows the worst of them.
65
66	The marks need the line numbers. They sit in the column that separates the numbers from the text, so hiding the gutter with Options ▸ Line numbers hides them too.
67
68	## See also
69
70	- Every item and its key: [Menus](../reference/menus.md)
71	- Getting a server running: [How to enable completion](enable-completion.md)
72	- What the editor asks, and why: [Colouring and completion](../explanation/colouring-and-completion.md)