squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Auto merge of #13259 - Veykril:cargo-config-simplify, r=Veykril

Browse source 
Simplify feature representation in CargoConfig
This commit is contained in:
bors 2022-09-19 14:53:06 +00:00
parent 187bee0bb1 d9f5709609
commit bc6d574662
5 changed files with 109 additions and 90 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
crates/project-model/src/build_scripts.rs
View file

@ -15,7 +15,7 @@ use rustc_hash::FxHashMap;
use semver::Version; use semver::Version;
use serde::Deserialize; use serde::Deserialize;
use crate::{cfg_flag::CfgFlag, CargoConfig, CargoWorkspace, Package}; use crate::{cfg_flag::CfgFlag, CargoConfig, CargoFeatures, CargoWorkspace, Package};
#[derive(Debug, Default, Clone, PartialEq, Eq)] #[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct WorkspaceBuildScripts { pub struct WorkspaceBuildScripts {
@ -49,7 +49,6 @@ impl WorkspaceBuildScripts {
let mut cmd = Command::new(toolchain::cargo()); let mut cmd = Command::new(toolchain::cargo());
cmd.envs(&config.extra_env); cmd.envs(&config.extra_env);
cmd.args(&["check", "--quiet", "--workspace", "--message-format=json"]); cmd.args(&["check", "--quiet", "--workspace", "--message-format=json"]);
// --all-targets includes tests, benches and examples in addition to the // --all-targets includes tests, benches and examples in addition to the
@ -61,15 +60,18 @@ impl WorkspaceBuildScripts {
cmd.args(&["--target", target]); cmd.args(&["--target", target]);
} }
if config.all_features { match &config.features {
cmd.arg("--all-features"); CargoFeatures::All => {
} else { cmd.arg("--all-features");
if config.no_default_features {
cmd.arg("--no-default-features");
} }
if !config.features.is_empty() { CargoFeatures::Selected { features, no_default_features } => {
cmd.arg("--features"); if *no_default_features {
cmd.arg(config.features.join(" ")); cmd.arg("--no-default-features");
}
if !features.is_empty() {
cmd.arg("--features");
cmd.arg(features.join(" "));
}
} }
} }

61
crates/project-model/src/cargo_workspace.rs
View file

