Documentation

shellexpand is a single dependency library which allows one to perform shell-like expansions in strings, that is, to expand variables like $A or ${B} into their values inside some context and to expand ~ in the beginning of a string into the home directory (again, inside some context).

This crate provides generic functions which accept arbitrary contexts as well as default, system-based functions which perform expansions using the system-wide context (represented by functions from std::env module and dirs-next crate).

Note: because I no longer have capacity to support it, I'm now looking for a new maintainer for this library. Until I'm able to find one, it is unlikely to receive new updates in any reasonably timely manner.

Just add a dependency in your Cargo.toml:

[dependencies]
shellexpand = "2.1"

See the crate documentation (a link is present in the beginning of this readme) for more information and examples.

• Switched to dirs-next instead of the obsolete dirs as the underlying dependency used to resolve the home directory
• Switched to GitHub Actions instead of Travis CI for building the project.

• Added support for default values in variable expansion (i.e. ${ANSWER:-42})
• Breaking changes (minimum Rust version is now 1.30.0):
  • Using dyn for trait objects to fix deprecation warning
  • Switched to using source() instead of cause() in the Error implementation, and therefore added a 'static bound for the generic error parameter E

• Bump dirs dependency to 2.0.

• Changed use of deprecated std::env::home_dir to the dirs::home_dir function

• Fixed typos and minor incompletenesses in the documentation
• Changed home_dir argument type for tilde expansion functions to FnOnce instead FnMut
• Changed LookupError::name field name to var_name

• Initial release

This program is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.