mirror of
https://github.com/nushell/nushell
synced 2024-12-27 05:23:11 +00:00
439889dcef
This commit adds the ability to work on features behind a feature flag
that won't be included in normal builds of nu.
These features are not exposed as Cargo features, as they reflect
incomplete features that are not yet stable.
To create a feature, add it to `features.toml`:
```toml
[hintsv1]
description = "Adding hints based on error states in the highlighter"
enabled = false
```
Each feature in `features.toml` becomes a feature flag accessible to `cfg`:
```rs
println!("hintsv1 is enabled");
```
By default, features are enabled based on the value of the `enabled` field.
You can also enable a feature from the command line via the
`NUSHELL_ENABLE_FLAGS` environment variable:
```sh
$ NUSHELL_ENABLE_FLAGS=hintsv1 cargo run
```
You can enable all flags via `NUSHELL_ENABLE_ALL_FLAGS`.
This commit also updates the CI setup to run the build with all flags off and
with all flags on. It also extracts the linting test into its own
parallelizable test, which means it doesn't need to run together with every
other test anymore.
When working on a feature, you should also add tests behind the same flag. A
commit is mergable if all tests pass with and without the flag, allowing
incomplete commits to land on master as long as the incomplete code builds and
passes tests.
39 lines
1.1 KiB
Rust
39 lines
1.1 KiB
Rust
use serde::Deserialize;
|
|
use std::collections::HashMap;
|
|
use std::collections::HashSet;
|
|
use std::env;
|
|
use std::path::Path;
|
|
|
|
#[derive(Deserialize)]
|
|
struct Feature {
|
|
#[allow(unused)]
|
|
description: String,
|
|
enabled: bool,
|
|
}
|
|
|
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
let input = env::var("CARGO_MANIFEST_DIR").unwrap();
|
|
let all_on = env::var("NUSHELL_ENABLE_ALL_FLAGS").is_ok();
|
|
let flags: HashSet<String> = env::var("NUSHELL_ENABLE_FLAGS")
|
|
.map(|s| s.split(",").map(|s| s.to_string()).collect())
|
|
.unwrap_or_else(|_| HashSet::new());
|
|
|
|
if all_on && !flags.is_empty() {
|
|
println!(
|
|
"cargo:warning={}",
|
|
"Both NUSHELL_ENABLE_ALL_FLAGS and NUSHELL_ENABLE_FLAGS were set. You don't need both."
|
|
);
|
|
}
|
|
|
|
let path = Path::new(&input).join("features.toml");
|
|
|
|
let toml: HashMap<String, Feature> = toml::from_str(&std::fs::read_to_string(path)?)?;
|
|
|
|
for (key, value) in toml.iter() {
|
|
if value.enabled == true || all_on || flags.contains(key) {
|
|
println!("cargo:rustc-cfg={}", key);
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|