Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add documentation to the nargo lsp command #2169

Merged
merged 1 commit into from
Aug 4, 2023
Merged

chore: add documentation to the nargo lsp command #2169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crates/nargo_cli/src/cli/lsp_cmd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
use super::NargoConfig;
use crate::errors::CliError;

/// Starts the Noir LSP server
///
/// Starts an LSP server which allows IDEs such as VS Code to display diagnostics in Noir source.
///
/// VS Code Noir Language Support: https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir
#[derive(Debug, Clone, Args)]
pub(crate) struct LspCommand {
#[clap(flatten)]
Expand Down Expand Up @@ -41,7 +46,7 @@
.service(router)
});

// Prefer truely asynchronous piped stdin/stdout without blocking tasks.

Check warning on line 49 in crates/nargo_cli/src/cli/lsp_cmd.rs

View workflow job for this annotation

GitHub Actions / Spellcheck / Spellcheck 

Unknown word (truely)
#[cfg(unix)]
let (stdin, stdout) = (
async_lsp::stdio::PipeStdin::lock_tokio().unwrap(),
Expand Down