actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-12-23 08:02:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(config): Make config more discoverable

Browse source
This commit is contained in:
Ed Page 2021-01-04 16:15:31 -06:00
parent f27282fbc0
commit 5db9a8e1c9
2 changed files with 52 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/args.rs
View file

@ -75,6 +75,10 @@ pub(crate) struct Args {
/// Debug: Print each word that would be spellchecked.
pub(crate) words: bool,
#[structopt(long, group = "mode")]
/// Write the current configuration to file.
pub(crate) dump_config: Option<std::path::PathBuf>,
#[structopt(flatten)]
pub(crate) overrides: FileArgs,

60
src/main.rs
View file

@ -34,13 +34,40 @@ fn run() -> proc_exit::ExitResult {
};
init_logging(args.verbose.log_level());
if let Some(output_path) = args.dump_config.as_ref() {
run_dump_config(&args, output_path)
} else {
run_checks(&args)
}
}
fn run_dump_config(args: &args::Args, output_path: &std::path::Path) -> proc_exit::ExitResult {
let global_cwd = std::env::current_dir()?;
let config = if let Some(path) = args.custom_config.as_ref() {
config::Config::from_file(path).with_code(proc_exit::Code::CONFIG_ERR)?
let path = &args.path[0];
let path = if path == std::path::Path::new("-") {
path.to_owned()
} else {
config::Config::default()
path.canonicalize().with_code(proc_exit::Code::USAGE_ERR)?
};
let cwd = if path == std::path::Path::new("-") {
global_cwd.as_path()
} else if path.is_file() {
path.parent().unwrap()
} else {
path.as_path()
};
let config = load_config(cwd, &args).with_code(proc_exit::Code::CONFIG_ERR)?;
let output = toml::to_string_pretty(&config).with_code(proc_exit::Code::FAILURE)?;
std::fs::write(output_path, &output)?;
Ok(())
}
fn run_checks(args: &args::Args) -> proc_exit::ExitResult {
let global_cwd = std::env::current_dir()?;
let mut typos_found = false;
let mut errors_found = false;
@ -57,15 +84,7 @@ fn run() -> proc_exit::ExitResult {
} else {
path.as_path()
};
let mut config = config.clone();
if !args.isolated {
let derived = config::Config::derive(cwd).with_code(proc_exit::Code::CONFIG_ERR)?;
config.update(&derived);
}
config.update(&args.config);
config.default.update(&args.overrides);
let config = config;
let config = load_config(cwd, &args).with_code(proc_exit::Code::CONFIG_ERR)?;
let parser = typos::tokens::TokenizerBuilder::new()
.ignore_hex(config.default.ignore_hex())
@ -194,3 +213,20 @@ fn init_logging(level: Option<log::Level>) {
builder.init();
}
}
fn load_config(cwd: &std::path::Path, args: &args::Args) -> Result<config::Config, anyhow::Error> {
let mut config = config::Config::default();
if let Some(path) = args.custom_config.as_ref() {
config.update(&config::Config::from_file(path)?);
}
if !args.isolated {
let derived = config::Config::derive(cwd)?;
config.update(&derived);
}
config.update(&args.config);
config.default.update(&args.overrides);
Ok(config)
}