use anyhow::Result;
use crate::arg_parser::CliArgs;
use crate::arg_parser::OutputFilePathsSubCommand;
use crate::cache::Cache;
use crate::configuration::resolve_config_from_args;
use crate::environment::Environment;
use crate::paths::get_and_resolve_file_paths;
use crate::paths::get_file_paths_by_plugins;
use crate::plugins::get_plugins_from_args;
use crate::plugins::resolve_plugins_and_err_if_empty;
use crate::plugins::PluginResolver;
use crate::utils::get_table_text;
use crate::utils::is_out_of_date;
pub fn output_version<TEnvironment: Environment>(environment: &TEnvironment) -> Result<()> {
environment.log(&format!("{} {}", env!("CARGO_PKG_NAME"), environment.cli_version()));
Ok(())
}
pub async fn output_help<TEnvironment: Environment>(
args: &CliArgs,
cache: &Cache<TEnvironment>,
environment: &TEnvironment,
plugin_resolver: &PluginResolver<TEnvironment>,
help_text: &str,
) -> Result<()> {
environment.log(help_text);
let plugins_result = get_plugins_from_args(args, cache, environment, plugin_resolver).await;
match plugins_result {
Ok(plugins) => {
if !plugins.is_empty() {
let table_text = get_table_text(plugins.iter().map(|plugin| (plugin.name(), plugin.help_url())).collect());
environment.log("\nPLUGINS HELP:");
environment.log(&console_static_text::strip_ansi_codes(&table_text.render(
4, None,
)));
}
}
Err(err) => {
log_verbose!(environment, "Error getting plugins for help. {:#}", err.to_string());
}
}
if let Some(latest_version) = is_out_of_date(environment) {
environment.log(&format!(
"\nLatest version: {} (Current is {})\nDownload the latest version by running: dprint upgrade",
latest_version,
environment.cli_version(),
));
}
Ok(())
}
pub async fn output_license<TEnvironment: Environment>(
args: &CliArgs,
cache: &Cache<TEnvironment>,
environment: &TEnvironment,
plugin_resolver: &PluginResolver<TEnvironment>,
) -> Result<()> {
environment.log("==== DPRINT CLI LICENSE ====");
environment.log(std::str::from_utf8(include_bytes!("../../LICENSE"))?);
for plugin in get_plugins_from_args(args, cache, environment, plugin_resolver).await? {
environment.log(&format!("\n==== {} LICENSE ====", plugin.name().to_uppercase()));
let initialized_plugin = plugin.initialize().await?;
environment.log(&initialized_plugin.license_text().await?);
}
Ok(())
}
pub fn clear_cache(environment: &impl Environment) -> Result<()> {
let cache_dir = environment.get_cache_dir();
environment.remove_dir_all(&cache_dir)?;
environment.log_stderr(&format!("Deleted {}", cache_dir.display()));
Ok(())
}
pub async fn output_file_paths<TEnvironment: Environment>(
cmd: &OutputFilePathsSubCommand,
args: &CliArgs,
environment: &TEnvironment,
cache: &Cache<TEnvironment>,
plugin_resolver: &PluginResolver<TEnvironment>,
) -> Result<()> {
let config = resolve_config_from_args(args, cache, environment)?;
let plugins = resolve_plugins_and_err_if_empty(args, &config, environment, plugin_resolver).await?;
let resolved_file_paths = get_and_resolve_file_paths(&config, &cmd.patterns, environment).await?;
let file_paths_by_plugin = get_file_paths_by_plugins(&plugins, resolved_file_paths, &config.base_path)?;
let file_paths = file_paths_by_plugin.values().flat_map(|x| x.iter());
for file_path in file_paths {
environment.log(&file_path.display().to_string())
}
Ok(())
}
#[cfg(test)]
mod test {
use pretty_assertions::assert_eq;
use crate::environment::Environment;
use crate::environment::TestEnvironment;
use crate::environment::TestEnvironmentBuilder;
use crate::test_helpers::get_expected_help_text;
use crate::test_helpers::run_test_cli;
#[test]
fn should_output_version_with_v() {
let environment = TestEnvironment::new();
run_test_cli(vec!["-v"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![format!("dprint {}", environment.cli_version())]);
}
#[test]
fn should_output_version_with_no_plugins() {
let environment = TestEnvironment::new();
run_test_cli(vec!["--version"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![format!("dprint {}", environment.cli_version())]);
}
#[test]
fn should_output_version_and_ignore_plugins() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin().build();
run_test_cli(vec!["--version"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![format!("dprint {}", environment.cli_version())]);
}
#[test]
fn should_output_help_with_no_plugins() {
let environment = TestEnvironment::new();
run_test_cli(vec!["--help"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![get_expected_help_text()]);
}
#[test]
fn should_output_help_no_sub_commands() {
let environment = TestEnvironment::new();
run_test_cli(vec![], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![get_expected_help_text()]);
}
#[test]
fn should_output_help_with_plugins() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin().build();
run_test_cli(vec!["--help"], &environment).unwrap();
assert_eq!(
environment.take_stdout_messages(),
vec![
get_expected_help_text(),
"\nPLUGINS HELP:",
" test-plugin https://dprint.dev/plugins/test\n test-process-plugin https://dprint.dev/plugins/test-process"
]
);
}
#[test]
fn should_output_help_when_cli_not_out_of_date() {
let environment = TestEnvironment::new();
environment.add_remote_file_bytes("https://plugins.dprint.dev/cli.json", r#"{ "version": "0.0.0" }"#.as_bytes().to_vec());
run_test_cli(vec!["--help"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(logged_messages, vec![get_expected_help_text()]);
}
#[test]
fn should_output_help_when_cli_out_of_date() {
let environment = TestEnvironment::new();
environment.add_remote_file_bytes("https://plugins.dprint.dev/cli.json", r#"{ "version": "0.1.0" }"#.as_bytes().to_vec());
run_test_cli(vec!["--help"], &environment).unwrap();
let logged_messages = environment.take_stdout_messages();
assert_eq!(
logged_messages,
vec![
get_expected_help_text(),
concat!(
"\nLatest version: 0.1.0 (Current is 0.0.0)",
"\nDownload the latest version by running: dprint upgrade",
)
]
);
}
#[test]
fn should_output_resolved_file_paths() {
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-file-paths", "**/*.*"], &environment).unwrap();
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort();
assert_eq!(logged_messages, vec!["/file.txt", "/file2.txt", "/file3.txt_ps"]);
}
#[test]
fn should_not_output_file_paths_not_supported_by_plugins() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin()
.write_file("/file.ts", "const t=4;")
.write_file("/file2.ts", "const t=4;")
.build();
run_test_cli(vec!["output-file-paths", "**/*.*"], &environment).unwrap();
assert_eq!(environment.take_stdout_messages().len(), 0);
}
#[test]
fn should_output_resolved_file_paths_when_using_backslashes() {
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-file-paths", "**\\*.*"], &environment).unwrap();
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort();
assert_eq!(logged_messages, vec!["/file.txt", "/file2.txt", "/file3.txt_ps"]);
}
#[test]
fn should_output_associations_in_resolved_paths() {
let environment = TestEnvironmentBuilder::new()
.add_remote_wasm_plugin()
.with_default_config(|config_file| {
config_file
.add_includes("**/*.other")
.add_config_section(
"test-plugin",
r#"{
"associations": [
"**/*.other"
],
"ending": "wasm"
}"#,
)
.add_remote_wasm_plugin();
})
.write_file("/file.txt", "") .write_file("/file.other", "")
.initialize()
.build();
run_test_cli(vec!["output-file-paths", "**/*.*"], &environment).unwrap();
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort();
assert_eq!(logged_messages, vec!["/file.other"]);
}
#[test]
fn should_handle_associations_with_only_exclude() {
let environment = TestEnvironmentBuilder::new()
.add_remote_process_plugin()
.add_remote_wasm_plugin()
.with_default_config(|config_file| {
config_file
.add_includes("**/*.txt")
.add_config_section(
"test-plugin",
r#"{
"associations": [
"!**/exclude/**/*.txt"
],
"ending": "wasm"
}"#,
)
.add_config_section(
"testProcessPlugin",
r#"{
"associations": [
"!**/exclude/test-process-plugin-exact-file"
],
}"#,
)
.add_remote_process_plugin()
.add_remote_wasm_plugin();
})
.write_file("/file.txt", "")
.write_file("/test/exclude/other.txt", "")
.write_file("/test/exclude/test-process-plugin-exact-file", "")
.write_file("/test/exclude/test.txt_ps", "")
.write_file("/test/test-process-plugin-exact-file", "")
.initialize()
.build();
run_test_cli(vec!["output-file-paths", "**/*"], &environment).unwrap();
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort();
assert_eq!(
logged_messages,
vec!["/file.txt", "/test/exclude/test.txt_ps", "/test/test-process-plugin-exact-file"]
);
}
#[test]
fn should_filter_by_cwd_in_sub_dir() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_plugin()
.with_default_config(|c| {
c.add_includes("**/*.txt");
})
.write_file("/file.txt", "const t=4;")
.write_file("/file2.txt", "const t=4;")
.write_file("/sub/file3.txt", "const t=4;")
.write_file("/sub2/file4.txt", "const t=4;")
.set_cwd("/sub")
.build();
run_test_cli(vec!["output-file-paths"], &environment).unwrap();
let mut logged_messages = environment.take_stdout_messages();
logged_messages.sort();
assert_eq!(logged_messages, vec!["/sub/file3.txt"]);
}
#[test]
fn should_clear_cache_directory() {
let environment = TestEnvironment::new();
run_test_cli(vec!["clear-cache"], &environment).unwrap();
assert_eq!(environment.take_stderr_messages(), vec!["Deleted /cache"]);
assert_eq!(environment.is_dir_deleted("/cache"), true);
}
#[test]
fn should_output_license_for_sub_command_with_no_plugins() {
let environment = TestEnvironment::new();
run_test_cli(vec!["license"], &environment).unwrap();
assert_eq!(
environment.take_stdout_messages(),
vec!["==== DPRINT CLI LICENSE ====", std::str::from_utf8(include_bytes!("../../LICENSE")).unwrap()]
);
}
#[test]
fn should_output_license_for_sub_command_with_plugins() {
let environment = TestEnvironmentBuilder::with_initialized_remote_wasm_and_process_plugin().build();
run_test_cli(vec!["license"], &environment).unwrap();
assert_eq!(
environment.take_stdout_messages(),
vec![
"==== DPRINT CLI LICENSE ====",
std::str::from_utf8(include_bytes!("../../LICENSE")).unwrap(),
"\n==== TEST-PLUGIN LICENSE ====",
r#"The MIT License (MIT)
Copyright (c) 2020-2022 David Sherret
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"#,
"\n==== TEST-PROCESS-PLUGIN LICENSE ====",
"License text."
]
);
}
}