use crossterm::style::Stylize;
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use dprint_cli_core::types::ErrBox;
use parking_lot::Mutex;
use crate::cache::Cache;
use crate::cli::configuration::resolve_config_from_args;
use crate::cli::format::{format_with_plugin_pools, run_parallelized};
use crate::cli::incremental::get_incremental_file;
use crate::cli::paths::{get_and_resolve_file_paths, get_file_paths_by_plugin_and_err_if_empty};
use crate::cli::patterns::FileMatcher;
use crate::cli::plugins::resolve_plugins_and_err_if_empty;
use crate::cli::{CliArgs, FmtSubCommand, StdInFmtSubCommand};
use crate::environment::Environment;
use crate::plugins::{PluginPools, PluginResolver};
use crate::utils::{get_difference, BOM_CHAR};
pub fn stdin_fmt<TEnvironment: Environment>(
cmd: &StdInFmtSubCommand,
args: &CliArgs,
environment: &TEnvironment,
cache: &Cache<TEnvironment>,
plugin_resolver: &PluginResolver<TEnvironment>,
plugin_pools: Arc<PluginPools<TEnvironment>>,
) -> Result<(), ErrBox> {
let config = resolve_config_from_args(&args, cache, environment)?;
let plugins = resolve_plugins_and_err_if_empty(&args, &config, environment, plugin_resolver)?;
plugin_pools.set_plugins(plugins);
if environment.is_absolute_path(&cmd.file_name_or_path) {
let file_matcher = FileMatcher::new(&config, args, environment)?;
match environment.canonicalize(&cmd.file_name_or_path) {
Ok(resolved_file_path) => {
if !file_matcher.matches(&resolved_file_path) {
environment.log_silent(&cmd.file_text);
return Ok(());
}
}
Err(err) => return err!("Error canonicalizing file {}: {}", cmd.file_name_or_path, err.to_string()),
}
}
output_stdin_format(&PathBuf::from(&cmd.file_name_or_path), &cmd.file_text, environment, plugin_pools)
}
fn output_stdin_format<TEnvironment: Environment>(
file_name: &Path,
file_text: &str,
environment: &TEnvironment,
plugin_pools: Arc<PluginPools<TEnvironment>>,
) -> Result<(), ErrBox> {
let formatted_text = format_with_plugin_pools(file_name, file_text, environment, &plugin_pools)?;
environment.log_silent(&formatted_text);
Ok(())
}
pub fn output_format_times<TEnvironment: Environment>(
args: &CliArgs,
environment: &TEnvironment,
cache: &Cache<TEnvironment>,
plugin_resolver: &PluginResolver<TEnvironment>,
plugin_pools: Arc<PluginPools<TEnvironment>>,
) -> Result<(), ErrBox> {
let config = resolve_config_from_args(args, cache, environment)?;
let plugins = resolve_plugins_and_err_if_empty(args, &config, environment, plugin_resolver)?;
let file_paths = get_and_resolve_file_paths(&config, args, environment)?;
let file_paths_by_plugin = get_file_paths_by_plugin_and_err_if_empty(&plugins, file_paths)?;
plugin_pools.set_plugins(plugins);
let durations: Arc<Mutex<Vec<(PathBuf, u128)>>> = Arc::new(Mutex::new(Vec::new()));
run_parallelized(file_paths_by_plugin, environment, plugin_pools, None, {
let durations = durations.clone();
move |file_path, _, _, _, start_instant, _| {
let duration = start_instant.elapsed().as_millis();
let mut durations = durations.lock();
durations.push((file_path.to_owned(), duration));
Ok(())
}
})?;
let mut durations = durations.lock();
durations.sort_by_key(|k| k.1);
for (file_path, duration) in durations.iter() {
environment.log(&format!("{}ms - {}", duration, file_path.display()));
}
Ok(())
}
pub fn check<TEnvironment: Environment>(
args: &CliArgs,
environment: &TEnvironment,
cache: &Cache<TEnvironment>,
plugin_resolver: &PluginResolver<TEnvironment>,
plugin_pools: Arc<PluginPools<TEnvironment>>,
) -> Result<(), ErrBox> {
let config = resolve_config_from_args(args, cache, environment)?;
let plugins = resolve_plugins_and_err_if_empty(args, &config, environment, plugin_resolver)?;
let file_paths = get_and_resolve_file_paths(&config, args, environment)?;
let file_paths_by_plugin = get_file_paths_by_plugin_and_err_if_empty(&plugins, file_paths)?;
plugin_pools.set_plugins(plugins);
let incremental_file = get_incremental_file(args, &config, &cache, &plugin_pools, &environment);
let not_formatted_files_count = Arc::new(AtomicUsize::new(0));
run_parallelized(file_paths_by_plugin, environment, plugin_pools, incremental_file, {
let not_formatted_files_count = not_formatted_files_count.clone();
move |file_path, file_text, formatted_text, _, _, environment| {
if formatted_text != file_text {
not_formatted_files_count.fetch_add(1, Ordering::SeqCst);
output_difference(&file_path, &file_text, &formatted_text, environment);
}
Ok(())
}
})?;
let not_formatted_files_count = not_formatted_files_count.load(Ordering::SeqCst);
if not_formatted_files_count == 0 {
Ok(())
} else {
let f = if not_formatted_files_count == 1 { "file" } else { "files" };
err!("Found {} not formatted {}.", not_formatted_files_count.to_string().bold().to_string(), f)
}
}
fn output_difference(file_path: &Path, file_text: &str, formatted_text: &str, environment: &impl Environment) {
let difference_text = get_difference(file_text, formatted_text);
environment.log(&format!(
"{} {}:\n{}\n--",
"from".bold().red().to_string(),
file_path.display(),
difference_text,
));
}
pub fn format<TEnvironment: Environment>(
cmd: &FmtSubCommand,
args: &CliArgs,
environment: &TEnvironment,
cache: &Cache<TEnvironment>,
plugin_resolver: &PluginResolver<TEnvironment>,
plugin_pools: Arc<PluginPools<TEnvironment>>,
) -> Result<(), ErrBox> {
let config = resolve_config_from_args(args, cache, environment)?;
let plugins = resolve_plugins_and_err_if_empty(args, &config, environment, plugin_resolver)?;
let file_paths = get_and_resolve_file_paths(&config, args, environment)?;
let file_paths_by_plugin = get_file_paths_by_plugin_and_err_if_empty(&plugins, file_paths)?;
plugin_pools.set_plugins(plugins);
let incremental_file = get_incremental_file(args, &config, &cache, &plugin_pools, &environment);
let formatted_files_count = Arc::new(AtomicUsize::new(0));
let output_diff = cmd.diff;
run_parallelized(file_paths_by_plugin, environment, plugin_pools, incremental_file.clone(), {
let formatted_files_count = formatted_files_count.clone();
move |file_path, file_text, formatted_text, had_bom, _, environment| {
if formatted_text != file_text {
if output_diff {
output_difference(file_path, file_text, &formatted_text, environment);
}
let new_text = if had_bom {
format!("{}{}", BOM_CHAR, formatted_text)
} else {
formatted_text
};
formatted_files_count.fetch_add(1, Ordering::SeqCst);
environment.write_file(&file_path, &new_text)?;
}
Ok(())
}
})?;
let formatted_files_count = formatted_files_count.load(Ordering::SeqCst);
if formatted_files_count > 0 {
let suffix = if formatted_files_count == 1 { "file" } else { "files" };
environment.log(&format!("Formatted {} {}.", formatted_files_count.to_string().bold().to_string(), suffix));
}
if let Some(incremental_file) = &incremental_file {
incremental_file.write();
}
Ok(())
}
#[cfg(test)]
mod test {
use crossterm::style::Stylize;
use pretty_assertions::assert_eq;
use crate::environment::{Environment, TestEnvironment, TestEnvironmentBuilder};
use crate::test_helpers::{
self, get_plural_check_text, get_plural_formatted_text, get_singular_check_text, get_singular_formatted_text, run_test_cli, run_test_cli_with_stdin,
};
use crate::utils::get_difference;
use crate::utils::TestStdInReader;
#[test]
fn it_should_output_format_times() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file("/file.txt", "const t=4;")
.write_file("/file2.txt", "const t=4;")
.write_file("/file3.txt_ps", "const t=4;")
.build();
run_test_cli(vec!["output-format-times", "**/*.*"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages.len(), 3); }
#[test]
fn it_should_format_file() {
let file_path1 = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(file_path1, "text")
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_formatted");
}
#[test]
fn it_should_format_files() {
let file_path1 = "/file.txt";
let file_path2 = "/file.txt_ps";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file(&file_path1, "text")
.write_file(&file_path2, "text2")
.build();
run_test_cli(vec!["fmt", "/file.*"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2_formatted_process");
}
#[test]
fn it_should_format_plugin_explicitly_specified_files() {
let file_path1 = "/test-process-plugin-exact-file";
let environment = TestEnvironmentBuilder::with_initialized_remote_process_plugin()
.write_file(&file_path1, "text")
.build();
run_test_cli(vec!["fmt", "*"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_formatted_process");
}
#[test]
fn it_should_format_files_with_local_plugin() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::new()
.add_local_wasm_plugin()
.with_default_config(|c| {
c.add_local_wasm_plugin();
})
.write_file(&file_path, "text")
.initialize()
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_handle_wasm_plugin_erroring() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file.txt", "should_error") .build();
let error_message = run_test_cli(vec!["fmt", "/file.txt"], &environment).err().unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(
environment.take_stderr_messages(),
vec![String::from("Error formatting /file.txt. Message: Did error.")]
);
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
}
#[test]
fn it_should_handle_process_plugin_erroring() {
let environment = TestEnvironmentBuilder::with_initialized_remote_process_plugin()
.write_file("/file.txt_ps", "should_error") .build();
let error_message = run_test_cli(vec!["fmt", "/file.txt_ps"], &environment).err().unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(
environment.take_stderr_messages(),
vec![String::from("Error formatting /file.txt_ps. Message: Did error.")]
);
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
}
#[test]
fn it_should_handle_wasm_plugin_panicking() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file1.txt", "should_panic") .write_file("/file2.txt", "test")
.build();
let error_message = run_test_cli(vec!["fmt", "**.txt"], &environment).err().unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
let logged_errors = environment.take_stderr_messages();
assert_eq!(logged_errors.len(), 1);
assert_eq!(
logged_errors[0].starts_with("Error formatting /file1.txt. Message: RuntimeError: unreachable"),
true
);
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(environment.read_file("/file2.txt").unwrap(), "test_formatted");
}
#[test]
fn it_should_format_calling_process_plugin_with_wasm_plugin_and_no_plugin_exists() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "format this text");
}
#[test]
fn it_should_format_calling_process_plugin_with_wasm_plugin_and_process_plugin_exists() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file(&file_path, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "format this text_formatted_process");
}
#[test]
fn it_should_format_calling_process_plugin_with_wasm_plugin_using_additional_plugin_specified_config() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file(&file_path1, "plugin-config: format this text")
.write_file(&file_path2, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "/*.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "format this text_custom_config");
assert_eq!(environment.read_file(&file_path2).unwrap(), "format this text_formatted_process");
}
#[test]
fn it_should_error_calling_process_plugin_with_wasm_plugin_and_process_plugin_errors() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file("/file.txt", "plugin: should_error")
.build();
let error_message = run_test_cli(vec!["fmt", "/file.txt"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(
environment.take_stderr_messages(),
vec![String::from("Error formatting /file.txt. Message: Did error.")]
);
}
#[test]
fn it_should_format_calling_other_plugin_with_process_plugin_and_no_plugin_exists() {
let file_path = "/file.txt_ps";
let environment = TestEnvironmentBuilder::with_initialized_remote_process_plugin()
.write_file(&file_path, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "/file.txt_ps"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "format this text");
}
#[test]
fn it_should_format_calling_wasm_plugin_with_process_plugin_and_wasm_plugin_exists() {
let file_path = "/file.txt_ps";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file(&file_path, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "/file.txt_ps"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "format this text_formatted");
}
#[test]
fn it_should_format_calling_wasm_plugin_with_process_plugin_using_additional_plugin_specified_config() {
let file_path1 = "/file1.txt_ps";
let file_path2 = "/file2.txt_ps";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file(&file_path1, "plugin-config: format this text")
.write_file(&file_path2, "plugin: format this text")
.build();
run_test_cli(vec!["fmt", "*.txt_ps"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "format this text_custom_config");
assert_eq!(environment.read_file(&file_path2).unwrap(), "format this text_formatted");
}
#[test]
fn it_should_error_calling_wasm_plugin_with_process_plugin_and_wasm_plugin_errors() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file("/file.txt_ps", "plugin: should_error")
.build();
let error_message = run_test_cli(vec!["fmt", "/file.txt_ps"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(
environment.take_stderr_messages(),
vec![String::from("Error formatting /file.txt_ps. Message: Did error.")]
);
}
#[test]
fn it_should_format_when_specifying_dot_slash_paths() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path, "text")
.build();
run_test_cli(vec!["fmt", "./file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_exclude_a_specified_dot_slash_path() {
let file_path = "/file.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path, "text")
.write_file(&file_path2, "text")
.build();
run_test_cli(vec!["fmt", "./**/*.txt", "--excludes", "./file2.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text");
}
#[test]
fn it_should_ignore_files_in_node_modules_by_default() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/node_modules/file.txt", "")
.write_file("/test/node_modules/file.txt", "")
.write_file("/file.txt", "")
.build();
run_test_cli(vec!["fmt", "**/*.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_not_ignore_files_in_node_modules_when_allowed() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/node_modules/file.txt", "const t=4;")
.write_file("/test/node_modules/file.txt", "const t=4;")
.build();
run_test_cli(vec!["fmt", "--allow-node-modules", "**/*.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_format_files_with_config() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt_ps";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.with_local_config("/config.json", |c| {
c.add_remote_wasm_plugin()
.add_remote_process_plugin()
.add_config_section(
"test-plugin",
r#"{
"ending": "custom-formatted"
}"#,
)
.add_config_section(
"testProcessPlugin",
r#"{
"ending": "custom-formatted2"
}"#,
);
})
.write_file(&file_path1, "text")
.write_file(&file_path2, "text2")
.build();
run_test_cli(vec!["fmt", "--config", "/config.json", "/file1.txt", "/file2.txt_ps"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_custom-formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2_custom-formatted2");
}
#[test]
fn it_should_format_files_with_config_using_c() {
let file_path1 = "/file1.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(file_path1, "text")
.write_file(
"/config.json",
r#"{
"test-plugin": { "ending": "custom-formatted" },
"plugins": ["https://plugins.dprint.dev/test-plugin.wasm"]
}"#,
)
.build();
run_test_cli(vec!["fmt", "-c", "/config.json", "/file1.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_custom-formatted");
}
#[test]
fn it_should_error_when_config_file_does_not_exist() {
let environment = TestEnvironment::new();
environment.write_file("/test.txt", "test").unwrap();
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
concat!(
"No config file found at /dprint.json. Did you mean to create (dprint init) or specify one (--config <path>)?\n",
" Error: Could not find file at path /dprint.json"
)
);
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_support_config_file_urls() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_remote_config("https://dprint.dev/test.json", |c| {
c.add_remote_wasm_plugin()
.add_config_section("test-plugin", r#"{ "ending": "custom-formatted" }"#);
})
.write_file(&file_path1, "text")
.write_file(&file_path2, "text2")
.build();
run_test_cli(
vec!["fmt", "--config", "https://dprint.dev/test.json", "/file1.txt", "/file2.txt"],
&environment,
)
.unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(
environment.take_stderr_messages(),
vec!["Compiling https://plugins.dprint.dev/test-plugin.wasm"]
);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_custom-formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2_custom-formatted");
}
#[test]
fn it_should_error_on_wasm_plugin_config_diagnostic() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.with_default_config(|c| {
c.add_config_section("test-plugin", r#"{ "non-existent": 25 }"#);
})
.write_file("/test.txt", "test")
.build();
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(
environment.take_stderr_messages(),
vec![
"[test-plugin]: Unknown property in configuration: non-existent",
"[test-plugin]: Error initializing from configuration file. Had 1 diagnostic(s)."
]
);
}
#[test]
fn it_should_error_on_process_plugin_config_diagnostic() {
let environment = TestEnvironmentBuilder::with_initialized_remote_process_plugin()
.with_default_config(|c| {
c.add_remote_process_plugin();
c.add_remote_process_plugin();
c.add_config_section(
"testProcessPlugin",
r#"{
"non-existent": 25
}"#,
);
})
.write_file("/test.txt_ps", "test")
.build();
let error_message = run_test_cli(vec!["fmt", "**/*.txt_ps"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(
environment.take_stderr_messages(),
vec![
"[test-process-plugin]: Unknown property in configuration: non-existent",
"[test-process-plugin]: Error initializing from configuration file. Had 1 diagnostic(s)."
]
);
}
#[test]
fn it_should_error_when_no_plugins_specified() {
let environment = TestEnvironmentBuilder::new()
.with_default_config(|c| {
c.ensure_plugins_section();
})
.write_file("/test.txt", "test")
.build();
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
"No formatting plugins found. Ensure at least one is specified in the 'plugins' array of the configuration file."
);
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_use_plugins_specified_in_cli_args() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.with_default_config(|c| {
c.add_plugin("https://plugins.dprint.dev/other.wasm");
})
.write_file("/test.txt", "test")
.build();
run_test_cli(
vec!["fmt", "**/*.txt", "--plugins", "https://plugins.dprint.dev/test-plugin.wasm"],
&environment,
)
.unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_allow_using_no_config_when_plugins_specified() {
let environment = TestEnvironmentBuilder::new().add_remote_wasm_plugin().write_file("/test.txt", "test").build();
run_test_cli(
vec!["fmt", "**/*.txt", "--plugins", "https://plugins.dprint.dev/test-plugin.wasm"],
&environment,
)
.unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(
environment.take_stderr_messages(),
vec!["Compiling https://plugins.dprint.dev/test-plugin.wasm"]
);
}
#[test]
fn it_should_not_do_excess_object_property_diagnostics_when_plugins_cli_specified() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.with_default_config(|c| {
c.add_config_section("excess-object", "{}").add_remote_process_plugin();
})
.write_file("/test.txt", "test")
.build();
run_test_cli(
vec!["fmt", "**/*.txt", "--plugins", "https://plugins.dprint.dev/test-plugin.wasm"],
&environment,
)
.unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
"Error resolving global config from configuration file. Unexpected non-string, boolean, or int property 'excess-object'."
);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.take_stdout_messages().len(), 0);
}
#[test]
fn it_should_not_do_excess_primitive_property_diagnostics_when_plugins_cli_specified() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.with_default_config(|c| {
c.add_config_section("excess-primitive", "true").add_remote_process_plugin();
})
.write_file("/test.txt", "test")
.build();
run_test_cli(
vec!["fmt", "**/*.txt", "--plugins", "https://plugins.dprint.dev/test-plugin.wasm"],
&environment,
)
.unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
"Error resolving global config from configuration file. Had 1 config diagnostic(s)."
);
assert_eq!(environment.take_stderr_messages(), vec!["Unknown property in configuration: excess-primitive"]);
assert_eq!(environment.take_stdout_messages().len(), 0);
}
#[test]
fn it_should_error_when_no_files_match_glob() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin().build();
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
concat!(
"No files found to format with the specified plugins. ",
"You may want to try using `dprint output-file-paths` to see which files it's finding."
)
);
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[cfg(target_os = "windows")]
#[test]
fn it_should_format_absolute_paths_on_windows() {
let file_path = "E:\\file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_local_config("D:\\test\\other\\dprint.json", |c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.write_file(file_path, "text1")
.set_cwd("D:\\test\\other\\")
.initialize()
.build();
run_test_cli(vec!["fmt", "--", "E:\\file1.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text1_formatted");
}
#[cfg(target_os = "linux")]
#[test]
fn it_should_format_absolute_paths_on_linux() {
let file_path = "/asdf/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_local_config("/test/other/dprint.json", |c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.write_file(&file_path, "text1")
.set_cwd("/test/other/")
.initialize()
.build();
run_test_cli(vec!["fmt", "--", "/asdf/file1.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text1_formatted");
}
#[test]
fn it_should_format_files_with_config_includes() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(file_path1, "text1")
.write_file(file_path2, "text2")
.with_default_config(|c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2_formatted");
}
#[cfg(target_os = "windows")]
#[test]
fn it_should_format_files_with_config_includes_when_using_back_slashes() {
let file_path1 = "/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("**\\\\*.txt") .add_remote_wasm_plugin();
})
.write_file(file_path1, "text1")
.initialize()
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
}
#[test]
fn it_should_override_config_includes_with_cli_includes() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path1, "text1")
.write_file(&file_path2, "text2")
.with_default_config(|c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.build();
run_test_cli(vec!["fmt", "/file1.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2");
}
#[test]
fn it_should_override_config_excludes_with_cli_excludes() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(&file_path1, "text1")
.write_file(&file_path2, "text2")
.with_default_config(|c| {
c.add_includes("**/*.txt").add_excludes("/file1.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt", "--excludes", "/file2.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2");
}
#[test]
fn it_should_support_clearing_config_excludes_with_cli_excludes_arg() {
let file_path1 = "/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(&file_path1, "text1")
.with_default_config(|c| {
c.add_includes("**/*.txt").add_excludes("/file1.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt", "--excludes="], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
}
#[test]
fn it_should_format_explicitly_specified_file_even_if_excluded() {
let file_path1 = "/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(&file_path1, "text1")
.with_default_config(|c| {
c.add_includes("**/*.txt").add_excludes("/file1.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt", "file1.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
}
#[test]
fn it_should_override_config_includes_and_excludes_with_cli() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(&file_path1, "text1")
.write_file(&file_path2, "text2")
.with_default_config(|c| {
c.add_includes("/file2.txt").add_excludes("/file1.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt", "/file1.txt", "--excludes", "/file2.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2");
}
#[test]
fn it_should_format_files_with_config_excludes() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let file_path3 = "/file3.txt";
let sub_dir_file_path2 = "/sub-dir/file2.txt";
let sub_dir_file_path3 = "/sub-dir/file3.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(file_path1, "text")
.write_file(file_path2, "text")
.write_file(file_path3, "text")
.write_file(sub_dir_file_path2, "text")
.write_file(sub_dir_file_path3, "text")
.with_default_config(|c| {
c.add_includes("**/*.txt")
.add_excludes("/file2.txt")
.add_excludes("file3.txt")
.add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text");
assert_eq!(environment.read_file(&file_path3).unwrap(), "text");
assert_eq!(environment.read_file(&sub_dir_file_path2).unwrap(), "text_formatted");
assert_eq!(environment.read_file(&sub_dir_file_path3).unwrap(), "text");
}
#[test]
fn should_ignore_path_in_config_includes_if_not_exists() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(file_path1, "text1")
.write_file(file_path2, "text2")
.with_default_config(|c| {
c.add_includes("/file2.txt").add_includes("/file3.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn should_not_ignore_path_in_cli_includes_if_not_exists() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(file_path1, "text1")
.write_file(file_path2, "text2")
.with_default_config(|c| {
c.add_remote_wasm_plugin();
})
.initialize()
.build();
let err = run_test_cli(vec!["fmt", "/file2.txt", "/file3.txt"], &environment).err().unwrap();
assert_eq!(err.to_string(), "Had 1 error(s) formatting.");
assert_eq!(
environment.take_stderr_messages(),
vec!["Error formatting /file3.txt. Message: Could not find file at path /file3.txt"]
);
}
#[test]
fn it_should_format_using_hidden_config_file_name() {
let file_path = "/test/other/file.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.set_cwd("/test/other/")
.write_file(file_path, "text")
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_format_files_with_config_in_config_sub_dir_and_warn() {
let file_path1 = "/file1.txt";
let file_path2 = "/file2.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.write_file(file_path1, "text1")
.write_file(file_path2, "text2")
.with_local_config("./config/.dprintrc.json", |c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.initialize()
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(2)]);
assert_eq!(environment.take_stderr_messages(), vec![
"WARNING: Automatic resolution of the configuration file in the config sub directory will be deprecated soon. Please move the configuration file to the parent directory.",
"WARNING: .dprintrc.json will be deprecated soon. Please rename it to dprint.json"
]);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
assert_eq!(environment.read_file(&file_path2).unwrap(), "text2_formatted");
}
#[test]
fn it_should_format_using_config_in_ancestor_directory() {
let file_path = "/test/other/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("**/*.txt");
})
.write_file(&file_path, "text")
.build();
environment.set_cwd("/test/other/");
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_format_using_old_config_file_name_and_warn() {
let file_path = "/test/other/file.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_local_config("/.dprintrc.json", |c| {
c.add_remote_wasm_plugin().add_includes("**/*.txt");
})
.initialize()
.set_cwd("/test/other/")
.write_file(&file_path, "text")
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(
environment.take_stderr_messages(),
vec!["WARNING: .dprintrc.json will be deprecated soon. Please rename it to dprint.json"]
);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_format_using_config_in_ancestor_directory_config_folder_and_warn() {
let file_path = "/test/other/file.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_local_config("./config/.dprintrc.json", |c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.initialize()
.set_cwd("/test/other/")
.write_file(&file_path, "text")
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages(), vec![
"WARNING: Automatic resolution of the configuration file in the config sub directory will be deprecated soon. Please move the configuration file to the parent directory.",
"WARNING: .dprintrc.json will be deprecated soon. Please rename it to dprint.json"
]);
assert_eq!(environment.read_file(&file_path).unwrap(), "text_formatted");
}
#[test]
fn it_should_format_incrementally_when_specified_on_cli() {
let file_path1 = "/subdir/file1.txt";
let no_change_msg = "No change: /subdir/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("**/*.txt").add_remote_wasm_plugin();
})
.write_file(&file_path1, "text1")
.initialize()
.build();
run_test_cli(vec!["fmt", "--incremental"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
environment.clear_logs();
run_test_cli(vec!["fmt", "--incremental", "--verbose"], &environment).unwrap();
assert_eq!(environment.take_stderr_messages().iter().any(|msg| msg.contains(no_change_msg)), true);
environment.write_file(&file_path1, "asdf").unwrap();
environment.clear_logs();
run_test_cli(vec!["fmt", "--incremental"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "asdf_formatted");
environment
.write_file(
"./dprint.json",
r#"{
"indentWidth": 2,
"includes": ["**/*.txt"],
"plugins": ["https://plugins.dprint.dev/test-plugin.wasm"]
}"#,
)
.unwrap();
environment.clear_logs();
run_test_cli(vec!["fmt", "--incremental", "--verbose"], &environment).unwrap();
assert_eq!(environment.take_stderr_messages().iter().any(|msg| msg.contains(no_change_msg)), false);
environment
.write_file(
"./dprint.json",
r#"{
"indentWidth": 2,
"test-plugin": {
"ending": "custom-formatted",
"line_width": 80
},
"includes": ["**/*.txt"],
"plugins": ["https://plugins.dprint.dev/test-plugin.wasm"]
}"#,
)
.unwrap();
environment.clear_logs();
run_test_cli(vec!["fmt", "--incremental"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "asdf_formatted_custom-formatted");
for _ in 1..4 {
environment.clear_logs();
run_test_cli(vec!["fmt", "--incremental", "--verbose"], &environment).unwrap();
assert_eq!(environment.take_stderr_messages().iter().any(|msg| msg.contains(no_change_msg)), true);
}
environment.clear_logs();
environment.set_cwd("/subdir");
run_test_cli(vec!["fmt", "--incremental", "--verbose"], &environment).unwrap();
assert_eq!(
environment
.take_stderr_messages()
.iter()
.any(|msg| msg.contains("No change: /subdir/file1.txt")),
true
);
}
#[test]
fn it_should_format_incrementally_when_specified_via_config() {
let file_path1 = "/file1.txt";
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_remote_wasm_plugin().add_includes("**/*.txt").set_incremental(true);
})
.initialize()
.write_file(&file_path1, "text1")
.build();
run_test_cli(vec!["fmt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path1).unwrap(), "text1_formatted");
environment.clear_logs();
run_test_cli(vec!["fmt", "--verbose"], &environment).unwrap();
assert_eq!(environment.take_stderr_messages().iter().any(|msg| msg.contains("No change: /file1.txt")), true);
}
#[test]
fn it_should_not_output_when_no_files_need_formatting() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file.txt", "text_formatted")
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn should_format_with_diff() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file.txt", "const t=4;")
.build();
run_test_cli(vec!["fmt", "--diff", "/file.txt"], &environment).unwrap();
assert_eq!(
environment.take_stdout_messages(),
vec![
format!(
"{}\n{}\n--",
format!("{} /file.txt:", "from".bold().red().to_string()),
get_difference("const t=4;", "const t=4;_formatted"),
),
get_singular_formatted_text()
]
);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_not_output_when_no_files_need_formatting_for_check() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path, "text_formatted")
.build();
run_test_cli(vec!["check", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_output_when_a_file_need_formatting_for_check() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file.txt", "const t=4;")
.build();
let error_message = run_test_cli(vec!["check", "/file.txt"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), get_singular_check_text());
assert_eq!(
environment.take_stdout_messages(),
vec![format!(
"{}\n{}\n--",
format!("{} /file.txt:", "from".bold().red().to_string()),
get_difference("const t=4;", "const t=4;_formatted"),
),]
);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_output_when_files_need_formatting_for_check() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file("/file1.txt", "const t=4;")
.write_file("/file2.txt", "const t=5;")
.build();
let error_message = run_test_cli(vec!["check", "/file1.txt", "/file2.txt"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), get_plural_check_text(2));
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort(); assert_eq!(
logged_messages,
vec![
format!(
"{}\n{}\n--",
format!("{} /file1.txt:", "from".bold().red().to_string()),
get_difference("const t=4;", "const t=4;_formatted"),
),
format!(
"{}\n{}\n--",
format!("{} /file2.txt:", "from".bold().red().to_string()),
get_difference("const t=5;", "const t=5;_formatted"),
),
]
);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_handle_bom() {
let file_path = "/file.txt";
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.write_file(&file_path, "\u{FEFF}text")
.build();
run_test_cli(vec!["fmt", "/file.txt"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(environment.take_stderr_messages().len(), 0);
assert_eq!(environment.read_file(&file_path).unwrap(), "\u{FEFF}text_formatted");
}
#[test]
fn it_should_format_for_stdin_fmt_with_file_name() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("/test/**.txt").add_remote_wasm_plugin();
})
.build();
let test_std_in = TestStdInReader::from("text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "file.txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_formatted"]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_format_for_stdin_fmt_with_extension() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("/test/**.txt").add_remote_wasm_plugin();
})
.build();
let test_std_in = TestStdInReader::from("text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_formatted"]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_stdin_fmt_calling_other_plugin() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin().build();
let test_std_in = TestStdInReader::from("plugin: format this text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "file.txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["format this text_formatted_process"]);
}
#[test]
fn it_should_handle_error_for_stdin_fmt() {
let environment = TestEnvironmentBuilder::new()
.add_remote_wasm_plugin()
.with_default_config(|c| {
c.add_remote_wasm_plugin();
})
.build(); let test_std_in = TestStdInReader::from("should_error");
let error_message = run_test_cli_with_stdin(vec!["fmt", "--stdin", "file.txt"], &environment, test_std_in)
.err()
.unwrap();
assert_eq!(error_message.to_string(), "Did error.");
}
#[test]
fn it_should_format_for_stdin_with_absolute_paths() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("/src/**.*").add_remote_wasm_plugin();
})
.write_file("/file.txt", "")
.write_file("/src/file.txt", "")
.build();
let test_std_in = TestStdInReader::from("text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "/file.txt"], &environment, test_std_in.clone()).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text"]);
run_test_cli_with_stdin(vec!["fmt", "--stdin", "/file.txt", "--", "**/*.txt"], &environment, test_std_in.clone()).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_formatted"]);
run_test_cli_with_stdin(vec!["fmt", "--stdin", "/src/file.txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_formatted"]);
}
#[test]
fn it_should_not_format_stdin_resolving_config_file_from_provided_path_when_relative() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("./**/*.txt").add_remote_wasm_plugin();
})
.with_local_config("./sub-dir/dprint.json", |c| {
c.add_includes("./**/*.txt")
.add_remote_wasm_plugin()
.add_config_section("test-plugin", r#"{ "ending": "new_ending" }"#);
})
.build();
let test_std_in = TestStdInReader::from("text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "sub-dir/file.txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_formatted"]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_format_stdin_resolving_config_file_from_provided_path_when_absolute() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("./**/*.txt").add_remote_wasm_plugin();
})
.with_local_config("/sub-dir/dprint.json", |c| {
c.add_includes("./**/*.txt")
.add_remote_wasm_plugin()
.add_config_section("test-plugin", r#"{ "ending": "new_ending" }"#);
})
.write_file("/sub-dir/file.txt", "test")
.initialize()
.build();
let test_std_in = TestStdInReader::from("text");
run_test_cli_with_stdin(vec!["fmt", "--stdin", "/sub-dir/file.txt"], &environment, test_std_in).unwrap();
assert_eq!(environment.take_stdout_messages(), vec!["text_new_ending"]);
assert_eq!(environment.take_stderr_messages().len(), 0);
}
#[test]
fn it_should_error_if_process_plugin_has_no_checksum_in_config() {
let environment = TestEnvironmentBuilder::with_initialized_remote_process_plugin()
.with_default_config(|c| {
c.add_plugin("https://plugins.dprint.dev/test-process.exe-plugin");
})
.write_file("/test.txt_ps", "")
.build();
let error_message = run_test_cli(vec!["fmt", "*.*"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
concat!(
"The plugin 'https://plugins.dprint.dev/test-process.exe-plugin' must have a checksum specified for security reasons ",
"since it is not a Wasm plugin. You may specify one by writing \"https://plugins.dprint.dev/test-process.exe-plugin@checksum-goes-here\" ",
"when providing the url in the configuration file. Check the plugin's release notes for what ",
"the checksum is or calculate it yourself if you trust the source (it's SHA-256)."
)
);
}
#[test]
fn it_should_error_if_process_plugin_has_wrong_checksum_in_config() {
let environment = TestEnvironmentBuilder::with_remote_process_plugin()
.with_default_config(|c| {
c.add_remote_process_plugin_with_checksum("asdf");
})
.write_file("/test.txt_ps", "")
.build();
let actual_plugin_file_checksum = test_helpers::get_test_process_plugin_checksum();
let error_message = run_test_cli(vec!["fmt", "*.*"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
format!(
"Error resolving plugin https://plugins.dprint.dev/test-process.exe-plugin: The checksum {} did not match the expected checksum of asdf.",
actual_plugin_file_checksum,
)
);
}
#[test]
fn it_should_error_if_wasm_plugin_has_wrong_checksum_in_config() {
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_remote_wasm_plugin_with_checksum("asdf");
})
.write_file("/test.txt", "")
.build();
let actual_plugin_file_checksum = test_helpers::get_test_wasm_plugin_checksum();
let error_message = run_test_cli(vec!["fmt", "*.*"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
format!(
"Error resolving plugin https://plugins.dprint.dev/test-plugin.wasm: The checksum {} did not match the expected checksum of asdf.",
actual_plugin_file_checksum,
)
);
}
#[test]
fn it_should_not_error_if_wasm_plugin_has_correct_checksum_in_config() {
let actual_plugin_file_checksum = test_helpers::get_test_wasm_plugin_checksum();
let environment = TestEnvironmentBuilder::with_remote_wasm_plugin()
.with_default_config(|c| {
c.add_remote_wasm_plugin_with_checksum(&actual_plugin_file_checksum);
})
.write_file("/test.txt", "text")
.build();
run_test_cli(vec!["fmt", "*.*"], &environment).unwrap();
assert_eq!(environment.read_file("/test.txt").unwrap(), "text_formatted");
assert_eq!(environment.take_stdout_messages(), vec![get_singular_formatted_text()]);
assert_eq!(
environment.take_stderr_messages(),
vec!["Compiling https://plugins.dprint.dev/test-plugin.wasm"]
);
}
#[test]
fn it_should_error_if_process_plugin_has_wrong_checksum_in_file_for_zip() {
let environment = TestEnvironmentBuilder::with_remote_process_plugin()
.write_process_plugin_file("asdf")
.with_default_config(|c| {
c.add_remote_process_plugin();
})
.write_file("/test.txt_ps", "")
.build();
let actual_plugin_zip_file_checksum = test_helpers::get_test_process_plugin_zip_checksum();
let error_message = run_test_cli(vec!["fmt", "*.*"], &environment).err().unwrap();
assert_eq!(
error_message.to_string(),
format!(
"Error resolving plugin https://plugins.dprint.dev/test-process.exe-plugin: The checksum {} did not match the expected checksum of asdf.",
actual_plugin_zip_file_checksum,
)
);
}
#[test]
fn it_should_format_many_files() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin().build();
for i in 0..100 {
let file_path = format!("/file{}.txt", i);
environment.write_file(&file_path, &format!("text{}", i)).unwrap();
}
for i in 0..100 {
let file_path = format!("/file{}.txt_ps", i);
environment.write_file(&file_path, &format!("text{}", i)).unwrap();
}
run_test_cli(vec!["fmt", "/*.*"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages(), vec![get_plural_formatted_text(200)]);
assert_eq!(environment.take_stderr_messages().len(), 0);
for i in 0..100 {
let file_path = format!("/file{}.txt", i);
assert_eq!(environment.read_file(&file_path).unwrap(), format!("text{}_formatted", i));
}
for i in 0..100 {
let file_path = format!("/file{}.txt_ps", i);
assert_eq!(environment.read_file(&file_path).unwrap(), format!("text{}_formatted_process", i));
}
}
#[test]
fn it_should_error_once_on_config_diagnostic_many_files() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin().build();
environment
.write_file(
"./dprint.json",
r#"{
"test-plugin": { "non-existent": 25 },
"plugins": ["https://plugins.dprint.dev/test-plugin.wasm"]
}"#,
)
.unwrap();
for i in 0..100 {
let file_path = format!("/file{}.txt", i);
environment.write_file(&file_path, &format!("text{}", i)).unwrap();
}
let error_message = run_test_cli(vec!["fmt", "**/*.txt"], &environment).err().unwrap();
assert_eq!(error_message.to_string(), "Had 1 error(s) formatting.");
assert_eq!(environment.take_stdout_messages().len(), 0);
assert_eq!(
environment.take_stderr_messages(),
vec![
"[test-plugin]: Unknown property in configuration: non-existent",
"[test-plugin]: Error initializing from configuration file. Had 1 diagnostic(s)."
]
);
}
}