@ -71,35 +71,41 @@ impl Default for UnsetTestCrates {
} }
} }
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum CargoFeatures {
All,
Selected {
/// List of features to activate.
features: Vec<String>,
/// Do not activate the `default` feature.
no_default_features: bool,
},
}
impl Default for CargoFeatures {
fn default() -> Self {
CargoFeatures::Selected { features: vec![], no_default_features: false }
}
}
#[derive(Default, Clone, Debug, PartialEq, Eq)] #[derive(Default, Clone, Debug, PartialEq, Eq)]
pub struct CargoConfig { pub struct CargoConfig {
/// Do not activate the `default` feature.
pub no_default_features: bool,
/// Activate all available features
pub all_features: bool,
/// List of features to activate. /// List of features to activate.
/// This will be ignored if `cargo_all_features` is true. pub features: CargoFeatures,
pub features: Vec<String>,
/// rustc target /// rustc target
pub target: Option<String>, pub target: Option<String>,
/// Don't load sysroot crates (`std`, `core` & friends). Might be useful /// Don't load sysroot crates (`std`, `core` & friends). Might be useful
/// when debugging isolated issues. /// when debugging isolated issues.
pub no_sysroot: bool, pub no_sysroot: bool,
/// rustc private crate source /// rustc private crate source
pub rustc_source: Option<RustcSource>, pub rustc_source: Option<RustcSource>,
/// crates to disable `#[cfg(test)]` on /// crates to disable `#[cfg(test)]` on
pub unset_test_crates: UnsetTestCrates, pub unset_test_crates: UnsetTestCrates,
/// Invoke `cargo check` through the RUSTC_WRAPPER.
pub wrap_rustc_in_build_scripts: bool, pub wrap_rustc_in_build_scripts: bool,
/// The command to run instead of `cargo check` for building build scripts.
pub run_build_script_command: Option<Vec<String>>, pub run_build_script_command: Option<Vec<String>>,
/// Extra env vars to set when invoking the cargo command
pub extra_env: FxHashMap<String, String>, pub extra_env: FxHashMap<String, String>,
} }
@ -143,7 +149,7 @@ pub struct PackageData {
pub targets: Vec<Target>, pub targets: Vec<Target>,
/// Does this package come from the local filesystem (and is editable)? /// Does this package come from the local filesystem (and is editable)?
pub is_local: bool, pub is_local: bool,
// Whether this package is a member of the workspace /// Whether this package is a member of the workspace
pub is_member: bool, pub is_member: bool,
/// List of packages this package depends on /// List of packages this package depends on
pub dependencies: Vec<PackageDependency>, pub dependencies: Vec<PackageDependency>,
@ -249,8 +255,8 @@ impl TargetKind {
} }
} }
// Deserialize helper for the cargo metadata
#[derive(Deserialize, Default)] #[derive(Deserialize, Default)]
// Deserialise helper for the cargo metadata
struct PackageMetadata { struct PackageMetadata {
#[serde(rename = "rust-analyzer")] #[serde(rename = "rust-analyzer")]
rust_analyzer: Option<RustAnalyzerPackageMetaData>, rust_analyzer: Option<RustAnalyzerPackageMetaData>,
@ -272,16 +278,19 @@ impl CargoWorkspace {
let mut meta = MetadataCommand::new(); let mut meta = MetadataCommand::new();
meta.cargo_path(toolchain::cargo()); meta.cargo_path(toolchain::cargo());
meta.manifest_path(cargo_toml.to_path_buf()); meta.manifest_path(cargo_toml.to_path_buf());
if config.all_features { match &config.features {
meta.features(CargoOpt::AllFeatures); CargoFeatures::All => {
} else { meta.features(CargoOpt::AllFeatures);
if config.no_default_features {
// FIXME: `NoDefaultFeatures` is mutual exclusive with `SomeFeatures`
// https://github.com/oli-obk/cargo_metadata/issues/79
meta.features(CargoOpt::NoDefaultFeatures);
} }
if !config.features.is_empty() { CargoFeatures::Selected { features, no_default_features } => {
meta.features(CargoOpt::SomeFeatures(config.features.clone())); if *no_default_features {
// FIXME: `NoDefaultFeatures` is mutual exclusive with `SomeFeatures`
// https://github.com/oli-obk/cargo_metadata/issues/79
meta.features(CargoOpt::NoDefaultFeatures);
}
if !features.is_empty() {
meta.features(CargoOpt::SomeFeatures(features.clone()));
}
} }
} }
meta.current_dir(current_dir.as_os_str()); meta.current_dir(current_dir.as_os_str());

4
crates/project-model/src/lib.rs
View file

@ -42,8 +42,8 @@ use rustc_hash::FxHashSet;
pub use crate::{ pub use crate::{
build_scripts::WorkspaceBuildScripts, build_scripts::WorkspaceBuildScripts,
cargo_workspace::{ cargo_workspace::{
CargoConfig, CargoWorkspace, Package, PackageData, PackageDependency, RustcSource, Target, CargoConfig, CargoFeatures, CargoWorkspace, Package, PackageData, PackageDependency,
TargetData, TargetKind, UnsetTestCrates, RustcSource, Target, TargetData, TargetKind, UnsetTestCrates,
}, },
manifest_path::ManifestPath, manifest_path::ManifestPath,
project_json::{ProjectJson, ProjectJsonData}, project_json::{ProjectJson, ProjectJsonData},

82
crates/rust-analyzer/src/cargo_target_spec.rs
View file

@ -4,7 +4,7 @@ use std::mem;
use cfg::{CfgAtom, CfgExpr}; use cfg::{CfgAtom, CfgExpr};
use ide::{FileId, RunnableKind, TestId}; use ide::{FileId, RunnableKind, TestId};
use project_model::{self, ManifestPath, TargetKind}; use project_model::{self, CargoFeatures, ManifestPath, TargetKind};
use vfs::AbsPathBuf; use vfs::AbsPathBuf;
use crate::{global_state::GlobalStateSnapshot, Result}; use crate::{global_state::GlobalStateSnapshot, Result};
@ -35,41 +35,41 @@ impl CargoTargetSpec {
match kind { match kind {
RunnableKind::Test { test_id, attr } => { RunnableKind::Test { test_id, attr } => {
args.push("test".to_string()); args.push("test".to_owned());
extra_args.push(test_id.to_string()); extra_args.push(test_id.to_string());
if let TestId::Path(_) = test_id { if let TestId::Path(_) = test_id {
extra_args.push("--exact".to_string()); extra_args.push("--exact".to_owned());
} }
extra_args.push("--nocapture".to_string()); extra_args.push("--nocapture".to_owned());
if attr.ignore { if attr.ignore {
extra_args.push("--ignored".to_string()); extra_args.push("--ignored".to_owned());
} }
} }
RunnableKind::TestMod { path } => { RunnableKind::TestMod { path } => {
args.push("test".to_string()); args.push("test".to_owned());
extra_args.push(path.to_string()); extra_args.push(path.clone());
extra_args.push("--nocapture".to_string()); extra_args.push("--nocapture".to_owned());
} }
RunnableKind::Bench { test_id } => { RunnableKind::Bench { test_id } => {
args.push("bench".to_string()); args.push("bench".to_owned());
extra_args.push(test_id.to_string()); extra_args.push(test_id.to_string());
if let TestId::Path(_) = test_id { if let TestId::Path(_) = test_id {
extra_args.push("--exact".to_string()); extra_args.push("--exact".to_owned());
} }
extra_args.push("--nocapture".to_string()); extra_args.push("--nocapture".to_owned());
} }
RunnableKind::DocTest { test_id } => { RunnableKind::DocTest { test_id } => {
args.push("test".to_string()); args.push("test".to_owned());
args.push("--doc".to_string()); args.push("--doc".to_owned());
extra_args.push(test_id.to_string()); extra_args.push(test_id.to_string());
extra_args.push("--nocapture".to_string()); extra_args.push("--nocapture".to_owned());
} }
RunnableKind::Bin => { RunnableKind::Bin => {
let subcommand = match spec { let subcommand = match spec {
Some(CargoTargetSpec { target_kind: TargetKind::Test, .. }) => "test", Some(CargoTargetSpec { target_kind: TargetKind::Test, .. }) => "test",
_ => "run", _ => "run",
}; };
args.push(subcommand.to_string()); args.push(subcommand.to_owned());
} }
} }
@ -82,29 +82,35 @@ impl CargoTargetSpec {
}; };
let cargo_config = snap.config.cargo(); let cargo_config = snap.config.cargo();
if cargo_config.all_features {
args.push("--all-features".to_string());
for feature in target_required_features { match &cargo_config.features {
args.push("--features".to_string()); CargoFeatures::All => {
args.push(feature); args.push("--all-features".to_owned());
} for feature in target_required_features {
} else { args.push("--features".to_owned());
let mut features = Vec::new(); args.push(feature);
if let Some(cfg) = cfg.as_ref() { }
required_features(cfg, &mut features);
} }
CargoFeatures::Selected { features, no_default_features } => {
let mut feats = Vec::new();
if let Some(cfg) = cfg.as_ref() {
required_features(cfg, &mut feats);
}
features.extend(cargo_config.features); feats.extend(features.iter().cloned());
features.extend(target_required_features); feats.extend(target_required_features);
features.dedup(); feats.dedup();
for feature in features { for feature in feats {
args.push("--features".to_string()); args.push("--features".to_owned());
args.push(feature); args.push(feature);
}
if *no_default_features {
args.push("--no-default-features".to_owned());
}
} }
} }
Ok((args, extra_args)) Ok((args, extra_args))
} }
@ -136,7 +142,7 @@ impl CargoTargetSpec {
} }
pub(crate) fn push_to(self, buf: &mut Vec<String>, kind: &RunnableKind) { pub(crate) fn push_to(self, buf: &mut Vec<String>, kind: &RunnableKind) {
buf.push("--package".to_string()); buf.push("--package".to_owned());
buf.push(self.package); buf.push(self.package);
// Can't mix --doc with other target flags // Can't mix --doc with other target flags
@ -145,23 +151,23 @@ impl CargoTargetSpec {
} }
match self.target_kind { match self.target_kind {
TargetKind::Bin => { TargetKind::Bin => {
buf.push("--bin".to_string()); buf.push("--bin".to_owned());
buf.push(self.target); buf.push(self.target);
} }
TargetKind::Test => { TargetKind::Test => {
buf.push("--test".to_string()); buf.push("--test".to_owned());
buf.push(self.target); buf.push(self.target);
} }
TargetKind::Bench => { TargetKind::Bench => {
buf.push("--bench".to_string()); buf.push("--bench".to_owned());
buf.push(self.target); buf.push(self.target);
} }
TargetKind::Example => { TargetKind::Example => {
buf.push("--example".to_string()); buf.push("--example".to_owned());
buf.push(self.target); buf.push(self.target);
} }
TargetKind::Lib => { TargetKind::Lib => {
buf.push("--lib".to_string()); buf.push("--lib".to_owned());
} }
TargetKind::Other | TargetKind::BuildScript => (), TargetKind::Other | TargetKind::BuildScript => (),
} }

30
crates/rust-analyzer/src/config.rs
View file

@ -22,7 +22,8 @@ use ide_db::{
use itertools::Itertools; use itertools::Itertools;
use lsp_types::{ClientCapabilities, MarkupKind}; use lsp_types::{ClientCapabilities, MarkupKind};
use project_model::{ use project_model::{
CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest, RustcSource, UnsetTestCrates, CargoConfig, CargoFeatures, ProjectJson, ProjectJsonData, ProjectManifest, RustcSource,
UnsetTestCrates,
}; };
use rustc_hash::{FxHashMap, FxHashSet}; use rustc_hash::{FxHashMap, FxHashSet};
use serde::{de::DeserializeOwned, Deserialize}; use serde::{de::DeserializeOwned, Deserialize};
@ -90,7 +91,7 @@ config_data! {
/// List of features to activate. /// List of features to activate.
/// ///
/// Set this to `"all"` to pass `--all-features` to cargo. /// Set this to `"all"` to pass `--all-features` to cargo.
cargo_features: CargoFeatures = "[]", cargo_features: CargoFeaturesDef = "[]",
/// Whether to pass `--no-default-features` to cargo. /// Whether to pass `--no-default-features` to cargo.
cargo_noDefaultFeatures: bool = "false", cargo_noDefaultFeatures: bool = "false",
/// Internal config for debugging, disables loading of sysroot crates. /// Internal config for debugging, disables loading of sysroot crates.
@ -114,7 +115,7 @@ config_data! {
/// `#rust-analyzer.cargo.features#`. /// `#rust-analyzer.cargo.features#`.
/// ///
/// Set to `"all"` to pass `--all-features` to Cargo. /// Set to `"all"` to pass `--all-features` to Cargo.
checkOnSave_features: Option<CargoFeatures> = "null", checkOnSave_features: Option<CargoFeaturesDef> = "null",
/// Whether to pass `--no-default-features` to Cargo. Defaults to /// Whether to pass `--no-default-features` to Cargo. Defaults to
/// `#rust-analyzer.cargo.noDefaultFeatures#`. /// `#rust-analyzer.cargo.noDefaultFeatures#`.
checkOnSave_noDefaultFeatures: Option<bool> = "null", checkOnSave_noDefaultFeatures: Option<bool> = "null",
@ -1028,11 +1029,12 @@ impl Config {
}); });
CargoConfig { CargoConfig {
no_default_features: self.data.cargo_noDefaultFeatures,
all_features: matches!(self.data.cargo_features, CargoFeatures::All),
features: match &self.data.cargo_features { features: match &self.data.cargo_features {
CargoFeatures::All => vec![], CargoFeaturesDef::All => CargoFeatures::All,
CargoFeatures::Listed(it) => it.clone(), CargoFeaturesDef::Selected(features) => CargoFeatures::Selected {
features: features.clone(),
no_default_features: self.data.cargo_noDefaultFeatures,
},
}, },
target: self.data.cargo_target.clone(), target: self.data.cargo_target.clone(),
no_sysroot: self.data.cargo_noSysroot, no_sysroot: self.data.cargo_noSysroot,
@ -1086,7 +1088,7 @@ impl Config {
.unwrap_or(self.data.cargo_noDefaultFeatures), .unwrap_or(self.data.cargo_noDefaultFeatures),
all_features: matches!( all_features: matches!(
self.data.checkOnSave_features.as_ref().unwrap_or(&self.data.cargo_features), self.data.checkOnSave_features.as_ref().unwrap_or(&self.data.cargo_features),
CargoFeatures::All CargoFeaturesDef::All
), ),
features: match self features: match self
.data .data
@ -1094,8 +1096,8 @@ impl Config {
.clone() .clone()
.unwrap_or_else(|| self.data.cargo_features.clone()) .unwrap_or_else(|| self.data.cargo_features.clone())
{ {
CargoFeatures::All => vec![], CargoFeaturesDef::All => vec![],
CargoFeatures::Listed(it) => it, CargoFeaturesDef::Selected(it) => it,
}, },
extra_args: self.data.checkOnSave_extraArgs.clone(), extra_args: self.data.checkOnSave_extraArgs.clone(),
extra_env: self.check_on_save_extra_env(), extra_env: self.check_on_save_extra_env(),
@ -1564,10 +1566,10 @@ enum CallableCompletionDef {
#[derive(Deserialize, Debug, Clone)] #[derive(Deserialize, Debug, Clone)]
#[serde(untagged)] #[serde(untagged)]
enum CargoFeatures { enum CargoFeaturesDef {
#[serde(deserialize_with = "de_unit_v::all")] #[serde(deserialize_with = "de_unit_v::all")]
All, All,
Listed(Vec<String>), Selected(Vec<String>),
} }
#[derive(Deserialize, Debug, Clone)] #[derive(Deserialize, Debug, Clone)]
@ -1912,7 +1914,7 @@ fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json
"Only show mutable reborrow hints." "Only show mutable reborrow hints."
] ]
}, },
"CargoFeatures" => set! { "CargoFeaturesDef" => set! {
"anyOf": [ "anyOf": [
{ {
"type": "string", "type": "string",
@ -1929,7 +1931,7 @@ fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json
} }
], ],
}, },
"Option<CargoFeatures>" => set! { "Option<CargoFeaturesDef>" => set! {
"anyOf": [ "anyOf": [
{ {
"type": "string", "type": "string",