aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/dev/README.md84
-rw-r--r--docs/dev/debugging.md2
2 files changed, 38 insertions, 48 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 2f6215d6b..a2be99858 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -26,15 +26,6 @@ Discussion happens in this Zulip stream:
26 26
27https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 27https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
28 28
29# Work List
30
31We have this "work list" paper document:
32
33https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
34
35It shows what everyone is working on right now. If you want to (this is not
36mandatory), add yourself to the list!
37
38# Issue Labels 29# Issue Labels
39 30
40* [good-first-issue](https://github.com/rust-analyzer/rust-analyzer/labels/good%20first%20issue) 31* [good-first-issue](https://github.com/rust-analyzer/rust-analyzer/labels/good%20first%20issue)
@@ -50,10 +41,12 @@ mandatory), add yourself to the list!
50 41
51# CI 42# CI
52 43
53We use Travis for CI. Most of the things, including formatting, are checked by 44We use GitHub Actions for CI. Most of the things, including formatting, are checked by
54`cargo test` so, if `cargo test` passes locally, that's a good sign that CI will 45`cargo test` so, if `cargo test` passes locally, that's a good sign that CI will
55be green as well. We use bors-ng to enforce the [not rocket 46be green as well. The only exception is that long-running by default a skipped locally.
56science](https://graydon2.dreamwidth.org/1597.html) rule. 47Use `env RUN_SLOW_TESTS=1 cargo test` to run the full suite.
48
49We use bors-ng to enforce the [not rocket science](https://graydon2.dreamwidth.org/1597.html) rule.
57 50
58You can run `cargo xtask install-pre-commit-hook` to install git-hook to run rustfmt on commit. 51You can run `cargo xtask install-pre-commit-hook` to install git-hook to run rustfmt on commit.
59 52
@@ -81,42 +74,37 @@ relevant test and execute it (VS Code includes an action for running a single
81test). 74test).
82 75
83However, launching a VS Code instance with locally build language server is 76However, launching a VS Code instance with locally build language server is
84possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should 77possible. There's "Run Extension (Dev Server)" launch configuration for this.
85work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). 78
86 79In general, I use one of the following workflows for fixing bugs and
87I often just install development version with `cargo xtask install --server --jemalloc` and 80implementing features.
88restart the host VS Code. 81
89 82If the problem concerns only internal parts of rust-analyzer (ie, I don't need
90See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with 83to touch `ra_lsp_server` crate or typescript code), there is a unit-test for it.
91debugger, and don't forget that rust-analyzer has useful `pd` snippet and `dbg` 84So, I use **Rust Analyzer: Run** action in VS Code to run this single test, and
92postfix completion for printf debugging :-) 85then just do printf-driven development/debugging. As a sanity check after I'm
93 86done, I use `cargo xtask install --server` and **Reload Window** action in VS
94# Working With VS Code Extension 87Code to sanity check that the thing works as I expect.
95 88
96To work on the VS Code extension, launch code inside `editors/code` and use `F5` 89If the problem concerns only the VS Code extension, I use **Run Extension**
97to launch/debug. To automatically apply formatter and linter suggestions, use 90launch configuration from `launch.json`. Notably, this uses the usual
98`npm run fix`. 91`ra_lsp_server` binary from `PATH`. After I am done with the fix, I use `cargo
99 92xtask install --client-code` to try the new extension for real.
100Tests are located inside `src/test` and are named `*.test.ts`. They use the 93
101[Mocha](https://mochajs.org) test framework and the builtin Node 94If I need to fix something in the `ra_lsp_server` crate, I feel sad because it's
102[assert](https://nodejs.org/api/assert.html) module. Unlike normal Node tests 95on the boundary between the two processes, and working there is slow. I usually
103they must be hosted inside a VS Code instance. This can be done in one of two 96just `cargo xtask install --server` and poke changes from my live environment.
104ways: 97Note that this uses `--release`, which is usually faster overall, because
105 98loading stdlib into debug version of rust-analyzer takes a lot of time. To speed
1061. When `F5` debugging in VS Code select the `Extension Tests` configuration 99things up, sometimes I open a temporary hello-world project which has
107 from the drop-down at the top of the Debug View. This will launch a temporary 100`"rust-analyzer.withSysroot": false` in `.code/settings.json`. This flag causes
108 instance of VS Code. The test results will appear in the "Debug Console" tab 101rust-analyzer to skip loading the sysroot, which greatly reduces the amount of
109 of the primary VS Code instance. 102things rust-analyzer needs to do, and makes printf's more useful. Note that you
110 103should only use `eprint!` family of macros for debugging: stdout is used for LSP
1112. Run `npm test` from the command line. Although this is initiated from the 104communication, and `print!` would break it.
112 command line it is not headless; it will also launch a temporary instance of 105
113 VS Code. 106If I need to fix something simultaneously in the server and in the client, I
114 107feel even more sad. I don't have a specific workflow for this case.
115Due to the requirements of running the tests inside VS Code they are **not run
116on CI**. When making changes to the extension please ensure the tests are not
117broken locally before opening a Pull Request.
118
119To install **only** the VS Code extension, use `cargo xtask install --client-code`.
120 108
121# Logging 109# Logging
122 110
diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md
index f868e6998..1ccf4dca2 100644
--- a/docs/dev/debugging.md
+++ b/docs/dev/debugging.md
@@ -1,5 +1,7 @@
1# Debugging vs Code plugin and the Language Server 1# Debugging vs Code plugin and the Language Server
2 2
3**NOTE:** the information here is mostly obsolete
4
3Install [LLDB](https://lldb.llvm.org/) and the [LLDB Extension](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb). 5Install [LLDB](https://lldb.llvm.org/) and the [LLDB Extension](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
4 6
5Checkout rust rust-analyzer and open it in vscode. 7Checkout rust rust-analyzer and open it in vscode.