Collapse invocationLocation and invocationStrategy into a single setting

[RalfJung]

These options were added to explore how RA can best work with repos like rustc and Miri that need special non-cargo invocations (./x.py ..././miri ...). The consensus that generally has emerged is that these scripts should be invoked exactly once, in the root, and they will emit all the diagnostics for all parts of the project with paths relative to the root. There were ideas of having RA pass --manifest-path or so, with template magic available in overrideCommand to control where to put that flag; I don't think any more that those are promising.

If there are no other usecases being covered by these flags then most of the freedom provided by having two independent settings, invocationLocation and invocationStrategy, isn't actually needed. A possible simplification here might be to only have invocationLocation, and if it is set to "root" then that also implies running it only once (since it seems kind of pointless to run the same command in the same location multiple times). invocationStrategy could then be removed. Or conversely, invocationStrategy is preserved and setting it to once means "run it once, in the root".

[Veykril]

+1 for keeping invocationStrategy, I think that is the clearer name one to imply both things (though im also open to a new name for this altogether).

To add context, these settings were generally never meant to stick around, they were only an escape hatch for rustc's x tool, so simplifying this is definitely wanted. We still have the --saved-file stuff, but those also mainly want the root-once behavior to my knowledge so they aren't relevant to this.

[Veykril]

So the best way to go about this is to remove the one config half here

rust-analyzer/crates/rust-analyzer/src/config.rs

Lines 83 to 95 in 56f63df

	/// Specifies the working directory for running build scripts.
	/// - "workspace": run build scripts for a workspace in the workspace's root directory.
	/// This is incompatible with `#rust-analyzer.cargo.buildScripts.invocationStrategy#` set to `once`.
	/// - "root": run build scripts in the project's root directory.
	/// This config only has an effect when `#rust-analyzer.cargo.buildScripts.overrideCommand#`
	/// is set.
	cargo_buildScripts_invocationLocation: InvocationLocation = InvocationLocation::Workspace,
	/// Specifies the invocation strategy to use when running the build scripts command.
	/// If `per_workspace` is set, the command will be executed for each workspace.
	/// If `once` is set, the command will be executed once.
	/// This config only has an effect when `#rust-analyzer.cargo.buildScripts.overrideCommand#`
	/// is set.
	cargo_buildScripts_invocationStrategy: InvocationStrategy = InvocationStrategy::PerWorkspace,

and here

rust-analyzer/crates/rust-analyzer/src/config.rs

Lines 185 to 198 in 56f63df

	/// Specifies the working directory for running checks.
	/// - "workspace": run checks for workspaces in the corresponding workspaces' root directories.
	// FIXME: Ideally we would support this in some way
	/// This falls back to "root" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.
	/// - "root": run checks in the project's root directory.
	/// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
	/// is set.
	check_invocationLocation | checkOnSave_invocationLocation: InvocationLocation = InvocationLocation::Workspace,
	/// Specifies the invocation strategy to use when running the check command.
	/// If `per_workspace` is set, the command will be executed for each workspace.
	/// If `once` is set, the command will be executed once.
	/// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
	/// is set.
	check_invocationStrategy | checkOnSave_invocationStrategy: InvocationStrategy = InvocationStrategy::PerWorkspace,

and let the compiler guide you in removing whatever depends on that (such a great thing with rustc really).

In the build scripts part changes are simply, the branch here can be dropped for picking workspace.root() unconditionally

rust-analyzer/crates/project-model/src/build_dependencies.rs

Lines 66 to 69 in 56f63df

	let current_dir = match &config.invocation_location {
	InvocationLocation::Root(root) if config.run_build_script_command.is_some() => root,
	_ => workspace.workspace_root(),
	};

and the branch here can be dropped, we will always use root here

rust-analyzer/crates/project-model/src/build_dependencies.rs

Lines 92 to 100 in 56f63df

	let current_dir = match &config.invocation_location {
	InvocationLocation::Root(root) => root,
	InvocationLocation::Workspace => {
	return Err(io::Error::new(
	io::ErrorKind::Other,
	"Cannot run build scripts from workspace with invocation strategy `once`",
	))
	}
	};

For flycheck you'll have to drop the outer match here https://github.com/veykril/rust-analyzer/blob/56f63dfd8aeebf80e3fc87894fa3d5a40f98a329/crates/rust-analyzer/src/flycheck.rs#L434-L449 and change the InvocationStrategy::Once arm to use the root, so that means we'll have to thread the root through InvocationStrategy::Once (change it to what Invocationlocation::Root was, holding a path).

[Tyrubias]

@rustbot claim