about summary refs log tree commit diff
path: root/src/tools/rust-analyzer/docs/user
AgeCommit message (Collapse)AuthorLines
2025-01-24manual: Convert to mdbookWilfred Hughes-2319/+0
Split manual.adoc into markdown files, one for each chapter. For the parts of the manual that are generated from source code doc comments, update the comments to use markdown syntax and update the code generators to write to `generated.md` files. For the weekly release, stop copying the .adoc files to the `rust-analyzer/rust-analyzer.github.io` at release time. Instead, we'll sync the manual hourly from this repository. See https://github.com/rust-analyzer/rust-analyzer.github.io/pull/226 for the sync. This PR should be merged first, and that PR needs to be merged before the next weekly release. This change is based on #15795, but rebased and updated. I've also manually checked each page for markdown syntax issues and fixed any I encountered. Co-authored-by: Lukas Wirth <lukastw97@gmail.com> Co-authored-by: Josh Rotenberg <joshrotenberg@gmail.com>
2025-01-24Merge pull request #18993 from ChayimFriedman2/iter-configLukas Wirth-0/+10
feat: Provide a config to control auto-insertion of `await` and `iter()`
2025-01-21manual: Document all rust-project.json fieldsWilfred Hughes-7/+83
Ensure that all the fields that rust-analyzer understands are in the manual, they all have doc comments, and they use consistent punctuation (`;` rather than mixing `,` and `;`). Whilst we're here, fix the `sysroot_src` example and add 2024 as a legal value for Rust edition.
2025-01-21Provide a config to control auto-insertion of `await` and `iter()`Chayim Refael Friedman-0/+10
2025-01-16Fix `debug_assertions` broken in 1c5a125beb35725ccc2ade005db9870db734bf23VinTarZ-1/+1
2025-01-15Flip on typing config to be opt-in, better defaultsLukas Wirth-4/+12
2025-01-10Implement implicit sized bound inlay hintsLukas Wirth-0/+5
2025-01-09Merge pull request #18880 from PrototypeNM1/extra-includesLukas Wirth-0/+7
Add config setting which allows adding additional include paths to the VFS.
2025-01-08Add config setting which allows adding additional include paths to the VFS.Nicholas Rishel-0/+7
2025-01-08fix: autogenerate filesqjerome-4/+4
2025-01-07target-triple -> target-tupleLukas Wirth-2/+2
2025-01-07Remove `rust-analyzer.cargo.sysrootQueryMetadata` config againLukas Wirth-6/+0
2025-01-01Merge pull request #18179 from ChayimFriedman2/omit-trait-completionLukas Wirth-0/+38
feat: Allow excluding specific traits from completion
2025-01-01Revamp auto-import exclude configLukas Wirth-5/+16
2025-01-01Reduce the default autoimport exclusion listLukas Wirth-40/+3
2025-01-01Allow excluding specific traits from completionChayim Refael Friedman-0/+64
To be accurate, only their methods are excluded, the trait themselves are still available. I also excluded a bunch of std traits by default. Some less opinionated, like `AsRef`, which should never be used directly except in generic scenarios (and won't be excluded there), some more opinionated, like the ops traits, which I know some users sometimes want to use directly. Either way it's configurable. It should be pretty easy to extend support to excluding only specific methods, but I didn't do that currently. Traits configured to be excluded are resolved in each completion request from scratch. If this proves too expensive, it is easy enough to cache them in the DB.
2024-12-26fix incorrect name for UpdateTest configroife-1/+1
2024-12-26feat: add config `UpdateTest` to hover actionsroife-0/+6
2024-12-26feat: support UpdateTest in codelensroife-0/+6
2024-12-24Merge pull request #18707 from ChayimFriedman2/substLukas Wirth-0/+9
feat: Show substitution where hovering over generic things
2024-12-22fix: Properly check if workspace flychecking is allowedLukas Wirth-1/+2
2024-12-20Show substitution where hovering over generic thingsChayim Refael Friedman-0/+9
There are few things to note in the implementation: First, this is a best-effort implementation. Mainly, type aliases may not be shown (due to their eager nature it's harder) and partial pathes (aka. hovering over `Struct` in `Struct::method`) are not supported at all. Second, we only need to show substitutions in expression and pattern position, because in type position all generic arguments always have to be written explicitly.
2024-12-11Fix publish workflow link in manualSam Estep-1/+1
2024-12-09Disable pipe on typing handlerLukas Wirth-1/+1
2024-12-06Add typing handler for param list pipeLukas Wirth-2/+2
2024-12-06Make bracket typing handler work on more thingsLukas Wirth-1/+1
2024-12-05Disable `<` typing handler againLukas Wirth-1/+1
2024-12-03chore: deprecate `typing.autoClosingAngleBrackets` configurationTarek-5/+0
Signed-off-by: Tarek <tareknaser360@gmail.com>
2024-12-03internal: Make exclude characters for typing assists configurable, default ↵Tarek-0/+5
to None Signed-off-by: Tarek <tareknaser360@gmail.com>
2024-11-18Re-add rust-analyzer.cargo.sysrootQueryMetadataDavid Richey-0/+6
2024-10-21Update ide testsLukas Wirth-22/+22
2024-10-13feat: respect references.exclude_tests in call-hierarchyroife-1/+1
2024-09-30Provide an config option to not set `cfg(test)`Chayim Refael Friedman-0/+5
2024-09-08Automatically add semicolon when completing unit-returning functionsChayim Refael Friedman-0/+7
But provide a config to suppress that. I didn't check whether we are in statement expression position, because this is hard in completion (due to the natural incompleteness of source code when completion is invoked), and anyway using function returning unit as an argument to something seems... dubious.
2024-09-01Provide an option to hide deprecated items from completionChayim Refael Friedman-0/+5
2024-08-23Auto merge of #17857 - ChayimFriedman2:rust-project-cfg-group, r=Veykrilbors-0/+12
feat: Allow declaring cfg groups in rust-project.json, to help sharing common cfgs Closes #17815.
2024-08-19Improve documentation for `InvocationStrategy`Lukas Wirth-2/+4
2024-08-19chore(config): remove `invocationLocation` in favor of `invocationStrategy`Victor Song-24/+2
These flags were added to help rust-analyzer integrate with repos requiring non-Cargo invocations. The consensus is that having two independent settings are no longer needed. This change removes `invocationLocation` in favor of `invocationStrategy` and changes the internal representation of `InvocationStrategy::Once` to hold the workspace root.
2024-08-12Allow declaring cfg groups in rust-project.json, to help sharing common cfgsChayim Refael Friedman-0/+12
2024-08-05Auto merge of #17793 - jjoeldaniel:msvc-docs, r=Veykrilbors-0/+6
docs: add msvc note to manual Added note for Windows users to have the latest MSVC to minimize setup issues. Closes #4870
2024-08-05feat: Load sysroot library via cargo metadataLukas Wirth-10/+0
2024-08-05add msvc note to manualJoel Daniel Rico-0/+6
2024-07-31docs: Fix JSON example for rust-analyzer.workspace.discoverConfigWilfred Hughes-4/+3
The user does not specify `{arg}` in their JSON, and be pedantic about commas in JSON sample.
2024-07-23internal: remove UnindexedProject notificationDavid Barsky-5/+0
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
2024-07-23Remove lens.forceCustomCommands configPaulDotSH-6/+0
2024-07-18Auto merge of #17246 - ↵bors-0/+98
davidbarsky:david/move-rust-project-generation-to-server, r=Veykril feature: teach rust-analyzer to discover `linked_projects` This PR's been a long-time coming, but like the title says, it introduces server-side project discovery and removes the extension hooks I previously introduced. I don't think this PR is ready to land, but here are the things I'm feeling squishy about: - I don't think I like the idea of introducing the `cargo-metadata` command-but-for-everything-else in the `flycheck` module, but the progress reporting infrastructure was too convenient to pass up. Happy to move it elsewhere. Here are the things I _know_ I need to change: - For progress reporting, I'm extracting from a `serde_json::Value` that corresponds to `tracing_subsciber::fmt::Layer`'s JSON output. I'd like to make this a bit more structured/documented than the current nonsense I wrote. - The progress reporting currently hardcodes "Buck"; it should be deriving that from the previously mentioned more-structured-output. - This doesn't handle *reloading* when a corresponding buildfile is changed. It should be doing that. <details> <summary>Anyway, here's a video of rust-analyzer discovering a Buck target.</summary> https://github.com/rust-lang/rust-analyzer/assets/2067774/be6cd9b9-2c9a-402d-847f-05f860a91df1 </details>
2024-07-18feature: move `linked_projects` discovery to the rust-analyzer serverDavid Barsky-0/+98
2024-07-17Auto merge of #17616 - Veykril:config-param-hints, r=Veykrilbors-2/+2
Fix incorrect generic parameter hint defaults Missed this in the review but we should show const param hints, not lifetime param hints by default
2024-07-17Fix incorrect generic parameter hint defaultsLukas Wirth-2/+2
2024-07-17Add --keep-going to rust-analyzer.cargo.buildScripts.overrideCommand docsLaurențiu Nicola-1/+1