bors
3c00b19b0a
Auto merge of #13771 - noritada:feature/release-notes-on-github-releases, r=lnicola
...
Add xtask for publishing release notes in Markdown on GitHub Releases from a changelog in AsciiDoc
This PR provides `xtask publish-release-notes` to convert a changelog written in AsciiDoc to Markdown and update descriptions (release notes) of a corresponding entry on GitHub Releases.
This AsciiDoc parser is not capable of processing every AsciiDoc document, but I have surveyed a set of existing changelog entries and have confirmed that the following notations used can be converted properly. In the future, I would like to improve the parser to accept any AsciiDoc. Alternatively, the parser could be moved out of the project.
Your feedback would be appreciated!
Closes #13191
### Supported AsciiDoc syntax
many occurrences
- [x] documentation header
- [x] section header
- [x] `*`-prefixed basic unordered single level list item
- [x] list continuation using `+`
- [x] block image macro `image::...[]` with empty alt
- [x] block image macro `image::...[]` with non-empty alt
- [x] block video marco `video::...[]` with `options=loop`
- [x] inline hard line break `+`
- [x] inline custom macro `commit:...[]`
- [x] inline custom macro `release:...[]`
- [x] inline custom macro `pr:...[]`
- [x] inline unconstrained bold text `**...**`
- [x] inline constrained monospace ``` `...` ```
[thisweek/_posts/2019-07-24-changelog-0.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/tree/src/thisweek/_posts#:~:text=2019%2D07%2D24%2Dchangelog%2D0.adoc )
- [x] paragraphs
- [x] mixture of `*` and `-` for unordered list item prefix
- [x] inline external link `https://...[] `
[thisweek/_posts/2020-01-13-changelog-7.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/tree/src/thisweek/_posts#:~:text=2020%2D01%2D13%2Dchangelog%2D7.adoc )
- [x] list item with multiline principal text with indent
- [x] inline image macro `image:...[]`
[thisweek/_posts/2020-03-02-changelog-14.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/blob/src/thisweek/_posts/2020-03-02-changelog-14.adoc )
- [x] empty lines between list items
- [x] nested unordered list item with `**`
- [x] inline macro `kbd:[...]`
[thisweek/_posts/2020-03-16-changelog-16.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/blob/src/thisweek/_posts/2020-03-16-changelog-16.adoc )
- [x] `[source]`-prefixed listing
[thisweek/_posts/2020-04-06-changelog-19.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/blob/src/thisweek/_posts/2020-04-06-changelog-19.adoc )
- [x] list item with multiline principal text without indent
- [x] `[source,lang]`-prefixed listing
- [x] `.`-prefiexed ordered list item
- [x] list item immediately after list continuation paragraph without an empty line in between
[thisweek/_posts/2020-04-20-changelog-21.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/blob/src/thisweek/_posts/2020-04-20-changelog-21.adoc )
- [x] title line for block image
[thisweek/_posts/2020-12-21-changelog-56.adoc](https://github.com/rust-analyzer/rust-analyzer.github.io/blob/src/thisweek/_posts/2020-12-21-changelog-56.adoc )
- [x] block video `video::...[]` with `options="autoplay,loop"`
2022-12-21 18:37:10 +00:00
Lukas Wirth
cf8d89e46b
Add a command to clear flycheck diagnostics
2022-12-17 23:43:26 +01:00
Lukas Wirth
a04feb915a
Add command for manually running flychecks
2022-12-16 22:47:19 +01:00
Noritada Kobayashi
97ec0ea698
Update the release process documentation to run xtask publish-release-notes
2022-12-12 02:09:31 +09:00
Jonas Schievink
32f59cf01d
Update hash
2022-11-29 19:33:16 +01:00
ZZzzaaKK
e39d90a8e6
Improve grammar of architecture.md
2022-11-20 01:58:16 +01:00
bors
8142d1f606
Auto merge of #13445 - notJoon:modify-dead-links, r=lnicola
...
fix) update broken links in guide.md
Hi, I Just fixed some broken links in `guide.md`.
In most cases, it is not connected by an old version (expecially `guide-2019-01`) of the link, so I made some modifications.
Thanks for your time :)
2022-10-31 06:55:11 +00:00
Laurențiu Nicola
05514d8233
Clarify feature policy
2022-10-27 16:35:07 +03:00
Laurențiu Nicola
956b96a19d
Switch to upstream positionEncoding
2022-10-25 14:43:26 +03:00
not_joon
8ebc96a8a9
fix broken links in guide.md
2022-10-20 22:06:00 +09:00
bors
0531aab522
Auto merge of #13397 - zyctree:zyctree-patch-2, r=lnicola
...
fix link in syntax.md
2022-10-16 17:40:21 +00:00
zyctree
ea8b62f9b0
update link in syntax.md
2022-10-17 01:39:19 +08:00
zyctree
5df03c2c18
update link in syntax.md
2022-10-16 23:41:32 +08:00
Lukas Wirth
88d0efc243
Update guide.md to reflect support for proc-macros
2022-10-16 11:52:01 +02:00
zyctree
34977996c3
Update docs/dev/syntax.md
...
Co-authored-by: Laurențiu Nicola <lnicola@users.noreply.github.com>
2022-10-11 19:37:49 +08:00
zyctree
11a335d5e8
fix link in syntax.md
2022-10-11 14:05:04 +08:00
Lukas Wirth
5424c51158
Add config for supplying sysroot path
2022-10-01 21:17:06 +02:00
Paul Delafosse
40e8f03e11
docs(guide): fix Analysis and AnalysisHost doc links
2022-09-22 05:17:47 +02:00
Lukas Wirth
45b7b6a60a
Implement lsp extension for cancelling running flychecks
2022-08-19 08:54:53 +02:00
Dezhi Wu
23747419ca
fix: a bunch of typos
...
This PR will fix some typos detected by [typos].
There are also some other typos in the function names, variable names, and file
names, which I leave as they are. I'm more certain that typos in comments
should be fixed.
[typos]: https://github.com/crate-ci/typos
2022-08-17 21:44:58 +08:00
Jonas Schievink
bd7dfac5eb
Fix r-a spelling in some places
2022-08-01 13:47:09 +02:00
Laurențiu Nicola
58c3a5634f
Update xtask promote and release instructions
2022-07-31 20:26:35 +03:00
Jonas Schievink
6c6ae965ba
Update remaining GitHub URLs
2022-07-08 15:44:49 +02:00
Chris Burgess
54f5a68f79
fix typo in style.md
2022-06-11 12:50:36 -04:00
Jonas Schievink
592bc5106c
Update commit/PR style
2022-05-30 15:55:40 +02:00
Felicián Németh
636d4880c4
internal: Allow OnTypeFormatting to send SnippetTextEdit
...
But continue to send TextEdit only.
2022-05-22 10:39:18 +02:00
Lukas Wirth
0c488fa215
Update lsp-extensions hash
2022-05-17 14:48:28 +02:00
bors
9ee080f8b2
Auto merge of #12015 - arjo129:master, r=jonas-schievink
...
[Documentation]: Update developer documentation link.
Just noticed the docs links broken. The current doc link was broken. replaced with the updated version as found on the front page. Should the rest of the links be updated?
2022-04-21 16:52:10 +00:00
Jonas Schievink
c6ffffccbd
Allows triggering commands after an assist edit
2022-04-19 18:45:48 +02:00
Hongxu Xu
4390a8ad7c
Fix typo "GreeNode" in syntax.md
2022-04-19 15:45:03 +08:00
Arjo Chakravarty
f75bad52d7
Update docs link
...
The current doc link was broken. replaced with the updated version as found on the front page.
2022-04-17 20:32:06 +08:00
Deadbeef
8b60bf6764
Update CI for Rust bors
2022-04-13 16:55:10 +02:00
Laurențiu Nicola
d3d6267112
Switch to LSP inlay hints
2022-04-08 14:10:24 +03:00
Jonas Schievink
ec2d023383
Add "view file text" command to debug sync issues
2022-03-31 14:50:33 +02:00
Marius Ungureanu
b70fa1c717
Fix typo in the style documentation
...
Was going through the documentation itself and found this typo just waiting to be fixed
2022-03-27 15:23:33 +03:00
Lukas Wirth
119ba82e4b
minor: add missing definitions of lsp_ext::InlayHintLabel
2022-03-12 01:08:33 +01:00
Laurențiu Nicola
b9d74fe2ed
Update LSP docs
2022-03-07 15:09:31 +02:00
Lukas Wirth
8db88df758
simplify and document
2022-02-22 10:45:29 +01:00
Felicián Németh
7c7d6991dd
fix: documentation of SsrParams
...
Fix #11429 by extending the documentation of SsrParms with the
mandatory field 'selections'. Copy its description from lsp_ext.rs.
2022-02-12 15:47:54 +01:00
Moritz Vetter
482533ea9a
add missing snake case attribute, update hash
2022-02-07 04:57:20 +01:00
Waffle Maybe
6ab66d4c9a
minor: fix a typo in the style guide
2022-01-26 17:07:17 +03:00
Jonas Schievink
0db5aacfcd
Update lsp-extensions.md
2021-12-07 16:41:24 +01:00
Aleksey Kladov
d9dc925c2e
doc: document absence of stability guarantees
2021-11-22 13:06:37 +03:00
Wilfred Hughes
54b636f1e2
Fix type names in typescript sample code
2021-11-12 11:15:08 -08:00
Mirko Rainer
a1c544f85a
Add link to ECS acronym to clarify.
2021-10-12 09:24:00 -04:00
Lukas Wirth
ca1fdd75f1
Regen docs
2021-10-04 22:13:12 +02:00
Aleksey Kladov
d72f7cf3af
internal: add => () rule; emphasize n_items
rule
2021-09-25 14:10:25 +03:00
Dezhi Wu
eb8508ae80
docs: fix unknown configuration setting
2021-09-06 19:57:17 +08:00
Aleksey Kladov
2d2c4e7c22
internal: deduplicate
2021-09-04 16:56:23 +03:00
Dezhi Wu
b8ef2acadb
docs(logging): use tracing
for logging
2021-09-03 17:07:38 +08:00
Aleksey Kladov
9e0203bd69
internal: make scheduling control flow more obvious
...
There should be only one place where we need to check if we want to
start background activities.
2021-08-30 19:39:08 +03:00
Aleksey Kladov
1660820e51
internal: use idiomatic form of assertions
...
Ideally, we should just return an InvalidParameter dialog here, but that
shows error message to the end user, and we generally avoid that
2021-08-24 14:09:34 +03:00
Aleksey Kladov
629c68e80d
internal: document that ascription is preferred to a turbo fish
2021-08-11 14:16:15 +03:00
Aleksey Kladov
fc48def916
minor: reword a bit
2021-08-10 14:56:55 +03:00
Aleksey Kladov
967c088e01
internal: document codebase stance on using functional combinators
2021-08-10 14:34:05 +03:00
Aleksey Kladov
2f9273633b
feat: filter out duplicate macro completions
...
closes #9303
2021-08-03 17:36:06 +03:00
Aleksey Kladov
12d7f5b56e
internal: explain that we don't ref
in style.md
2021-08-02 15:59:28 +03:00
Gunnlaugur Thor Briem
4930e5d74d
Link “DST” to its definition
...
Being new to Rust I wasn't familiar with this acronym and found it hard to guess (the context of syntax trees biased me to reading it as a D-something Syntax Tree and trying to guess what the D was), hard to google (in retrospect googling "rust dst" does the job, but I thought it was an abstract structure thing, not Rust-specific), and hard to Github-search, because `dst` is commonly short for “destination” in code.
Alternatively `<abbr title="dynamically sized type">DST</abbr>` would be about as helpful.
2021-08-01 14:37:16 +00:00
Aleksey Kladov
2229cfcf48
internal: cleanup lsp-extensions docs
2021-07-30 19:50:39 +03:00
Aleksey Kladov
be84f85c1d
feat: gate custom clint-side commands behind capabilities
...
Some features of rust-analyzer requires support for custom commands on
the client side. Specifically, hover & code lens need this.
Stock LSP doesn't have a way for the server to know which client-side
commands are available. For that reason, we historically were just
sending the commands, not worrying whether the client supports then or
not.
That's not really great though, so in this PR we add infrastructure for
the client to explicitly opt-into custom commands, via `extensions`
field of the ClientCapabilities.
To preserve backwards compatability, if the client doesn't set the
field, we assume that it does support all custom commands. In the
future, we'll start treating that case as if the client doesn't support
commands.
So, if you maintain a rust-analyzer client and implement
`rust-analyzer/runSingle` and such, please also advertise this via a
capability.
2021-07-30 19:16:33 +03:00
Aleksey Kladov
68836c0dbe
minor: drop impl-specific stuff from lsp docs
...
The lc. prefix is a copy-paste from our typescript code, it doesn't make
sense in the impl-agnostic docs.
2021-07-30 16:37:41 +03:00
Alexander Gonzalez
41943f2328
refactor: Apply PR suggestions
2021-07-27 18:31:21 -04:00
Alexander Gonzalez
c6fab1993a
test: Update lsp_ext.rs hash
2021-07-27 18:31:21 -04:00
Alexander Gonzalez
ca85185bc6
docs: Update the lsp-extensions.md with the Hover Range capability
2021-07-27 18:31:21 -04:00
bors[bot]
2c638a467e
Merge #9709
...
9709: fix: add capability for "open cargo.toml" lsp extension r=matklad a=matklad
bors r+
🤖
Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>
2021-07-27 16:41:02 +00:00
Aleksey Kladov
7d6c4142b2
fix: add capability for "open cargo.toml" lsp extension
2021-07-27 19:40:19 +03:00
Alexander Gonzalez
c865b56744
docs: Fix several typos and grammar mistakes
2021-07-26 18:15:40 -04:00
bors[bot]
bf8a55a2df
Merge #9692
...
9692: Use same cancelled spelling in doc and code. r=matklad a=mattiasgronlund
Right thing might be to update the spelling in the code to
follow American instead of English spelling, that is
using only canceled. But they should at least be aligned.
Co-authored-by: Mattias Grönlund <mattias@gronlund.se>
2021-07-26 10:29:24 +00:00
Jonas Platte
c0107d2ea6
Fix some grammar / spelling mistakes
2021-07-26 10:12:41 +02:00
Mattias Grönlund
9e99a9b860
Use same cancelled spelling in doc and code.
...
Right thing might be to update the spelling in the code to
follow American instead of English spelling, that is
using only canceled. But they should at least be aligned.
2021-07-25 23:18:59 +02:00
Aleksey Kladov
efa4a36a50
docs: publish Explaining Rust Analyzer series
2021-07-19 23:41:15 +03:00
Aleksey Kladov
1dc337645a
minor: typo
2021-07-19 19:18:39 +03:00
Aleksey Kladov
6a0f7f0852
internal: explain why we avoid serializing everything
2021-07-19 17:47:56 +03:00
Alexander Gonzalez
60be683d5e
fix: Typo in architecture.md
2021-07-18 22:17:45 -04:00
Aleksey Kladov
a9d0d1414a
internal: remove erroneous default impl
2021-07-12 20:18:07 +03:00
Aleksey Kladov
706bd1c35d
minor: one more usless type
2021-07-08 17:18:44 +03:00
Aleksey Kladov
0db4f3f6a4
internal: ensure consistent passing for config params
...
We pass "context" parametes first, so configs should be on the left.
"Bigger" context wins, so configs goes after db.
2021-07-06 00:00:39 +03:00
Aleksey Kladov
f34762abb7
internal: better factoring for to_proto::completion
...
One source completion can produce up to two lsp completions.
Additionally, `preselct` and `sort_text` are global properties of the
whole set of completions, so the right granularity here is to convert
many completions.
As a side-benefit, we no loger allocate intermediate vec.
2021-07-04 14:08:33 +03:00
Aleksey Kladov
3be9ebe2c3
minor: style
2021-07-04 12:48:29 +03:00
Aleksey Kladov
58d2ece88a
internal: overhaul code generation
...
* Keep codegen adjacent to the relevant crates.
* Remove codgen deps from xtask, speeding-up from-source installation.
This regresses the release process a bit, as it now needs to run the
tests (and, by extension, compile the code).
2021-07-03 22:11:03 +03:00
Jonas Schievink
5f13fb9db9
Add "View Crate Graph (Full)"
2021-07-02 00:10:33 +02:00
bors[bot]
37dc2dfada
Merge #9348
...
9348: output to log file if RA_LOG_FILE is defined in environment r=rezural a=rezural
This adds a check for RA_LOG_FILE, and logs to that if defined. It currently overrides flags.log_file. If this is undesirable, I will add a check.
Co-authored-by: rezural <rezural@protonmail.com>
2021-06-21 21:42:02 +00:00
rezural
ceeee5e3c6
add documentation of RA_LOG_FILE
2021-06-22 07:28:33 +10:00
rezural
530ee4ff8a
add note about passing cfg(debug_assertions)
...
add note about passing cfg(debug_assertions) to rustc on build. The server will not spin without this arcane hack
2021-06-20 11:23:20 +10:00
Aleksey Kladov
3f4ad44082
internal: document that we don't #[ignore] tests
2021-06-15 11:46:47 +03:00
Jade
e23cfeac71
Fix typo in env-var quoting
2021-06-14 00:38:28 -07:00
Florian Diebold
0290b61b1b
Further clarification
2021-06-07 14:50:03 +02:00
Florian Diebold
b649376edc
One additional grammar fix
2021-06-07 14:43:58 +02:00
Florian Diebold
fc2d286dae
Clarify label documentation
...
Also some other cleanups while I'm there.
2021-06-07 14:34:41 +02:00
Aleksey Kladov
5e577a6373
minor: expand docs a tiny bit
2021-05-31 17:27:27 +03:00
Lukas Wirth
fb7105a580
Add config setting for self-on-the-fly
2021-05-31 15:14:56 +02:00
Aleksey Kladov
cabb679cbb
internal: explain the motivation behind early configuration
2021-05-27 11:16:14 +03:00
Jonas Schievink
3360053312
Update lsp-extensions.md
2021-05-22 00:03:36 +02:00
Aleksey Kladov
1fd31f7f4c
feat: allow clients to feature detect symbol filtering
2021-05-19 13:28:58 +03:00
alcroito
1f7d2a6c22
Add new LSP extension for workspace symbol lookup
...
The new extension allows filtering of workspace symbool lookup
results by search scope or search kind.
Filtering can be configured in 3 different ways:
- The '#' or '*' markers can be added inline with the symbol lookup
query.
The '#' marker means symbols should be looked up in the current
workspace and any dependencies. If not specified, only current
workspace is considered.
The '*' marker means all kinds of symbols should be looked up
(types, functions, etc). If not specified, only type symbols are
returned.
- Each LSP request can take an optional search_scope or search_kind
argument query parameter.
- Finally there are 2 global config options that can be set for all
requests served by the active RA instance.
Add support for setting the global config options to the VSCode
extension.
The extension does not use the per-request way, but it's useful for
other IDEs.
The latest version of VSCode filters out the inline markers, so
currently the only reasonable way to use the new functionality is
via the global config.
2021-05-18 00:40:30 +02:00
Aleksey Kladov
41510f437e
minor: adjust config name
2021-05-17 18:37:06 +03:00
Aleksey Kladov
0650f77dd9
internal: remove one more immutable tree
2021-05-14 16:19:27 +03:00
Aleksey Kladov
ad0648dc95
Cleanup imports
2021-05-13 13:44:47 +03:00
Jonas Schievink
b8d40a02a9
Document viewCrateGraph request
2021-05-11 16:45:51 +02:00
Aleksey Kladov
d4a51241ce
internal: explain why sentence-per-line
2021-05-06 17:40:36 +03:00