// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license. mod args; mod auth_tokens; mod cache; mod cdp; mod emit; mod errors; mod factory; mod file_fetcher; mod graph_container; mod graph_util; mod http_util; mod js; mod jsr; mod lsp; mod module_loader; mod napi; mod node; mod npm; mod ops; mod resolver; mod shared; mod standalone; mod task_runner; mod tools; mod tsc; mod util; mod version; mod worker; use crate::args::flags_from_vec; use crate::args::DenoSubcommand; use crate::args::Flags; use crate::util::display; use crate::util::v8::get_v8_flags_from_env; use crate::util::v8::init_v8_flags; use args::TaskFlags; use deno_resolver::npm::ByonmResolvePkgFolderFromDenoReqError; use deno_runtime::WorkerExecutionMode; pub use deno_runtime::UNSTABLE_GRANULAR_FLAGS; use deno_core::anyhow::Context; use deno_core::error::AnyError; use deno_core::error::JsError; use deno_core::futures::FutureExt; use deno_core::unsync::JoinHandle; use deno_npm::resolution::SnapshotFromLockfileError; use deno_runtime::fmt_errors::format_js_error_with_suggestions; use deno_runtime::fmt_errors::FixSuggestion; use deno_runtime::tokio_util::create_and_run_current_thread_with_maybe_metrics; use deno_terminal::colors; use factory::CliFactory; use npm::ResolvePkgFolderFromDenoReqError; use standalone::MODULE_NOT_FOUND; use standalone::UNSUPPORTED_SCHEME; use std::env; use std::future::Future; use std::ops::Deref; use std::path::PathBuf; use std::sync::Arc; /// Ensures that all subcommands return an i32 exit code and an [`AnyError`] error type. trait SubcommandOutput { fn output(self) -> Result; } impl SubcommandOutput for Result { fn output(self) -> Result { self } } impl SubcommandOutput for Result<(), AnyError> { fn output(self) -> Result { self.map(|_| 0) } } impl SubcommandOutput for Result<(), std::io::Error> { fn output(self) -> Result { self.map(|_| 0).map_err(|e| e.into()) } } /// Ensure that the subcommand runs in a task, rather than being directly executed. Since some of these /// futures are very large, this prevents the stack from getting blown out from passing them by value up /// the callchain (especially in debug mode when Rust doesn't have a chance to elide copies!). #[inline(always)] fn spawn_subcommand + 'static, T: SubcommandOutput>( f: F, ) -> JoinHandle> { // the boxed_local() is important in order to get windows to not blow the stack in debug deno_core::unsync::spawn( async move { f.map(|r| r.output()).await }.boxed_local(), ) } async fn run_subcommand(flags: Arc) -> Result { let handle = match flags.subcommand.clone() { DenoSubcommand::Add(add_flags) => spawn_subcommand(async { tools::registry::add(flags, add_flags, tools::registry::AddCommandName::Add).await }), DenoSubcommand::Remove(remove_flags) => spawn_subcommand(async { tools::registry::remove(flags, remove_flags).await }), DenoSubcommand::Bench(bench_flags) => spawn_subcommand(async { if bench_flags.watch.is_some() { tools::bench::run_benchmarks_with_watch(flags, bench_flags).await } else { tools::bench::run_benchmarks(flags, bench_flags).await } }), DenoSubcommand::Bundle => exit_with_message("⚠️ `deno bundle` was removed in Deno 2.\n\nSee the Deno 1.x to 2.x Migration Guide for migration instructions: https://docs.deno.com/runtime/manual/advanced/migrate_deprecations", 1), DenoSubcommand::Doc(doc_flags) => { spawn_subcommand(async { tools::doc::doc(flags, doc_flags).await }) } DenoSubcommand::Eval(eval_flags) => spawn_subcommand(async { tools::run::eval_command(flags, eval_flags).await }), DenoSubcommand::Cache(cache_flags) => spawn_subcommand(async move { tools::installer::install_from_entrypoints(flags, &cache_flags.files).await }), DenoSubcommand::Check(check_flags) => spawn_subcommand(async move { tools::check::check(flags, check_flags).await }), DenoSubcommand::Clean => spawn_subcommand(async move { tools::clean::clean() }), DenoSubcommand::Compile(compile_flags) => spawn_subcommand(async { tools::compile::compile(flags, compile_flags).await }), DenoSubcommand::Coverage(coverage_flags) => spawn_subcommand(async { tools::coverage::cover_files(flags, coverage_flags).await }), DenoSubcommand::Fmt(fmt_flags) => { spawn_subcommand( async move { tools::fmt::format(flags, fmt_flags).await }, ) } DenoSubcommand::Init(init_flags) => { spawn_subcommand(async { // make compiler happy since init_project is sync tokio::task::yield_now().await; tools::init::init_project(init_flags) }) } DenoSubcommand::Info(info_flags) => { spawn_subcommand(async { tools::info::info(flags, info_flags).await }) } DenoSubcommand::Install(install_flags) => spawn_subcommand(async { tools::installer::install_command(flags, install_flags).await }), DenoSubcommand::JSONReference(json_reference) => spawn_subcommand(async move { display::write_to_stdout_ignore_sigpipe(&deno_core::serde_json::to_vec_pretty(&json_reference.json).unwrap()) }), DenoSubcommand::Jupyter(jupyter_flags) => spawn_subcommand(async { tools::jupyter::kernel(flags, jupyter_flags).await }), DenoSubcommand::Uninstall(uninstall_flags) => spawn_subcommand(async { tools::installer::uninstall(flags, uninstall_flags).await }), DenoSubcommand::Lsp => spawn_subcommand(async { lsp::start().await }), DenoSubcommand::Lint(lint_flags) => spawn_subcommand(async { if lint_flags.rules { tools::lint::print_rules_list( lint_flags.json, lint_flags.maybe_rules_tags, ); Ok(()) } else { tools::lint::lint(flags, lint_flags).await } }), DenoSubcommand::Repl(repl_flags) => { spawn_subcommand(async move { tools::repl::run(flags, repl_flags).await }) } DenoSubcommand::Run(run_flags) => spawn_subcommand(async move { if run_flags.is_stdin() { tools::run::run_from_stdin(flags.clone()).await } else { let result = tools::run::run_script(WorkerExecutionMode::Run, flags.clone(), run_flags.watch).await; match result { Ok(v) => Ok(v), Err(script_err) => { if let Some(ResolvePkgFolderFromDenoReqError::Byonm(ByonmResolvePkgFolderFromDenoReqError::UnmatchedReq(_))) = script_err.downcast_ref::() { if flags.node_modules_dir.is_none() { let mut flags = flags.deref().clone(); let watch = match &flags.subcommand { DenoSubcommand::Run(run_flags) => run_flags.watch.clone(), _ => unreachable!(), }; flags.node_modules_dir = Some(deno_config::deno_json::NodeModulesDirMode::None); // use the current lockfile, but don't write it out if flags.frozen_lockfile.is_none() { flags.internal.lockfile_skip_write = true; } return tools::run::run_script(WorkerExecutionMode::Run, Arc::new(flags), watch).await; } } let script_err_msg = script_err.to_string(); if script_err_msg.starts_with(MODULE_NOT_FOUND) || script_err_msg.starts_with(UNSUPPORTED_SCHEME) { if run_flags.bare { let mut cmd = args::clap_root(); cmd.build(); let command_names = cmd.get_subcommands().map(|command| command.get_name()).collect::>(); let suggestions = args::did_you_mean(&run_flags.script, command_names); if !suggestions.is_empty() { let mut error = clap::error::Error::::new(clap::error::ErrorKind::InvalidSubcommand).with_cmd(&cmd); error.insert( clap::error::ContextKind::SuggestedSubcommand, clap::error::ContextValue::Strings(suggestions), ); Err(error.into()) } else { Err(script_err) } } else { let mut new_flags = flags.deref().clone(); let task_flags = TaskFlags { cwd: None, task: Some(run_flags.script.clone()), is_run: true, }; new_flags.subcommand = DenoSubcommand::Task(task_flags.clone()); let result = tools::task::execute_script(Arc::new(new_flags), task_flags.clone()).await; match result { Ok(v) => Ok(v), Err(_) => { // Return script error for backwards compatibility. Err(script_err) } } } } else { Err(script_err) } } } } }), DenoSubcommand::Serve(serve_flags) => spawn_subcommand(async move { tools::serve::serve(flags, serve_flags).await }), DenoSubcommand::Task(task_flags) => spawn_subcommand(async { tools::task::execute_script(flags, task_flags).await }), DenoSubcommand::Test(test_flags) => { spawn_subcommand(async { if let Some(ref coverage_dir) = test_flags.coverage_dir { if test_flags.clean { let _ = std::fs::remove_dir_all(coverage_dir); } std::fs::create_dir_all(coverage_dir) .with_context(|| format!("Failed creating: {coverage_dir}"))?; // this is set in order to ensure spawned processes use the same // coverage directory env::set_var( "DENO_UNSTABLE_COVERAGE_DIR", PathBuf::from(coverage_dir).canonicalize()?, ); } if test_flags.watch.is_some() { tools::test::run_tests_with_watch(flags, test_flags).await } else { tools::test::run_tests(flags, test_flags).await } }) } DenoSubcommand::Completions(completions_flags) => { spawn_subcommand(async move { display::write_to_stdout_ignore_sigpipe(&completions_flags.buf) }) } DenoSubcommand::Types => spawn_subcommand(async move { let types = tsc::get_types_declaration_file_text(); display::write_to_stdout_ignore_sigpipe(types.as_bytes()) }), #[cfg(feature = "upgrade")] DenoSubcommand::Upgrade(upgrade_flags) => spawn_subcommand(async { tools::upgrade::upgrade(flags, upgrade_flags).await }), #[cfg(not(feature = "upgrade"))] DenoSubcommand::Upgrade(_) => exit_with_message( "This deno was built without the \"upgrade\" feature. Please upgrade using the installation method originally used to install Deno.", 1, ), DenoSubcommand::Vendor => exit_with_message("⚠️ `deno vendor` was removed in Deno 2.\n\nSee the Deno 1.x to 2.x Migration Guide for migration instructions: https://docs.deno.com/runtime/manual/advanced/migrate_deprecations", 1), DenoSubcommand::Publish(publish_flags) => spawn_subcommand(async { tools::registry::publish(flags, publish_flags).await }), DenoSubcommand::Help(help_flags) => spawn_subcommand(async move { use std::io::Write; let mut stream = anstream::AutoStream::new(std::io::stdout(), if colors::use_color() { anstream::ColorChoice::Auto } else { anstream::ColorChoice::Never }); match stream.write_all(help_flags.help.ansi().to_string().as_bytes()) { Ok(()) => Ok(()), Err(e) => match e.kind() { std::io::ErrorKind::BrokenPipe => Ok(()), _ => Err(e), }, } }), }; handle.await? } #[allow(clippy::print_stderr)] fn setup_panic_hook() { // This function does two things inside of the panic hook: // - Tokio does not exit the process when a task panics, so we define a custom // panic hook to implement this behaviour. // - We print a message to stderr to indicate that this is a bug in Deno, and // should be reported to us. let orig_hook = std::panic::take_hook(); std::panic::set_hook(Box::new(move |panic_info| { eprintln!("\n============================================================"); eprintln!("Deno has panicked. This is a bug in Deno. Please report this"); eprintln!("at https://github.com/denoland/deno/issues/new."); eprintln!("If you can reliably reproduce this panic, include the"); eprintln!("reproduction steps and re-run with the RUST_BACKTRACE=1 env"); eprintln!("var set and include the backtrace in your report."); eprintln!(); eprintln!("Platform: {} {}", env::consts::OS, env::consts::ARCH); eprintln!("Version: {}", version::DENO_VERSION_INFO.deno); eprintln!("Args: {:?}", env::args().collect::>()); eprintln!(); orig_hook(panic_info); std::process::exit(1); })); } #[allow(clippy::print_stderr)] fn exit_with_message(message: &str, code: i32) -> ! { eprintln!( "{}: {}", colors::red_bold("error"), message.trim_start_matches("error: ") ); std::process::exit(code); } fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec { if let Some(msg) = &e.message { if msg.contains("module is not defined") || msg.contains("exports is not defined") { return vec![ FixSuggestion::info( "Deno does not support CommonJS modules without `.cjs` extension.", ), FixSuggestion::hint( "Rewrite this module to ESM or change the file extension to `.cjs`.", ), ]; } else if msg.contains("openKv is not a function") { return vec![ FixSuggestion::info("Deno.openKv() is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-kv` flag to enable this API.", ), ]; } else if msg.contains("cron is not a function") { return vec![ FixSuggestion::info("Deno.cron() is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-cron` flag to enable this API.", ), ]; } else if msg.contains("WebSocketStream is not defined") { return vec![ FixSuggestion::info("new WebSocketStream() is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-net` flag to enable this API.", ), ]; } else if msg.contains("Temporal is not defined") { return vec![ FixSuggestion::info("Temporal is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-temporal` flag to enable this API.", ), ]; } else if msg.contains("BroadcastChannel is not defined") { return vec![ FixSuggestion::info("BroadcastChannel is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-broadcast-channel` flag to enable this API.", ), ]; } else if msg.contains("window is not defined") { return vec![ FixSuggestion::info("window global is not available in Deno 2."), FixSuggestion::hint("Replace `window` with `globalThis`."), ]; } else if msg.contains("UnsafeWindowSurface is not a constructor") { return vec![ FixSuggestion::info("Deno.UnsafeWindowSurface is an unstable API."), FixSuggestion::hint( "Run again with `--unstable-webgpu` flag to enable this API.", ), ]; // Try to capture errors like: // ``` // Uncaught Error: Cannot find module '../build/Release/canvas.node' // Require stack: // - /.../deno/npm/registry.npmjs.org/canvas/2.11.2/lib/bindings.js // - /.../.cache/deno/npm/registry.npmjs.org/canvas/2.11.2/lib/canvas.js // ``` } else if msg.contains("Cannot find module") && msg.contains("Require stack") && msg.contains(".node'") { return vec![ FixSuggestion::info_multiline( &[ "Trying to execute an npm package using Node-API addons,", "these packages require local `node_modules` directory to be present." ] ), FixSuggestion::hint_multiline( &[ "Add `\"nodeModulesDir\": \"auto\" option to `deno.json`, and then run", "`deno install --allow-scripts=npm: --entrypoint