0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-10-29 08:58:01 -04:00
denoland-deno/cli/args/flags.rs

10974 lines
299 KiB
Rust
Raw Normal View History

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
2020-09-05 20:34:02 -04:00
use clap::builder::styling::AnsiColor;
use clap::builder::FalseyValueParser;
2023-03-26 00:06:18 -04:00
use clap::value_parser;
2019-06-26 06:02:13 -04:00
use clap::Arg;
2023-03-26 00:06:18 -04:00
use clap::ArgAction;
2019-06-26 06:02:13 -04:00
use clap::ArgMatches;
2022-01-14 11:38:17 -05:00
use clap::ColorChoice;
use clap::Command;
2022-03-14 14:41:35 -04:00
use clap::ValueHint;
use color_print::cstr;
use deno_config::glob::FilePatterns;
use deno_config::glob::PathOrPatternSet;
use deno_core::anyhow::bail;
use deno_core::anyhow::Context;
use deno_core::error::AnyError;
use deno_core::normalize_path;
use deno_core::resolve_url_or_path;
use deno_core::url::Url;
use deno_graph::GraphKind;
use deno_runtime::deno_permissions::parse_sys_kind;
use deno_runtime::deno_permissions::PermissionsOptions;
2021-03-26 12:34:25 -04:00
use log::debug;
use log::Level;
use serde::Deserialize;
use serde::Serialize;
use std::collections::HashSet;
use std::env;
use std::ffi::OsString;
use std::net::SocketAddr;
use std::num::NonZeroU32;
use std::num::NonZeroU8;
use std::num::NonZeroUsize;
use std::path::Path;
use std::path::PathBuf;
use std::str::FromStr;
use crate::args::resolve_no_prompt;
use crate::util::fs::canonicalize_path;
use super::flags_net;
use super::DENO_FUTURE;
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub enum ConfigFlag {
#[default]
Discover,
Path(String),
Disabled,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct FileFlags {
pub ignore: Vec<String>,
pub include: Vec<String>,
}
impl FileFlags {
pub fn as_file_patterns(
&self,
base: &Path,
) -> Result<FilePatterns, AnyError> {
Ok(FilePatterns {
include: if self.include.is_empty() {
None
} else {
Some(PathOrPatternSet::from_include_relative_path_or_patterns(
base,
&self.include,
)?)
},
exclude: PathOrPatternSet::from_exclude_relative_path_or_patterns(
base,
&self.ignore,
)?,
base: base.to_path_buf(),
})
}
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct AddFlags {
pub packages: Vec<String>,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct RemoveFlags {
pub packages: Vec<String>,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct BenchFlags {
pub files: FileFlags,
pub filter: Option<String>,
pub json: bool,
pub no_run: bool,
pub watch: Option<WatchFlags>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct BundleFlags {
pub source_file: String,
pub out_file: Option<String>,
pub watch: Option<WatchFlags>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CacheFlags {
pub files: Vec<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CheckFlags {
pub files: Vec<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CompileFlags {
pub source_file: String,
pub output: Option<String>,
pub args: Vec<String>,
pub target: Option<String>,
pub no_terminal: bool,
pub icon: Option<String>,
pub include: Vec<String>,
}
impl CompileFlags {
pub fn resolve_target(&self) -> String {
self
.target
.clone()
.unwrap_or_else(|| env!("TARGET").to_string())
}
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CompletionsFlags {
pub buf: Box<[u8]>,
}
#[derive(Clone, Debug, Eq, PartialEq, Default)]
pub enum CoverageType {
#[default]
Summary,
Detailed,
Lcov,
Html,
}
#[derive(Clone, Debug, Eq, PartialEq, Default)]
pub struct CoverageFlags {
pub files: FileFlags,
pub output: Option<String>,
pub include: Vec<String>,
pub exclude: Vec<String>,
pub r#type: CoverageType,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum DocSourceFileFlag {
Builtin,
Paths(Vec<String>),
}
impl Default for DocSourceFileFlag {
fn default() -> Self {
Self::Builtin
}
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct DocHtmlFlag {
2024-04-24 16:34:21 -04:00
pub name: Option<String>,
2024-06-28 08:03:51 -04:00
pub category_docs_path: Option<String>,
pub symbol_redirect_map_path: Option<String>,
pub default_symbol_map_path: Option<String>,
pub strip_trailing_html: bool,
pub output: String,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct DocFlags {
pub private: bool,
pub json: bool,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
pub lint: bool,
pub html: Option<DocHtmlFlag>,
pub source_files: DocSourceFileFlag,
pub filter: Option<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct EvalFlags {
pub print: bool,
pub code: String,
}
#[derive(Clone, Default, Debug, Eq, PartialEq)]
pub struct FmtFlags {
pub check: bool,
pub files: FileFlags,
pub use_tabs: Option<bool>,
pub line_width: Option<NonZeroU32>,
pub indent_width: Option<NonZeroU8>,
pub single_quote: Option<bool>,
pub prose_wrap: Option<String>,
pub no_semicolons: Option<bool>,
pub watch: Option<WatchFlags>,
pub unstable_css: bool,
pub unstable_html: bool,
pub unstable_component: bool,
pub unstable_yaml: bool,
}
impl FmtFlags {
pub fn is_stdin(&self) -> bool {
let args = &self.files.include;
args.len() == 1 && args[0] == "-"
}
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct InitFlags {
pub dir: Option<String>,
pub lib: bool,
pub serve: bool,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct InfoFlags {
pub json: bool,
pub file: Option<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct InstallFlagsGlobal {
pub module_url: String,
pub args: Vec<String>,
pub name: Option<String>,
pub root: Option<String>,
pub force: bool,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum InstallKind {
#[allow(unused)]
Local(Option<AddFlags>),
Global(InstallFlagsGlobal),
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct InstallFlags {
pub global: bool,
pub kind: InstallKind,
}
2024-08-12 11:55:33 -04:00
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct JSONReferenceFlags {
pub json: deno_core::serde_json::Value,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct JupyterFlags {
pub install: bool,
pub kernel: bool,
pub conn_file: Option<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct UninstallFlagsGlobal {
pub name: String,
pub root: Option<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum UninstallKind {
#[allow(unused)]
Local,
Global(UninstallFlagsGlobal),
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct UninstallFlags {
pub global: bool,
pub kind: UninstallKind,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct LintFlags {
pub files: FileFlags,
pub rules: bool,
pub fix: bool,
pub maybe_rules_tags: Option<Vec<String>>,
pub maybe_rules_include: Option<Vec<String>>,
pub maybe_rules_exclude: Option<Vec<String>>,
pub json: bool,
pub compact: bool,
pub watch: Option<WatchFlags>,
pub ext: Option<String>,
}
impl LintFlags {
pub fn is_stdin(&self) -> bool {
let args = &self.files.include;
args.len() == 1 && args[0] == "-"
}
}
#[derive(Clone, Debug, Eq, PartialEq, Default)]
pub struct ReplFlags {
pub eval_files: Option<Vec<String>>,
pub eval: Option<String>,
pub is_default_command: bool,
}
#[derive(Clone, Debug, Eq, PartialEq, Default)]
pub struct RunFlags {
pub script: String,
pub watch: Option<WatchFlagsWithPaths>,
2024-08-12 11:55:33 -04:00
pub bare: bool,
}
impl RunFlags {
#[cfg(test)]
pub fn new_default(script: String) -> Self {
Self {
script,
watch: None,
2024-08-12 11:55:33 -04:00
bare: false,
}
}
pub fn is_stdin(&self) -> bool {
self.script == "-"
}
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ServeFlags {
pub script: String,
pub watch: Option<WatchFlagsWithPaths>,
pub port: u16,
pub host: String,
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
pub worker_count: Option<usize>,
}
impl ServeFlags {
#[cfg(test)]
pub fn new_default(script: String, port: u16, host: &str) -> Self {
Self {
script,
watch: None,
port,
host: host.to_owned(),
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
worker_count: None,
}
}
}
#[derive(Clone, Default, Debug, Eq, PartialEq)]
pub struct WatchFlags {
pub hmr: bool,
pub no_clear_screen: bool,
pub exclude: Vec<String>,
}
#[derive(Clone, Default, Debug, Eq, PartialEq)]
pub struct WatchFlagsWithPaths {
pub hmr: bool,
pub paths: Vec<String>,
pub no_clear_screen: bool,
pub exclude: Vec<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct TaskFlags {
pub cwd: Option<String>,
pub task: Option<String>,
pub is_run: bool,
}
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub enum TestReporterConfig {
#[default]
Pretty,
Dot,
Junit,
Tap,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct TestFlags {
pub doc: bool,
pub no_run: bool,
pub coverage_dir: Option<String>,
pub clean: bool,
pub fail_fast: Option<NonZeroUsize>,
pub files: FileFlags,
pub allow_none: bool,
pub filter: Option<String>,
pub shuffle: Option<u64>,
pub concurrent_jobs: Option<NonZeroUsize>,
pub trace_leaks: bool,
pub watch: Option<WatchFlagsWithPaths>,
pub reporter: TestReporterConfig,
pub junit_path: Option<String>,
pub hide_stacktraces: bool,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct UpgradeFlags {
pub dry_run: bool,
pub force: bool,
pub release_candidate: bool,
pub canary: bool,
pub version: Option<String>,
pub output: Option<String>,
pub version_or_hash_or_channel: Option<String>,
}
#[derive(Clone, Debug, Eq, PartialEq)]
2022-02-16 13:14:19 -05:00
pub struct VendorFlags {
pub specifiers: Vec<String>,
pub output_path: Option<String>,
2022-02-16 13:14:19 -05:00
pub force: bool,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PublishFlags {
pub token: Option<String>,
pub dry_run: bool,
pub allow_slow_types: bool,
pub allow_dirty: bool,
pub no_provenance: bool,
}
2024-08-12 11:55:33 -04:00
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct HelpFlags {
pub help: clap::builder::StyledStr,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum DenoSubcommand {
Add(AddFlags),
Remove(RemoveFlags),
Bench(BenchFlags),
Bundle(BundleFlags),
Cache(CacheFlags),
Check(CheckFlags),
Clean,
Compile(CompileFlags),
Completions(CompletionsFlags),
Coverage(CoverageFlags),
Doc(DocFlags),
Eval(EvalFlags),
Fmt(FmtFlags),
Init(InitFlags),
Info(InfoFlags),
Install(InstallFlags),
2024-08-12 11:55:33 -04:00
JSONReference(JSONReferenceFlags),
Jupyter(JupyterFlags),
Uninstall(UninstallFlags),
Lsp,
Lint(LintFlags),
Repl(ReplFlags),
Run(RunFlags),
Serve(ServeFlags),
Task(TaskFlags),
Test(TestFlags),
Types,
Upgrade(UpgradeFlags),
2022-02-16 13:14:19 -05:00
Vendor(VendorFlags),
Publish(PublishFlags),
2024-08-12 11:55:33 -04:00
Help(HelpFlags),
}
impl DenoSubcommand {
pub fn is_run(&self) -> bool {
matches!(self, Self::Run(_))
}
// Returns `true` if the subcommand depends on testing infrastructure.
pub fn needs_test(&self) -> bool {
matches!(
self,
Self::Test(_)
| Self::Jupyter(_)
| Self::Repl(_)
| Self::Bench(_)
| Self::Lsp
)
}
}
impl Default for DenoSubcommand {
fn default() -> DenoSubcommand {
DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: None,
is_default_command: true,
})
}
}
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum TypeCheckMode {
/// Type-check all modules.
All,
/// Skip type-checking of all modules. The default value for "deno run" and
/// several other subcommands.
None,
/// Only type-check local modules. The default value for "deno test" and
/// several other subcommands.
Local,
}
impl TypeCheckMode {
/// Gets if type checking will occur under this mode.
pub fn is_true(&self) -> bool {
match self {
Self::None => false,
Self::Local | Self::All => true,
}
}
/// Gets the corresponding module `GraphKind` that should be created
/// for the current `TypeCheckMode`.
pub fn as_graph_kind(&self) -> GraphKind {
match self.is_true() {
true => GraphKind::All,
false => GraphKind::CodeOnly,
}
}
}
impl Default for TypeCheckMode {
fn default() -> Self {
Self::None
}
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum CaData {
/// The string is a file path
File(String),
/// This variant is not exposed as an option in the CLI, it is used internally
/// for standalone binaries.
Bytes(Vec<u8>),
}
// Info needed to run NPM lifecycle scripts
#[derive(Clone, Debug, Eq, PartialEq, Default)]
pub struct LifecycleScriptsConfig {
pub allowed: PackagesAllowedScripts,
pub initial_cwd: Option<PathBuf>,
}
#[derive(Debug, Clone, Eq, PartialEq, Default)]
/// The set of npm packages that are allowed to run lifecycle scripts.
pub enum PackagesAllowedScripts {
All,
Some(Vec<String>),
#[default]
None,
}
fn parse_packages_allowed_scripts(s: &str) -> Result<String, AnyError> {
if !s.starts_with("npm:") {
bail!("Invalid package for --allow-scripts: '{}'. An 'npm:' specifier is required", s);
} else {
Ok(s.into())
}
}
#[derive(
Clone, Default, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct UnstableConfig {
pub legacy_flag_enabled: bool, // --unstable
pub bare_node_builtins: bool, // --unstable-bare-node-builts
pub byonm: bool,
pub sloppy_imports: bool,
pub features: Vec<String>, // --unstabe-kv --unstable-cron
}
#[derive(Clone, Debug, Eq, PartialEq, Default)]
2020-02-26 05:52:15 -05:00
pub struct Flags {
/// Vector of CLI arguments - these are user script arguments, all Deno
/// specific flags are removed.
pub argv: Vec<String>,
pub subcommand: DenoSubcommand,
pub frozen_lockfile: Option<bool>,
pub ca_stores: Option<Vec<String>>,
pub ca_data: Option<CaData>,
pub cache_blocklist: Vec<String>,
/// This is not exposed as an option in the CLI, it is used internally when
/// the language server is configured with an explicit cache option.
pub cache_path: Option<PathBuf>,
pub cached_only: bool,
pub type_check_mode: TypeCheckMode,
pub config_flag: ConfigFlag,
pub node_modules_dir: Option<bool>,
pub vendor: Option<bool>,
pub enable_op_summary_metrics: bool,
pub enable_testing_features: bool,
pub ext: Option<String>,
pub ignore: Vec<String>,
pub import_map_path: Option<String>,
pub env_file: Option<String>,
pub inspect_brk: Option<SocketAddr>,
pub inspect_wait: Option<SocketAddr>,
pub inspect: Option<SocketAddr>,
pub location: Option<Url>,
pub lock: Option<String>,
pub log_level: Option<Level>,
pub no_remote: bool,
pub no_lock: bool,
pub no_npm: bool,
pub reload: bool,
pub seed: Option<u64>,
pub strace_ops: Option<Vec<String>>,
pub unstable_config: UnstableConfig,
pub unsafely_ignore_certificate_errors: Option<Vec<String>>,
pub v8_flags: Vec<String>,
pub code_cache_enabled: bool,
pub permissions: PermissionFlags,
pub allow_scripts: PackagesAllowedScripts,
}
#[derive(Clone, Debug, Eq, PartialEq, Default, Serialize, Deserialize)]
pub struct PermissionFlags {
pub allow_all: bool,
pub allow_env: Option<Vec<String>>,
pub deny_env: Option<Vec<String>>,
pub allow_hrtime: bool,
pub deny_hrtime: bool,
pub allow_ffi: Option<Vec<String>>,
pub deny_ffi: Option<Vec<String>>,
pub allow_net: Option<Vec<String>>,
pub deny_net: Option<Vec<String>>,
pub allow_read: Option<Vec<String>>,
pub deny_read: Option<Vec<String>>,
pub allow_run: Option<Vec<String>>,
pub deny_run: Option<Vec<String>>,
pub allow_sys: Option<Vec<String>>,
pub deny_sys: Option<Vec<String>>,
pub allow_write: Option<Vec<String>>,
pub deny_write: Option<Vec<String>>,
pub no_prompt: bool,
}
impl PermissionFlags {
pub fn has_permission(&self) -> bool {
self.allow_all
|| self.allow_env.is_some()
|| self.deny_env.is_some()
|| self.allow_hrtime
|| self.deny_hrtime
|| self.allow_ffi.is_some()
|| self.deny_ffi.is_some()
|| self.allow_net.is_some()
|| self.deny_net.is_some()
|| self.allow_read.is_some()
|| self.deny_read.is_some()
|| self.allow_run.is_some()
|| self.deny_run.is_some()
|| self.allow_sys.is_some()
|| self.deny_sys.is_some()
|| self.allow_write.is_some()
|| self.deny_write.is_some()
}
pub fn to_options(
&self,
// will be None when `deno compile` can't resolve the cwd
initial_cwd: Option<&Path>,
) -> Result<PermissionsOptions, AnyError> {
fn convert_option_str_to_path_buf(
flag: &Option<Vec<String>>,
initial_cwd: Option<&Path>,
) -> Result<Option<Vec<PathBuf>>, AnyError> {
let Some(paths) = &flag else {
return Ok(None);
};
let mut new_paths = Vec::with_capacity(paths.len());
for path in paths {
if let Some(initial_cwd) = initial_cwd {
new_paths.push(initial_cwd.join(path))
} else {
let path = PathBuf::from(path);
if path.is_absolute() {
new_paths.push(path);
} else {
bail!("Could not resolve relative permission path '{}' when current working directory could not be resolved.", path.display())
}
}
}
Ok(Some(new_paths))
}
Ok(PermissionsOptions {
allow_all: self.allow_all,
allow_env: self.allow_env.clone(),
deny_env: self.deny_env.clone(),
allow_hrtime: self.allow_hrtime,
deny_hrtime: self.deny_hrtime,
allow_net: self.allow_net.clone(),
deny_net: self.deny_net.clone(),
allow_ffi: convert_option_str_to_path_buf(&self.allow_ffi, initial_cwd)?,
deny_ffi: convert_option_str_to_path_buf(&self.deny_ffi, initial_cwd)?,
allow_read: convert_option_str_to_path_buf(
&self.allow_read,
initial_cwd,
)?,
deny_read: convert_option_str_to_path_buf(&self.deny_read, initial_cwd)?,
allow_run: self.allow_run.clone(),
deny_run: self.deny_run.clone(),
allow_sys: self.allow_sys.clone(),
deny_sys: self.deny_sys.clone(),
allow_write: convert_option_str_to_path_buf(
&self.allow_write,
initial_cwd,
)?,
deny_write: convert_option_str_to_path_buf(
&self.deny_write,
initial_cwd,
)?,
prompt: !resolve_no_prompt(self),
})
}
2018-11-15 12:56:17 -05:00
}
fn join_paths(allowlist: &[String], d: &str) -> String {
allowlist
.iter()
.map(|path| path.to_string())
.collect::<Vec<String>>()
.join(d)
}
2020-02-26 05:52:15 -05:00
impl Flags {
/// Return list of permission arguments that are equivalent
/// to the ones used to create `self`.
pub fn to_permission_args(&self) -> Vec<String> {
let mut args = vec![];
if self.permissions.allow_all {
args.push("--allow-all".to_string());
return args;
}
match &self.permissions.allow_read {
Some(read_allowlist) if read_allowlist.is_empty() => {
args.push("--allow-read".to_string());
}
Some(read_allowlist) => {
let s = format!("--allow-read={}", join_paths(read_allowlist, ","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_read {
Some(read_denylist) if read_denylist.is_empty() => {
args.push("--deny-read".to_string());
}
Some(read_denylist) => {
let s = format!("--deny-read={}", join_paths(read_denylist, ","));
args.push(s);
}
_ => {}
}
match &self.permissions.allow_write {
Some(write_allowlist) if write_allowlist.is_empty() => {
args.push("--allow-write".to_string());
}
Some(write_allowlist) => {
let s = format!("--allow-write={}", join_paths(write_allowlist, ","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_write {
Some(write_denylist) if write_denylist.is_empty() => {
args.push("--deny-write".to_string());
}
Some(write_denylist) => {
let s = format!("--deny-write={}", join_paths(write_denylist, ","));
args.push(s);
}
_ => {}
}
match &self.permissions.allow_net {
Some(net_allowlist) if net_allowlist.is_empty() => {
args.push("--allow-net".to_string());
}
Some(net_allowlist) => {
let s = format!("--allow-net={}", net_allowlist.join(","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_net {
Some(net_denylist) if net_denylist.is_empty() => {
args.push("--deny-net".to_string());
}
Some(net_denylist) => {
let s = format!("--deny-net={}", net_denylist.join(","));
args.push(s);
}
_ => {}
}
match &self.unsafely_ignore_certificate_errors {
Some(ic_allowlist) if ic_allowlist.is_empty() => {
2021-08-10 08:19:42 -04:00
args.push("--unsafely-ignore-certificate-errors".to_string());
}
Some(ic_allowlist) => {
let s = format!(
2021-08-10 08:19:42 -04:00
"--unsafely-ignore-certificate-errors={}",
ic_allowlist.join(",")
);
args.push(s);
}
_ => {}
}
match &self.permissions.allow_env {
Some(env_allowlist) if env_allowlist.is_empty() => {
args.push("--allow-env".to_string());
}
Some(env_allowlist) => {
let s = format!("--allow-env={}", env_allowlist.join(","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_env {
Some(env_denylist) if env_denylist.is_empty() => {
args.push("--deny-env".to_string());
}
Some(env_denylist) => {
let s = format!("--deny-env={}", env_denylist.join(","));
args.push(s);
}
_ => {}
}
match &self.permissions.allow_run {
Some(run_allowlist) if run_allowlist.is_empty() => {
args.push("--allow-run".to_string());
}
Some(run_allowlist) => {
let s = format!("--allow-run={}", run_allowlist.join(","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_run {
Some(run_denylist) if run_denylist.is_empty() => {
args.push("--deny-run".to_string());
}
Some(run_denylist) => {
let s = format!("--deny-run={}", run_denylist.join(","));
args.push(s);
}
_ => {}
}
match &self.permissions.allow_sys {
Some(sys_allowlist) if sys_allowlist.is_empty() => {
args.push("--allow-sys".to_string());
}
Some(sys_allowlist) => {
let s = format!("--allow-sys={}", sys_allowlist.join(","));
args.push(s)
}
_ => {}
}
match &self.permissions.deny_sys {
Some(sys_denylist) if sys_denylist.is_empty() => {
args.push("--deny-sys".to_string());
}
Some(sys_denylist) => {
let s = format!("--deny-sys={}", sys_denylist.join(","));
args.push(s)
}
_ => {}
}
match &self.permissions.allow_ffi {
Some(ffi_allowlist) if ffi_allowlist.is_empty() => {
args.push("--allow-ffi".to_string());
}
Some(ffi_allowlist) => {
let s = format!("--allow-ffi={}", join_paths(ffi_allowlist, ","));
args.push(s);
}
_ => {}
}
match &self.permissions.deny_ffi {
Some(ffi_denylist) if ffi_denylist.is_empty() => {
args.push("--deny-ffi".to_string());
}
Some(ffi_denylist) => {
let s = format!("--deny-ffi={}", join_paths(ffi_denylist, ","));
args.push(s);
}
_ => {}
}
if self.permissions.allow_hrtime {
args.push("--allow-hrtime".to_string());
}
if self.permissions.deny_hrtime {
args.push("--deny-hrtime".to_string());
}
args
}
/// Extract the paths the config file should be discovered from.
///
/// Returns `None` if the config file should not be auto-discovered.
pub fn config_path_args(&self, current_dir: &Path) -> Option<Vec<PathBuf>> {
fn resolve_multiple_files(
files_or_dirs: &[String],
current_dir: &Path,
) -> Vec<PathBuf> {
let mut seen = HashSet::with_capacity(files_or_dirs.len());
let result = files_or_dirs
.iter()
.filter_map(|p| {
let path = normalize_path(current_dir.join(p));
if seen.insert(path.clone()) {
Some(path)
} else {
None
}
})
.collect::<Vec<_>>();
if result.is_empty() {
vec![current_dir.to_path_buf()]
} else {
result
}
}
use DenoSubcommand::*;
match &self.subcommand {
Fmt(FmtFlags { files, .. }) => {
Some(resolve_multiple_files(&files.include, current_dir))
}
Lint(LintFlags { files, .. }) => {
Some(resolve_multiple_files(&files.include, current_dir))
}
Run(RunFlags { script, .. })
| Compile(CompileFlags {
source_file: script,
..
}) => {
if let Ok(module_specifier) = resolve_url_or_path(script, current_dir) {
if module_specifier.scheme() == "file"
|| module_specifier.scheme() == "npm"
{
if let Ok(p) = module_specifier.to_file_path() {
Some(vec![p.parent().unwrap().to_path_buf()])
} else {
Some(vec![current_dir.to_path_buf()])
}
} else {
// When the entrypoint doesn't have file: scheme (it's the remote
// script), then we don't auto discover config file.
None
}
} else {
Some(vec![current_dir.to_path_buf()])
}
}
Task(TaskFlags {
cwd: Some(path), ..
}) => {
// todo(dsherret): Why is this canonicalized? Document why.
// attempt to resolve the config file from the task subcommand's
// `--cwd` when specified
match canonicalize_path(&PathBuf::from(path)) {
Ok(path) => Some(vec![path]),
Err(_) => Some(vec![current_dir.to_path_buf()]),
}
}
_ => Some(vec![current_dir.to_path_buf()]),
}
}
pub fn has_permission(&self) -> bool {
self.permissions.has_permission()
}
pub fn has_permission_in_argv(&self) -> bool {
self.argv.iter().any(|arg| {
arg == "--allow-all"
|| arg == "--allow-hrtime"
|| arg == "--deny-hrtime"
|| arg.starts_with("--allow-env")
|| arg.starts_with("--deny-env")
|| arg.starts_with("--allow-ffi")
|| arg.starts_with("--deny-ffi")
|| arg.starts_with("--allow-net")
|| arg.starts_with("--deny-net")
|| arg.starts_with("--allow-read")
|| arg.starts_with("--deny-read")
|| arg.starts_with("--allow-run")
|| arg.starts_with("--deny-run")
|| arg.starts_with("--allow-sys")
|| arg.starts_with("--deny-sys")
|| arg.starts_with("--allow-write")
|| arg.starts_with("--deny-write")
})
}
#[inline(always)]
fn allow_all(&mut self) {
self.permissions.allow_all = true;
self.permissions.allow_read = Some(vec![]);
self.permissions.allow_env = Some(vec![]);
self.permissions.allow_net = Some(vec![]);
self.permissions.allow_run = Some(vec![]);
self.permissions.allow_write = Some(vec![]);
self.permissions.allow_sys = Some(vec![]);
self.permissions.allow_ffi = Some(vec![]);
self.permissions.allow_hrtime = true;
}
pub fn resolve_watch_exclude_set(
&self,
) -> Result<PathOrPatternSet, AnyError> {
if let DenoSubcommand::Run(RunFlags {
watch:
Some(WatchFlagsWithPaths {
exclude: excluded_paths,
..
}),
..
})
| DenoSubcommand::Bundle(BundleFlags {
watch:
Some(WatchFlags {
exclude: excluded_paths,
..
}),
..
})
| DenoSubcommand::Bench(BenchFlags {
watch:
Some(WatchFlags {
exclude: excluded_paths,
..
}),
..
})
| DenoSubcommand::Test(TestFlags {
watch:
Some(WatchFlagsWithPaths {
exclude: excluded_paths,
..
}),
..
})
| DenoSubcommand::Lint(LintFlags {
watch:
Some(WatchFlags {
exclude: excluded_paths,
..
}),
..
})
| DenoSubcommand::Fmt(FmtFlags {
watch:
Some(WatchFlags {
exclude: excluded_paths,
..
}),
..
}) = &self.subcommand
{
let cwd = std::env::current_dir()?;
PathOrPatternSet::from_exclude_relative_path_or_patterns(
&cwd,
excluded_paths,
)
.context("Failed resolving watch exclude patterns.")
} else {
Ok(PathOrPatternSet::default())
}
}
}
static ENV_VARIABLES_HELP: &str = cstr!(
r#"<y>Environment variables:</>
2024-08-12 11:55:33 -04:00
<g>DENO_AUTH_TOKENS</> A semi-colon separated list of bearer tokens and hostnames
to use when fetching remote modules from private repositories
<p(245)>(e.g. "abcde12345@deno.land;54321edcba@github.com")</>
<g>DENO_FUTURE</> Set to "1" to enable APIs that will take effect in Deno 2
<g>DENO_CERT</> Load certificate authorities from PEM encoded file
<g>DENO_DIR</> Set the cache directory
<g>DENO_INSTALL_ROOT</> Set deno install's output directory
<p(245)>(defaults to $HOME/.deno/bin)</>
<g>DENO_NO_PACKAGE_JSON</> Disables auto-resolution of package.json
<g>DENO_NO_UPDATE_CHECK</> Set to disable checking if a newer Deno version is available
<g>DENO_TLS_CA_STORE</> Comma-separated list of order dependent certificate stores.
Possible values: "system", "mozilla".
<p(245)>(defaults to "mozilla")</>
<g>HTTP_PROXY</> Proxy address for HTTP requests
<p(245)>(module downloads, fetch)</>
<g>HTTPS_PROXY</> Proxy address for HTTPS requests
<p(245)>(module downloads, fetch)</>
<g>NO_COLOR</> Set to disable color
<g>NO_PROXY</> Comma-separated list of hosts which do not use a proxy
<p(245)>(module downloads, fetch)</>
<g>NPM_CONFIG_REGISTRY</> URL to use for the npm registry."#
);
2019-06-05 13:44:46 -04:00
static DENO_HELP: &str = cstr!(
2024-08-12 11:55:33 -04:00
"Deno: <g>A modern JavaScript and TypeScript runtime</>
<p(245)>Usage:</> <g>{usage}</>
<y>Commands:</>
<y>Execution:</>
<g>run</> Run a JavaScript or TypeScript program, or a task
<p(245)>deno run main.ts | deno run --allow-net=google.com main.ts | deno main.ts</>
<g>serve</> Run a server
<p(245)>deno serve main.ts</>
<g>task</> Run a task defined in the configuration file
<p(245)>deno task dev</>
<g>repl</> Start an interactive Read-Eval-Print Loop (REPL) for Deno
<g>eval</> Evaluate a script from the command line
<y>Dependency management:</>
<g>add</> Add dependencies
<p(245)>deno add @std/assert | deno add npm:express</>
<g>install</> Install script as an executable
<g>uninstall</> Uninstall a script previously installed with deno install
<g>remove</> Remove dependencies from the configuration file
2024-08-12 11:55:33 -04:00
<y>Tooling:</>
<g>bench</> Run benchmarks
<p(245)>deno bench bench.ts</>
<g>cache</> Cache the dependencies
<g>check</> Type-check the dependencies
<g>compile</> Compile the script into a self contained executable
<p(245)>deno compile main.ts | deno compile --target=x86_64-unknown-linux-gnu</>
<g>coverage</> Print coverage reports
<g>doc</> Genereate and show documentation for a module or built-ins
<p(245)>deno doc | deno doc --json | deno doc --html mod.ts</>
<g>fmt</> Format source files
<p(245)>deno fmt | deno fmt main.ts</>
<g>info</> Show info about cache or info related to source file
<g>jupyter</> Deno kernel for Jupyter notebooks
<g>lint</> Lint source files
<g>init</> Initialize a new project
<g>test</> Run tests
<p(245)>deno test | deno test test.ts</>
<g>publish</> Publish the current working directory's package or workspace
<g>upgrade</> Upgrade deno executable to given version
<p(245)>deno upgrade | deno upgrade --version=1.45.0 | deno upgrade --canary</>
{after-help}
<y>Docs:</> https://docs.deno.com
<y>Standard Library:</> https://jsr.io/@std
<y>Bugs:</> https://github.com/denoland/deno/issues
<y>Discord:</> https://discord.gg/deno
");
2019-05-23 14:57:44 -04:00
/// Main entry point for parsing deno's command line flags.
pub fn flags_from_vec(args: Vec<OsString>) -> clap::error::Result<Flags> {
2023-03-26 00:06:18 -04:00
let mut app = clap_root();
let mut matches = app.try_get_matches_from_mut(&args)?;
2020-02-26 05:52:15 -05:00
let mut flags = Flags::default();
2023-03-26 00:06:18 -04:00
if matches.get_flag("quiet") {
2020-03-10 08:26:17 -04:00
flags.log_level = Some(Level::Error);
2023-03-26 00:06:18 -04:00
} else if let Some(log_level) = matches.get_one::<String>("log-level") {
flags.log_level = match log_level.as_str() {
"trace" => Some(Level::Trace),
2023-03-26 00:06:18 -04:00
"debug" => Some(Level::Debug),
"info" => Some(Level::Info),
_ => unreachable!(),
};
2020-03-10 08:26:17 -04:00
}
if let Some(help_expansion) = matches.get_one::<String>("help").cloned() {
let mut subcommand = if let Some((sub, _)) = matches.remove_subcommand() {
app.find_subcommand(sub).unwrap().clone()
} else {
app
};
if help_expansion == "unstable"
&& subcommand
.get_arguments()
.any(|arg| arg.get_id().as_str() == "unstable")
{
subcommand = subcommand
.mut_arg("unstable", |arg| {
let new_help = arg
.get_help()
.unwrap()
.to_string()
.split_once("\n")
.unwrap()
.0
.to_string();
arg.help_heading(UNSTABLE_HEADING).help(new_help)
})
.mut_args(|arg| {
// long_help here is being used as a metadata, see unstable args definition
if arg.get_help_heading() == Some(UNSTABLE_HEADING)
&& arg.get_long_help().is_some()
{
arg.hide(false)
} else {
arg
}
});
}
help_parse(&mut flags, subcommand);
return Ok(flags);
} else if matches.contains_id("help") {
let subcommand = if let Some((sub, _)) = matches.remove_subcommand() {
app.find_subcommand(sub).unwrap().clone()
} else {
app
};
help_parse(&mut flags, subcommand);
return Ok(flags);
} else if let Some(help_subcommand_matches) =
matches.subcommand_matches("help")
{
app.build();
let subcommand =
if let Some(sub) = help_subcommand_matches.subcommand_name() {
app.find_subcommand(sub).unwrap().clone()
} else {
app
};
help_parse(&mut flags, subcommand);
return Ok(flags);
}
2023-03-26 00:06:18 -04:00
if let Some((subcommand, mut m)) = matches.remove_subcommand() {
match subcommand.as_str() {
"add" => add_parse(&mut flags, &mut m),
"remove" => remove_parse(&mut flags, &mut m),
2023-03-26 00:06:18 -04:00
"bench" => bench_parse(&mut flags, &mut m),
"bundle" => bundle_parse(&mut flags, &mut m),
"cache" => cache_parse(&mut flags, &mut m),
"check" => check_parse(&mut flags, &mut m),
"clean" => clean_parse(&mut flags, &mut m),
2023-03-26 00:06:18 -04:00
"compile" => compile_parse(&mut flags, &mut m),
"completions" => completions_parse(&mut flags, &mut m, app),
"coverage" => coverage_parse(&mut flags, &mut m),
"doc" => doc_parse(&mut flags, &mut m),
"eval" => eval_parse(&mut flags, &mut m),
"fmt" => fmt_parse(&mut flags, &mut m),
"init" => init_parse(&mut flags, &mut m),
"info" => info_parse(&mut flags, &mut m),
"install" => install_parse(&mut flags, &mut m),
2024-08-12 11:55:33 -04:00
"json_reference" => json_reference_parse(&mut flags, &mut m, app),
"jupyter" => jupyter_parse(&mut flags, &mut m),
2023-03-26 00:06:18 -04:00
"lint" => lint_parse(&mut flags, &mut m),
"lsp" => lsp_parse(&mut flags, &mut m),
"repl" => repl_parse(&mut flags, &mut m),
2024-08-12 11:55:33 -04:00
"run" => run_parse(&mut flags, &mut m, app, false)?,
"serve" => serve_parse(&mut flags, &mut m, app)?,
2023-03-26 00:06:18 -04:00
"task" => task_parse(&mut flags, &mut m),
"test" => test_parse(&mut flags, &mut m),
"types" => types_parse(&mut flags, &mut m),
"uninstall" => uninstall_parse(&mut flags, &mut m),
"upgrade" => upgrade_parse(&mut flags, &mut m),
"vendor" => vendor_parse(&mut flags, &mut m),
"publish" => publish_parse(&mut flags, &mut m),
2023-03-26 00:06:18 -04:00
_ => unreachable!(),
}
} else {
let has_non_globals = app
.get_arguments()
.filter(|arg| !arg.is_global_set())
.any(|arg| {
matches
.value_source(arg.get_id().as_str())
.is_some_and(|value| value != clap::parser::ValueSource::DefaultValue)
});
if has_non_globals || matches.contains_id("script_arg") {
2024-08-12 11:55:33 -04:00
run_parse(&mut flags, &mut matches, app, true)?;
} else {
handle_repl_flags(
&mut flags,
ReplFlags {
eval_files: None,
eval: None,
is_default_command: true,
},
)
}
}
Ok(flags)
}
macro_rules! heading {
($($name:ident = $title:expr),+; $total:literal) => {
$(const $name: &str = $title;)+
const HEADING_ORDER: [&str; $total] = [$($name),+];
};
}
heading! {
// subcommand flags headings
DOC_HEADING = "Documentation options",
FMT_HEADING = "Formatting options",
COMPILE_HEADING = "Compile options",
LINT_HEADING = "Linting options",
TEST_HEADING = "Testing options",
UPGRADE_HEADING = "Upgrade options",
PUBLISH_HEADING = "Publishing options",
// categorized flags headings
TYPE_CHECKING_HEADING = "Type checking options",
FILE_WATCHING_HEADING = "File watching options",
DEBUGGING_HEADING = "Debugging options",
DEPENDENCY_MANAGEMENT_HEADING = "Dependency management options",
UNSTABLE_HEADING = "Unstable options";
12
}
fn help_parse(flags: &mut Flags, mut subcommand: Command) {
let mut args = subcommand
.get_arguments()
.map(|arg| {
(
arg.get_id().as_str().to_string(),
arg.get_help_heading().map(|h| h.to_string()),
)
})
.collect::<Vec<_>>();
args.sort_by(|a, b| {
a.1
.as_ref()
.map(|heading| HEADING_ORDER.iter().position(|h| h == heading))
.cmp(
&b.1
.as_ref()
.map(|heading| HEADING_ORDER.iter().position(|h| h == heading)),
)
.then(a.0.cmp(&b.0))
});
for (mut i, (arg, heading)) in args.into_iter().enumerate() {
if let Some(heading) = heading {
let heading_i = HEADING_ORDER.iter().position(|h| h == &heading).unwrap();
i += heading_i * 100;
}
subcommand = subcommand.mut_arg(arg, |arg| arg.display_order(i));
}
flags.subcommand = DenoSubcommand::Help(HelpFlags {
help: subcommand.render_help(),
});
}
2024-08-12 11:55:33 -04:00
// copied from clap, https://github.com/clap-rs/clap/blob/4e1a565b8adb4f2ad74a9631565574767fdc37ae/clap_builder/src/parser/features/suggestions.rs#L11-L26
pub fn did_you_mean<T, I>(v: &str, possible_values: I) -> Vec<String>
where
T: AsRef<str>,
I: IntoIterator<Item = T>,
{
let mut candidates: Vec<(f64, String)> = possible_values
.into_iter()
// GH #4660: using `jaro` because `jaro_winkler` implementation in `strsim-rs` is wrong
// causing strings with common prefix >=10 to be considered perfectly similar
.map(|pv| (strsim::jaro(v, pv.as_ref()), pv.as_ref().to_owned()))
// Confidence of 0.7 so that bar -> baz is suggested
.filter(|(confidence, _)| *confidence > 0.7)
.collect();
candidates
.sort_by(|a, b| a.0.partial_cmp(&b.0).unwrap_or(std::cmp::Ordering::Equal));
candidates.into_iter().map(|(_, pv)| pv).collect()
}
2022-01-14 11:38:17 -05:00
fn handle_repl_flags(flags: &mut Flags, repl_flags: ReplFlags) {
// If user runs just `deno` binary we enter REPL and allow all permissions.
if repl_flags.is_default_command {
flags.permissions.allow_net = Some(vec![]);
flags.permissions.allow_env = Some(vec![]);
flags.permissions.allow_run = Some(vec![]);
flags.permissions.allow_read = Some(vec![]);
flags.permissions.allow_sys = Some(vec![]);
flags.permissions.allow_write = Some(vec![]);
flags.permissions.allow_ffi = Some(vec![]);
flags.permissions.allow_hrtime = true;
}
2022-01-14 11:38:17 -05:00
flags.subcommand = DenoSubcommand::Repl(repl_flags);
}
2024-08-12 11:55:33 -04:00
pub fn clap_root() -> Command {
let long_version = format!(
"{} ({}, {}, {})\nv8 {}\ntypescript {}",
crate::version::DENO_VERSION_INFO.deno,
crate::version::DENO_VERSION_INFO.release_channel.name(),
env!("PROFILE"),
env!("TARGET"),
deno_core::v8::VERSION_STRING,
crate::version::DENO_VERSION_INFO.typescript
);
run_args(Command::new("deno"), true)
.args(unstable_args(UnstableArgsConfig::ResolutionAndRuntime))
2024-08-12 11:55:33 -04:00
.next_line_help(false)
.bin_name("deno")
.styles(
clap::builder::Styles::styled()
.header(AnsiColor::Yellow.on_default())
.usage(AnsiColor::White.on_default())
.literal(AnsiColor::Green.on_default())
.placeholder(AnsiColor::Green.on_default()),
)
.color(ColorChoice::Auto)
2024-08-12 11:55:33 -04:00
.term_width(800)
.version(crate::version::DENO_VERSION_INFO.deno)
.long_version(long_version)
.disable_version_flag(true)
2024-08-12 11:55:33 -04:00
.disable_help_flag(true)
.disable_help_subcommand(true)
.arg(
Arg::new("help")
.short('h')
.long("help")
.hide(true)
.action(ArgAction::Append)
.num_args(0..=1)
.require_equals(true)
.value_parser(["unstable"])
.global(true),
)
.arg(
Arg::new("version")
.short('V')
.short_alias('v')
.long("version")
.action(ArgAction::Version)
.help("Print version"),
)
2019-04-06 18:13:06 -04:00
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("log-level")
.short('L')
.long("log-level")
.help("Set log level")
2022-04-11 01:01:02 -04:00
.hide(true)
.value_parser(["trace", "debug", "info"])
2019-05-03 17:15:16 -04:00
.global(true),
2019-07-31 11:02:20 -04:00
)
2020-03-10 08:26:17 -04:00
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("quiet")
.short('q')
2020-03-10 08:26:17 -04:00
.long("quiet")
.help("Suppress diagnostic output")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
2020-03-10 08:26:17 -04:00
.global(true),
)
.subcommand(run_subcommand())
.subcommand(serve_subcommand())
.defer(|cmd| {
2024-08-12 11:55:33 -04:00
let cmd = cmd
.subcommand(add_subcommand())
.subcommand(remove_subcommand())
.subcommand(bench_subcommand())
.subcommand(bundle_subcommand())
.subcommand(cache_subcommand())
.subcommand(check_subcommand())
.subcommand(clean_subcommand())
.subcommand(compile_subcommand())
.subcommand(completions_subcommand())
.subcommand(coverage_subcommand())
.subcommand(doc_subcommand())
.subcommand(eval_subcommand())
.subcommand(fmt_subcommand())
.subcommand(init_subcommand())
.subcommand(info_subcommand())
.subcommand(if *DENO_FUTURE {
future_install_subcommand()
} else {
install_subcommand()
})
2024-08-12 11:55:33 -04:00
.subcommand(json_reference_subcommand())
.subcommand(jupyter_subcommand())
.subcommand(uninstall_subcommand())
.subcommand(lsp_subcommand())
.subcommand(lint_subcommand())
.subcommand(publish_subcommand())
.subcommand(repl_subcommand())
.subcommand(task_subcommand())
.subcommand(test_subcommand())
.subcommand(types_subcommand())
.subcommand(upgrade_subcommand())
2024-08-12 11:55:33 -04:00
.subcommand(vendor_subcommand());
let help = help_subcommand(&cmd);
cmd.subcommand(help)
})
2024-08-12 11:55:33 -04:00
.help_template(DENO_HELP)
.after_help(ENV_VARIABLES_HELP)
2024-08-12 11:55:33 -04:00
.next_line_help(false)
}
#[inline(always)]
fn command(
name: &'static str,
about: impl clap::builder::IntoResettable<clap::builder::StyledStr>,
unstable_args_config: UnstableArgsConfig,
) -> Command {
Command::new(name)
.about(about)
.args(unstable_args(unstable_args_config))
}
2024-08-12 11:55:33 -04:00
fn help_subcommand(app: &Command) -> Command {
command("help", None, UnstableArgsConfig::None)
.disable_version_flag(true)
2024-08-12 11:55:33 -04:00
.disable_help_subcommand(true)
.subcommands(app.get_subcommands().map(|command| {
Command::new(command.get_name().to_owned())
.disable_help_flag(true)
.disable_version_flag(true)
}))
}
fn add_subcommand() -> Command {
command(
"add",
"Add dependencies to the configuration file.
deno add @std/path
You can add multiple dependencies at once:
deno add @std/path @std/assert
",
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd.arg(
Arg::new("packages")
.help("List of packages to add")
.required_unless_present("help")
.num_args(1..)
.action(ArgAction::Append),
)
})
}
fn remove_subcommand() -> Command {
command(
"remove",
cstr!(
"Remove dependencies from the configuration file.
deno remove @std/path
You can remove multiple dependencies at once:
<p(245)>deno remove @std/path @std/assert</>
"
),
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd.arg(
Arg::new("packages")
.help("List of packages to remove")
.required_unless_present("help")
.num_args(1..)
.action(ArgAction::Append),
)
})
}
2023-03-26 00:06:18 -04:00
fn bench_subcommand() -> Command {
command(
"bench",
"Run benchmarks using Deno's built-in bench tool.
Evaluate the given modules, run all benches declared with 'Deno.bench()'
2022-04-11 01:01:02 -04:00
and report results to standard output:
deno bench src/fetch_bench.ts src/signal_bench.ts
Directory arguments are expanded to all contained files matching the
glob {*_,*.,}bench.{js,mjs,ts,mts,jsx,tsx}:
deno bench src/",
UnstableArgsConfig::ResolutionAndRuntime,
)
.defer(|cmd| {
runtime_args(cmd, true, false)
.arg(check_arg(true))
.arg(
Arg::new("json")
.long("json")
.action(ArgAction::SetTrue)
.help("UNSTABLE: Output benchmark result in JSON format"),
)
.arg(
Arg::new("ignore")
.long("ignore")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Ignore files"),
)
.arg(
Arg::new("filter")
.long("filter")
.allow_hyphen_values(true)
.help(
"Run benchmarks with this string or regexp pattern in the bench name",
),
)
.arg(
Arg::new("files")
.help("List of file names to run")
.num_args(..)
.action(ArgAction::Append),
)
.arg(
Arg::new("no-run")
.long("no-run")
.help("Cache bench modules, but don't run benchmarks")
.action(ArgAction::SetTrue),
)
.arg(watch_arg(false))
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
.arg(script_arg().last(true))
.arg(env_file_arg())
})
}
2023-03-26 00:06:18 -04:00
fn bundle_subcommand() -> Command {
command("bundle", "⚠️ Warning: `deno bundle` is deprecated and will be removed in Deno 2.0.
Use an alternative bundler like \"deno_emit\", \"esbuild\" or \"rollup\" instead.
Output a single JavaScript file with all dependencies.
deno bundle jsr:@std/http/file-server file_server.bundle.js
If no output file is given, the output is written to standard output:
deno bundle jsr:@std/http/file-server", UnstableArgsConfig::ResolutionOnly)
.hide(true)
.defer(|cmd| {
2024-08-12 11:55:33 -04:00
compile_args(cmd)
.hide(true)
.arg(check_arg(true))
.arg(
Arg::new("source_file")
.required_unless_present("help")
.value_hint(ValueHint::FilePath),
)
.arg(Arg::new("out_file").value_hint(ValueHint::FilePath))
.arg(watch_arg(false))
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
.arg(executable_ext_arg())
})
}
2023-03-26 00:06:18 -04:00
fn cache_subcommand() -> Command {
command(
"cache",
"Cache and compile remote dependencies recursively.
Download and compile a module with all of its static dependencies and save
2022-04-11 01:01:02 -04:00
them in the local cache, without running any code:
deno cache jsr:@std/http/file-server
Future runs of this module will trigger no downloads or compilation unless
--reload is specified.",
UnstableArgsConfig::ResolutionOnly,
)
.defer(|cmd| {
compile_args(cmd)
.arg(check_arg(false))
.arg(
Arg::new("file")
.num_args(1..)
.required_unless_present("help")
.value_hint(ValueHint::FilePath),
)
.arg(frozen_lockfile_arg())
.arg(allow_scripts_arg())
})
}
fn clean_subcommand() -> Command {
command(
"clean",
"Remove the cache directory ($DENO_DIR)",
UnstableArgsConfig::None,
)
}
2023-03-26 00:06:18 -04:00
fn check_subcommand() -> Command {
command("check",
2024-08-12 11:55:33 -04:00
"Download and type-check without execution.
deno check jsr:@std/http/file-server
Unless --reload is specified, this command will not re-download already cached dependencies.",
UnstableArgsConfig::ResolutionAndRuntime
2024-08-12 11:55:33 -04:00
)
.defer(|cmd| {
compile_args_without_check_args(cmd)
.arg(
Arg::new("all")
.long("all")
.help("Type-check all code, including remote modules and npm packages")
.action(ArgAction::SetTrue)
.conflicts_with("no-remote")
)
.arg(
// past alias for --all
Arg::new("remote")
.long("remote")
.help("Type-check all modules, including remote ones")
.action(ArgAction::SetTrue)
.conflicts_with("no-remote")
.hide(true)
)
.arg(
Arg::new("file")
.num_args(1..)
.required_unless_present("help")
.value_hint(ValueHint::FilePath),
)
}
)
}
2023-03-26 00:06:18 -04:00
fn compile_subcommand() -> Command {
command(
"compile",
"Compiles the given script into a self contained executable.
deno compile -A jsr:@std/http/file-server
deno compile --output file_server jsr:@std/http/file-server
Any flags passed which affect runtime behavior, such as '--unstable',
'--allow-*', '--v8-flags', etc. are encoded into the output executable and
used at runtime as if they were passed to a similar 'deno run' command.
The executable name is inferred by default: Attempt to take the file stem of
the URL path. The above example would become 'file_server'. If the file stem
is something generic like 'main', 'mod', 'index' or 'cli', and the path has no
parent, take the file name of the parent path. Otherwise settle with the
generic name. If the resulting name has an '@...' suffix, strip it.
Cross-compiling to different target architectures is supported using the
`--target` flag. On the first invocation with deno will download proper
binary and cache it in $DENO_DIR. The aarch64-apple-darwin target is not
supported in canary.
",
UnstableArgsConfig::ResolutionAndRuntime,
)
.defer(|cmd| {
runtime_args(cmd, true, false)
.arg(check_arg(true))
.arg(
Arg::new("include")
.long("include")
.help(
cstr!("Includes an additional module in the compiled executable's module graph.
<p(245)>Use this flag if a dynamically imported module or a web worker main module
fails to load in the executable. This flag can be passed multiple times,
to include multiple additional modules.</>",
))
.action(ArgAction::Append)
.value_hint(ValueHint::FilePath)
.help_heading(COMPILE_HEADING),
)
.arg(
Arg::new("output")
.long("output")
.short('o')
.value_parser(value_parser!(String))
.help(cstr!("Output file <p(245)>(defaults to $PWD/<<inferred-name>>)</>"))
.value_hint(ValueHint::FilePath)
.help_heading(COMPILE_HEADING),
)
.arg(
Arg::new("target")
.long("target")
.help("Target OS architecture")
.value_parser([
"x86_64-unknown-linux-gnu",
"aarch64-unknown-linux-gnu",
"x86_64-pc-windows-msvc",
"x86_64-apple-darwin",
"aarch64-apple-darwin",
])
.help_heading(COMPILE_HEADING),
)
.arg(
Arg::new("no-terminal")
.long("no-terminal")
.help("Hide terminal on Windows")
.action(ArgAction::SetTrue)
.help_heading(COMPILE_HEADING),
)
.arg(
Arg::new("icon")
.long("icon")
.help("Set the icon of the executable on Windows (.ico)")
.value_parser(value_parser!(String))
.help_heading(COMPILE_HEADING),
)
.arg(executable_ext_arg())
.arg(env_file_arg())
.arg(
script_arg()
.required_unless_present("help")
.trailing_var_arg(true),
)
})
}
2023-03-26 00:06:18 -04:00
fn completions_subcommand() -> Command {
command(
"completions",
"Output shell completion script to standard output.
2021-04-18 09:12:55 -04:00
deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash",
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd.disable_help_subcommand(true).arg(
Arg::new("shell")
.value_parser(["bash", "fish", "powershell", "zsh", "fig"])
.required_unless_present("help"),
)
})
2020-11-30 14:35:12 -05:00
}
2023-03-26 00:06:18 -04:00
fn coverage_subcommand() -> Command {
command(
"coverage",
"Print coverage reports from coverage profiles.
Collect a coverage profile with deno test:
deno test --coverage=cov_profile
Print a report to stdout:
deno coverage cov_profile
Include urls that start with the file schema:
deno coverage --include=\"^file:\" cov_profile
Exclude urls ending with test.ts and test.js:
deno coverage --exclude=\"test\\.(ts|js)\" cov_profile
2019-05-23 14:57:44 -04:00
Include urls that start with the file schema and exclude files ending with
test.ts and test.js, for an url to match it must match the include pattern and
2022-04-11 01:01:02 -04:00
not match the exclude pattern:
deno coverage --include=\"^file:\" --exclude=\"test\\.(ts|js)\" cov_profile
Write a report using the lcov format:
deno coverage --lcov --output=cov.lcov cov_profile/
Generate html reports from lcov:
genhtml -o html_cov cov.lcov
",
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd
.arg(
Arg::new("ignore")
.long("ignore")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Ignore coverage files")
.value_hint(ValueHint::AnyPath),
)
.arg(
Arg::new("include")
.long("include")
.num_args(1..)
.action(ArgAction::Append)
.value_name("regex")
.require_equals(true)
.default_value(r"^file:")
.help("Include source files in the report"),
)
.arg(
Arg::new("exclude")
.long("exclude")
.num_args(1..)
.action(ArgAction::Append)
.value_name("regex")
.require_equals(true)
.default_value(r"test\.(js|mjs|ts|jsx|tsx)$")
.help("Exclude source files from the report"),
)
.arg(
Arg::new("lcov")
.long("lcov")
.help("Output coverage report in lcov format")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("output")
.requires("lcov")
.long("output")
.value_parser(value_parser!(String))
.help(
cstr!("Exports the coverage report in lcov format to the given file.
<p(245)>If no --output arg is specified then the report is written to stdout.</>",
))
.require_equals(true)
.value_hint(ValueHint::FilePath),
)
.arg(
Arg::new("html")
.long("html")
.help("Output coverage report in HTML format in the given directory")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("detailed")
.long("detailed")
.help("Output coverage report in detailed format in the terminal")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("files")
.num_args(0..)
.action(ArgAction::Append)
.value_hint(ValueHint::AnyPath),
)
})
}
2023-03-26 00:06:18 -04:00
fn doc_subcommand() -> Command {
command("doc",
"Show documentation for a module.
Output documentation to standard output:
deno doc ./path/to/module.ts
Output documentation in HTML format:
deno doc --html --name=\"My library\" ./path/to/module.ts
deno doc --html --name=\"My library\" ./main.ts ./dev.ts
deno doc --html --name=\"My library\" --output=./documentation/ ./path/to/module.ts
Output private documentation to standard output:
deno doc --private ./path/to/module.ts
Output documentation in JSON format:
deno doc --json ./path/to/module.ts
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
Lint a module for documentation diagnostics:
deno doc --lint ./path/to/module.ts
Target a specific symbol:
deno doc ./path/to/module.ts MyClass.someField
Show documentation for runtime built-ins:
deno doc
deno doc --filter Deno.Listener",
UnstableArgsConfig::ResolutionOnly
)
.defer(|cmd| {
cmd
.arg(import_map_arg())
.arg(reload_arg())
.arg(lock_arg())
.arg(no_lock_arg())
.arg(no_npm_arg())
.arg(no_remote_arg())
.arg(
Arg::new("json")
.long("json")
.help("Output documentation in JSON format")
.action(ArgAction::SetTrue)
.help_heading(DOC_HEADING),
)
.arg(
Arg::new("html")
.long("html")
.help("Output documentation in HTML format")
.action(ArgAction::SetTrue)
.display_order(1000)
.conflicts_with("json").help_heading(DOC_HEADING)
)
.arg(
Arg::new("name")
.long("name")
.help("The name that will be used in the docs (ie for breadcrumbs)")
.action(ArgAction::Set)
.require_equals(true).help_heading(DOC_HEADING)
)
2024-06-28 08:03:51 -04:00
.arg(
Arg::new("category-docs")
.long("category-docs")
.help("Path to a JSON file keyed by category and an optional value of a markdown doc")
.requires("html")
.action(ArgAction::Set)
.require_equals(true).help_heading(DOC_HEADING)
2024-06-28 08:03:51 -04:00
)
.arg(
Arg::new("symbol-redirect-map")
.long("symbol-redirect-map")
.help("Path to a JSON file keyed by file, with an inner map of symbol to an external link")
.requires("html")
.action(ArgAction::Set)
.require_equals(true).help_heading(DOC_HEADING)
2024-06-28 08:03:51 -04:00
)
.arg(
Arg::new("strip-trailing-html")
.long("strip-trailing-html")
.help("Remove trailing .html from various links. Will still generate files with a .html extension")
2024-06-28 08:03:51 -04:00
.requires("html")
.action(ArgAction::SetTrue).help_heading(DOC_HEADING)
2024-06-28 08:03:51 -04:00
)
.arg(
Arg::new("default-symbol-map")
.long("default-symbol-map")
.help("Uses the provided mapping of default name to wanted name for usage blocks")
2024-06-28 08:03:51 -04:00
.requires("html")
.action(ArgAction::Set)
.require_equals(true).help_heading(DOC_HEADING)
2024-06-28 08:03:51 -04:00
)
.arg(
Arg::new("output")
.long("output")
.help("Directory for HTML documentation output")
.action(ArgAction::Set)
.require_equals(true)
.value_hint(ValueHint::DirPath)
.value_parser(value_parser!(String)).help_heading(DOC_HEADING)
)
.arg(
Arg::new("private")
.long("private")
.help("Output private documentation")
.action(ArgAction::SetTrue).help_heading(DOC_HEADING),
)
.arg(
Arg::new("filter")
.long("filter")
.help("Dot separated path to symbol")
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
.conflicts_with("json")
.conflicts_with("lint")
.conflicts_with("html").help_heading(DOC_HEADING),
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
)
.arg(
Arg::new("lint")
.long("lint")
.help("Output documentation diagnostics.")
.action(ArgAction::SetTrue).help_heading(DOC_HEADING),
)
// TODO(nayeemrmn): Make `--builtin` a proper option. Blocked by
// https://github.com/clap-rs/clap/issues/1794. Currently `--builtin` is
// just a possible value of `source_file` so leading hyphens must be
// enabled.
.allow_hyphen_values(true)
.arg(
Arg::new("source_file")
.num_args(1..)
.action(ArgAction::Append)
.value_hint(ValueHint::FilePath)
.required_if_eq_any([("html", "true"), ("lint", "true")]),
)
})
}
2023-03-26 00:06:18 -04:00
fn eval_subcommand() -> Command {
command("eval",
"Evaluate JavaScript from the command line.
2021-04-18 09:12:55 -04:00
deno eval \"console.log('hello world')\"
To evaluate as TypeScript:
deno eval --ext=ts \"const v: string = 'hello'; console.log(v)\"
This command has implicit access to all permissions (--allow-all).",
UnstableArgsConfig::ResolutionAndRuntime,
)
.defer(|cmd| {
2024-08-12 11:55:33 -04:00
runtime_args(cmd, false, true)
.arg(check_arg(false))
.arg(
// TODO(@satyarohith): remove this argument in 2.0.
Arg::new("ts")
.conflicts_with("ext")
.long("ts")
.short('T')
.help("deprecated: Use `--ext=ts` instead. The `--ts` and `-T` flags are deprecated and will be removed in Deno 2.0.")
.action(ArgAction::SetTrue)
.hide(true),
)
.arg(executable_ext_arg())
.arg(
Arg::new("print")
.long("print")
.short('p')
.help("print result to stdout")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("code_arg")
.num_args(1..)
.action(ArgAction::Append)
.help("Code to evaluate")
.value_name("CODE_ARG")
.required_unless_present("help"),
)
.arg(env_file_arg())
})
}
2023-03-26 00:06:18 -04:00
fn fmt_subcommand() -> Command {
command(
"fmt",
"Auto-format JavaScript, TypeScript, Markdown, and JSON files.
2021-04-18 09:12:55 -04:00
deno fmt
deno fmt myfile1.ts myfile2.ts
deno fmt --check
Format stdin and write to stdout:
cat file.ts | deno fmt -
Ignore formatting code by preceding it with an ignore comment:
// deno-fmt-ignore
Ignore formatting a file by adding an ignore comment at the top of the file:
// deno-fmt-ignore-file",
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd
.arg(config_arg())
.arg(no_config_arg())
.arg(
Arg::new("check")
.long("check")
.help("Check if the source files are formatted")
.num_args(0)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("ext")
.long("ext")
.help("Set content type of the supplied file")
// prefer using ts for formatting instead of js because ts works in more scenarios
.default_value("ts")
.value_parser([
"ts", "tsx", "js", "jsx", "md", "json", "jsonc", "css", "scss",
"sass", "less", "html", "svelte", "vue", "astro", "yml", "yaml",
"ipynb",
])
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("ignore")
.long("ignore")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Ignore formatting particular source files")
.value_hint(ValueHint::AnyPath)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("files")
.num_args(1..)
.action(ArgAction::Append)
.value_hint(ValueHint::AnyPath),
)
.arg(watch_arg(false))
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
.arg(
Arg::new("use-tabs")
.long("use-tabs")
.alias("options-use-tabs")
.num_args(0..=1)
.value_parser(value_parser!(bool))
.default_missing_value("true")
.require_equals(true)
.help(
cstr!( "Use tabs instead of spaces for indentation <p(245)>[default: false]</>"),
)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("line-width")
.long("line-width")
.alias("options-line-width")
.help(cstr!("Define maximum line width <p(245)>[default: 80]</>"))
.value_parser(value_parser!(NonZeroU32))
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("indent-width")
.long("indent-width")
.alias("options-indent-width")
.help(cstr!("Define indentation width <p(245)>[default: 2]</>"))
.value_parser(value_parser!(NonZeroU8))
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("single-quote")
.long("single-quote")
.alias("options-single-quote")
.num_args(0..=1)
.value_parser(value_parser!(bool))
.default_missing_value("true")
.require_equals(true)
.help(cstr!("Use single quotes <p(245)>[default: false]</>"))
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("prose-wrap")
.long("prose-wrap")
.alias("options-prose-wrap")
.value_parser(["always", "never", "preserve"])
.help(cstr!("Define how prose should be wrapped <p(245)>[default: always]</>"))
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("no-semicolons")
.long("no-semicolons")
.alias("options-no-semicolons")
.num_args(0..=1)
.value_parser(value_parser!(bool))
.default_missing_value("true")
.require_equals(true)
.help(
cstr!("Don't use semicolons except where necessary <p(245)>[default: false]</>"),
)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("unstable-css")
.long("unstable-css")
.help("Enable formatting CSS, SCSS, Sass and Less files")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("unstable-html")
.long("unstable-html")
.help("Enable formatting HTML files")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("unstable-component")
.long("unstable-component")
.help("Enable formatting Svelte, Vue, Astro and Angular files")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.help_heading(FMT_HEADING),
)
.arg(
Arg::new("unstable-yaml")
.long("unstable-yaml")
.help("Enable formatting YAML files")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.help_heading(FMT_HEADING),
)
})
}
2019-08-15 10:11:52 -04:00
2023-03-26 00:06:18 -04:00
fn init_subcommand() -> Command {
command("init", "Initialize a new project", UnstableArgsConfig::None).defer(
|cmd| {
cmd
.arg(Arg::new("dir").value_hint(ValueHint::DirPath))
.arg(
Arg::new("lib")
.long("lib")
.help("Generate an example library project")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("serve")
.long("serve")
.help("Generate an example project for `deno serve`")
.conflicts_with("lib")
.action(ArgAction::SetTrue),
)
},
)
}
2023-03-26 00:06:18 -04:00
fn info_subcommand() -> Command {
command("info",
2024-08-12 11:55:33 -04:00
"Information about a module or the cache directories.
Get information about a module:
deno info jsr:@std/http/file-server
The following information is shown:
local: Local path of the file.
type: JavaScript, TypeScript, or JSON.
emit: Local path of compiled source code. (TypeScript only.)
dependencies: Dependency tree of the source file.
Without any additional arguments, 'deno info' shows:
DENO_DIR: Directory containing Deno-managed files.
Remote modules cache: Subdirectory containing downloaded remote modules.
TypeScript compiler cache: Subdirectory containing TS compiler output.",
UnstableArgsConfig::ResolutionOnly
2024-08-12 11:55:33 -04:00
)
.defer(|cmd| cmd
.arg(Arg::new("file").value_hint(ValueHint::FilePath))
.arg(reload_arg().requires("file"))
.arg(ca_file_arg())
.arg(unsafely_ignore_certificate_errors_arg())
.arg(
location_arg()
.conflicts_with("file")
.help("Show files used for origin bound APIs like the Web Storage API when running a script with '--location=<HREF>'")
)
.arg(no_check_arg().hide(true)) // TODO(lucacasonato): remove for 2.0
.arg(no_config_arg())
.arg(no_remote_arg())
.arg(no_npm_arg())
.arg(lock_arg())
.arg(no_lock_arg())
.arg(config_arg())
.arg(import_map_arg())
.arg(node_modules_dir_arg())
.arg(vendor_arg())
.arg(
Arg::new("json")
.long("json")
.help("UNSTABLE: Outputs the information in JSON format")
.action(ArgAction::SetTrue),
))
}
2019-08-15 10:11:52 -04:00
fn install_args(cmd: Command, deno_future: bool) -> Command {
let cmd = if deno_future {
cmd.arg(
Arg::new("cmd")
.required_if_eq("global", "true")
.num_args(1..)
.value_hint(ValueHint::FilePath),
)
} else {
cmd.arg(
Arg::new("cmd")
.required_unless_present("help")
.num_args(1..)
.value_hint(ValueHint::FilePath),
)
};
cmd
.arg(
Arg::new("name")
.long("name")
.short('n')
.help("Executable file name"),
)
.arg(
Arg::new("root")
.long("root")
.help("Installation root")
.value_hint(ValueHint::DirPath),
)
.arg(
Arg::new("force")
.long("force")
.short('f')
.help("Forcefully overwrite existing installation")
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("global")
.long("global")
.short('g')
.help("Install a package or script as a globally available executable")
.action(ArgAction::SetTrue),
)
.arg(env_file_arg())
}
fn future_install_subcommand() -> Command {
command("install", "Installs dependencies either in the local project or globally to a bin directory.
Local installation
-------------------
If the --global flag is not set, adds dependencies to the local project's configuration
(package.json / deno.json) and installs them in the package cache. If no dependency
is specified, installs all dependencies listed in package.json.
deno install
deno install @std/bytes
deno install npm:chalk
Global installation
-------------------
If the --global flag is set, installs a script as an executable in the installation root's bin directory.
deno install --global --allow-net --allow-read jsr:@std/http/file-server
deno install -g https://examples.deno.land/color-logging.ts
To change the executable name, use -n/--name:
deno install -g --allow-net --allow-read -n serve jsr:@std/http/file-server
The executable name is inferred by default:
- Attempt to take the file stem of the URL path. The above example would
become 'file_server'.
- If the file stem is something generic like 'main', 'mod', 'index' or 'cli',
and the path has no parent, take the file name of the parent path. Otherwise
settle with the generic name.
- If the resulting name has an '@...' suffix, strip it.
To change the installation root, use --root:
deno install -g --allow-net --allow-read --root /usr/local jsr:@std/http/file-server
The installation root is determined, in order of precedence:
- --root option
- DENO_INSTALL_ROOT environment variable
- $HOME/.deno
These must be added to the path manually if required.", UnstableArgsConfig::ResolutionAndRuntime)
.visible_alias("i")
.defer(|cmd| {
2024-08-12 11:55:33 -04:00
let cmd = runtime_args(cmd, true, true).arg(check_arg(true)).arg(allow_scripts_arg());
install_args(cmd, true)
})
}
2023-03-26 00:06:18 -04:00
fn install_subcommand() -> Command {
command("install",
2024-08-12 11:55:33 -04:00
"Installs a script as an executable in the installation root's bin directory.
2021-04-18 09:12:55 -04:00
deno install --global --allow-net --allow-read jsr:@std/http/file-server
deno install -g https://examples.deno.land/color-logging.ts
To change the executable name, use -n/--name:
deno install -g --allow-net --allow-read -n serve jsr:@std/http/file-server
The executable name is inferred by default:
- Attempt to take the file stem of the URL path. The above example would
become 'file_server'.
- If the file stem is something generic like 'main', 'mod', 'index' or 'cli',
and the path has no parent, take the file name of the parent path. Otherwise
settle with the generic name.
- If the resulting name has an '@...' suffix, strip it.
2019-05-03 17:15:16 -04:00
To change the installation root, use --root:
deno install -g --allow-net --allow-read --root /usr/local jsr:@std/http/file-server
The installation root is determined, in order of precedence:
- --root option
- DENO_INSTALL_ROOT environment variable
- $HOME/.deno
These must be added to the path manually if required.", UnstableArgsConfig::ResolutionAndRuntime)
.defer(|cmd| {
2024-08-12 11:55:33 -04:00
let cmd = runtime_args(cmd, true, true).arg(check_arg(true));
install_args(cmd, false)
})
}
2024-08-12 11:55:33 -04:00
fn json_reference_subcommand() -> Command {
Command::new("json_reference").hide(true)
}
fn jupyter_subcommand() -> Command {
Command::new("jupyter")
.arg(
Arg::new("install")
.long("install")
.help("Installs kernelspec, requires 'jupyter' command to be available.")
.conflicts_with("kernel")
.action(ArgAction::SetTrue)
)
.arg(
Arg::new("kernel")
.long("kernel")
.help("Start the kernel")
.conflicts_with("install")
.requires("conn")
.action(ArgAction::SetTrue)
)
.arg(
Arg::new("conn")
.long("conn")
.help("Path to JSON file describing connection parameters, provided by Jupyter")
.value_parser(value_parser!(String))
.value_hint(ValueHint::FilePath)
.conflicts_with("install"))
.about("Deno kernel for Jupyter notebooks")
}
fn uninstall_subcommand() -> Command {
command(
"uninstall",
"Uninstalls an executable script in the installation root's bin directory.
deno uninstall serve
To change the installation root, use --root:
deno uninstall --root /usr/local serve
The installation root is determined, in order of precedence:
- --root option
- DENO_INSTALL_ROOT environment variable
- $HOME/.deno",
UnstableArgsConfig::None,
)
.defer(|cmd| {
cmd
.arg(Arg::new("name").required_unless_present("help"))
.arg(
Arg::new("root")
.long("root")
.help("Installation root")
.value_hint(ValueHint::DirPath),
)
.arg(
Arg::new("global")
.long("global")
.short('g')
.help("Remove globally installed package or module")
.action(ArgAction::SetTrue),
)
})
}
fn lsp_subcommand() -> Command {
Command::new("lsp").about(
"The 'deno lsp' subcommand provides a way for code editors and IDEs to
interact with Deno using the Language Server Protocol. Usually humans do not
use this subcommand directly. For example, 'deno lsp' can provide IDEs with
go-to-definition support and automatic code formatting.
How to connect various editors and IDEs to 'deno lsp':
https://docs.deno.com/go/lsp",
)
}
2023-03-26 00:06:18 -04:00
fn lint_subcommand() -> Command {
command(
"lint",
"Lint JavaScript/TypeScript source code.
2021-04-18 09:12:55 -04:00
deno lint
deno lint myfile1.ts myfile2.js
Print result as JSON:
deno lint --json
Read from stdin:
cat file.ts | deno lint -
cat file.ts | deno lint --json -
List available rules:
deno lint --rules
Ignore diagnostics on the next line by preceding it with an ignore comment and
rule name:
2021-04-18 09:12:55 -04:00
// deno-lint-ignore no-explicit-any
// deno-lint-ignore require-await no-empty
Names of rules to ignore must be specified after ignore comment.
Ignore linting a file by adding an ignore comment at the top of the file:
// deno-lint-ignore-file
",
UnstableArgsConfig::ResolutionOnly,
)
.defer(|cmd| {
cmd
.arg(
Arg::new("fix")
.long("fix")
.help("Fix any linting errors for rules that support it")
.action(ArgAction::SetTrue)
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("ext")
.long("ext")
.require_equals(true)
.value_name("EXT")
.help("Specify the file extension to lint when reading from stdin.\
For example, use `jsx` to lint JSX files or `tsx` for TSX files.\
This argument is necessary because stdin input does not automatically infer the file type.\
Example usage: `cat file.jsx | deno lint - --ext=jsx`."),
)
.arg(
Arg::new("rules")
.long("rules")
.help("List available rules")
.action(ArgAction::SetTrue)
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("rules-tags")
.long("rules-tags")
.require_equals(true)
.num_args(1..)
.action(ArgAction::Append)
.use_value_delimiter(true)
.help("Use set of rules with a tag")
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("rules-include")
.long("rules-include")
.require_equals(true)
.num_args(1..)
.use_value_delimiter(true)
.conflicts_with("rules")
.help("Include lint rules")
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("rules-exclude")
.long("rules-exclude")
.require_equals(true)
.num_args(1..)
.use_value_delimiter(true)
.conflicts_with("rules")
.help("Exclude lint rules")
.help_heading(LINT_HEADING),
)
.arg(no_config_arg())
.arg(config_arg())
.arg(
Arg::new("ignore")
.long("ignore")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Ignore linting particular source files")
.value_hint(ValueHint::AnyPath)
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("json")
.long("json")
.help("Output lint result in JSON format")
.action(ArgAction::SetTrue)
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("compact")
.long("compact")
.help("Output lint result in compact format")
.action(ArgAction::SetTrue)
.conflicts_with("json")
.help_heading(LINT_HEADING),
)
.arg(
Arg::new("files")
.num_args(1..)
.action(ArgAction::Append)
.value_hint(ValueHint::AnyPath),
)
.arg(watch_arg(false))
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
})
}
2019-05-16 10:39:19 -04:00
2023-03-26 00:06:18 -04:00
fn repl_subcommand() -> Command {
command("repl", "Read Eval Print Loop", UnstableArgsConfig::ResolutionAndRuntime)
2024-08-12 11:55:33 -04:00
.defer(|cmd| runtime_args(cmd, true, true)
.arg(check_arg(false))
.arg(
Arg::new("eval-file")
.long("eval-file")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Evaluates the provided file(s) as scripts when the REPL starts. Accepts file paths and URLs")
.value_hint(ValueHint::AnyPath),
)
.arg(
Arg::new("eval")
.long("eval")
.help("Evaluates the provided code when the REPL starts")
.value_name("code"),
)
.after_help(cstr!("<y>Environment variables:</>
<g>DENO_REPL_HISTORY</> Set REPL history file path. History file is disabled when the value is empty.
<p(245)>[default: $DENO_DIR/deno_history.txt]</>"))
)
2024-08-12 11:55:33 -04:00
.arg(env_file_arg())
}
fn run_args(command: Command, top_level: bool) -> Command {
2024-08-12 11:55:33 -04:00
runtime_args(command, true, true)
.arg(check_arg(false))
.arg(watch_arg(true))
.arg(hmr_arg(true))
.arg(watch_exclude_arg())
2024-08-12 11:55:33 -04:00
.arg(no_clear_screen_arg())
.arg(executable_ext_arg())
.arg(if top_level {
script_arg().trailing_var_arg(true).hide(true)
} else {
script_arg().trailing_var_arg(true)
})
2024-08-12 11:55:33 -04:00
.arg(env_file_arg())
.arg(no_code_cache_arg())
}
fn run_subcommand() -> Command {
run_args(command("run", cstr!("Run a JavaScript or TypeScript program, or a task or script.
2021-04-18 09:12:55 -04:00
2024-08-12 11:55:33 -04:00
By default all programs are run in sandbox without access to disk, network or ability to spawn subprocesses.
<p(245)>deno run https://examples.deno.land/hello-world.ts</>
Grant permission to read from disk and listen to network:
2024-08-12 11:55:33 -04:00
<p(245)>deno run --allow-read --allow-net jsr:@std/http/file-server</>
Grant permission to read allow-listed files from disk:
2024-08-12 11:55:33 -04:00
<p(245)>deno run --allow-read=/etc jsr:@std/http/file-server</>
2021-04-18 09:12:55 -04:00
2024-08-12 11:55:33 -04:00
Grant all permissions:
<p(245)>deno run -A jsr:@std/http/file-server</>
2022-04-11 01:01:02 -04:00
Specifying the filename '-' to read the file from stdin.
<p(245)>curl https://examples.deno.land/hello-world.ts | deno run -</>"), UnstableArgsConfig::ResolutionAndRuntime), false)
}
fn serve_host_validator(host: &str) -> Result<String, String> {
if Url::parse(&format!("internal://{host}:9999")).is_ok() {
Ok(host.to_owned())
} else {
Err(format!("Bad serve host: {host}"))
}
}
fn serve_subcommand() -> Command {
runtime_args(command("serve", None, UnstableArgsConfig::ResolutionAndRuntime), true, true)
.arg(
Arg::new("port")
.long("port")
.help("The TCP port to serve on, defaulting to 8000. Pass 0 to pick a random free port")
.value_parser(value_parser!(u16)),
)
.arg(
Arg::new("host")
.long("host")
.help("The TCP address to serve on, defaulting to 0.0.0.0 (all interfaces)")
.value_parser(serve_host_validator),
)
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
.arg(
parallel_arg("multiple server workers", false)
)
.arg(check_arg(false))
.arg(watch_arg(true))
.arg(hmr_arg(true))
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
.arg(executable_ext_arg())
.arg(
script_arg()
.required_unless_present_any(["help", "v8-flags"])
.trailing_var_arg(true),
)
.arg(env_file_arg())
.arg(no_code_cache_arg())
2024-08-12 11:55:33 -04:00
.about("Run a server defined in a main module
The serve command uses the default exports of the main module to determine which
servers to start.
See https://docs.deno.com/runtime/manual/tools/serve for
more detailed information.
Start a server defined in server.ts:
deno serve server.ts
Start a server defined in server.ts, watching for changes and running on port 5050:
deno serve --watch --port 5050 server.ts")
}
2023-03-26 00:06:18 -04:00
fn task_subcommand() -> Command {
command(
"task",
"Run a task defined in the configuration file
deno task build",
UnstableArgsConfig::ResolutionAndRuntime,
)
.defer(|cmd| {
cmd
.allow_external_subcommands(true)
.subcommand_value_name("TASK")
.arg(config_arg())
.arg(
Arg::new("cwd")
.long("cwd")
.value_name("DIR")
.help("Specify the directory to run the task in")
.value_hint(ValueHint::DirPath),
)
})
}
2023-03-26 00:06:18 -04:00
fn test_subcommand() -> Command {
command("test",
"Run tests using Deno's built-in test runner.
Evaluate the given modules, run all tests declared with 'Deno.test()' and
report results to standard output:
deno test src/fetch_test.ts src/signal_test.ts
Directory arguments are expanded to all contained files matching the glob
{*_,*.,}test.{js,mjs,ts,mts,jsx,tsx} or **/__tests__/**:
deno test src/",
UnstableArgsConfig::ResolutionAndRuntime
)
.defer(|cmd|
runtime_args(cmd, true, true)
2024-08-12 11:55:33 -04:00
.arg(check_arg(true))
.arg(
Arg::new("ignore")
.long("ignore")
.num_args(1..)
.use_value_delimiter(true)
.require_equals(true)
.help("Ignore files")
.value_hint(ValueHint::AnyPath),
)
.arg(
Arg::new("no-run")
.long("no-run")
.help("Cache test modules, but don't run tests")
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("trace-ops")
.long("trace-ops")
.help("Deprecated alias for --trace-leaks")
2024-08-12 11:55:33 -04:00
.hide(true)
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("trace-leaks")
.long("trace-leaks")
.help("Enable tracing of leaks. Useful when debugging leaking ops in test, but impacts test execution time")
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("doc")
.long("doc")
.help("Type-check code blocks in JSDoc and Markdown")
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("fail-fast")
.long("fail-fast")
.alias("failfast")
.help("Stop after N errors. Defaults to stopping after first failure")
2024-08-12 11:55:33 -04:00
.num_args(0..=1)
.require_equals(true)
.value_name("N")
.value_parser(value_parser!(NonZeroUsize))
.help_heading(TEST_HEADING))
2024-08-12 11:55:33 -04:00
// TODO(@lucacasonato): remove for Deno 2.0
.arg(
Arg::new("allow-none")
.long("allow-none")
.help("Don't return error code if no test files are found")
.hide(true)
.action(ArgAction::SetTrue),
)
.arg(
Arg::new("permit-no-files")
.long("permit-no-files")
.help("Don't return an error code if no test files were found")
.conflicts_with("allow-none")
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("filter")
.allow_hyphen_values(true)
.long("filter")
.help("Run tests with this string or regexp pattern in the test name")
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("shuffle")
.long("shuffle")
.value_name("NUMBER")
.help("Shuffle the order in which the tests are run")
.num_args(0..=1)
.require_equals(true)
.value_parser(value_parser!(u64))
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("coverage")
.long("coverage")
.value_name("DIR")
.num_args(0..=1)
.require_equals(true)
.default_missing_value("coverage")
.conflicts_with("inspect")
.conflicts_with("inspect-wait")
.conflicts_with("inspect-brk")
.help("Collect coverage profile data into DIR. If DIR is not specified, it uses 'coverage/'")
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("clean")
.long("clean")
.help(cstr!("Empty the temporary coverage profile data directory before running tests.
<p(245)>Note: running multiple `deno test --clean` calls in series or parallel for the same coverage directory may cause race conditions.</>"))
.action(ArgAction::SetTrue)
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
parallel_arg("test modules", true)
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("jobs")
.short('j')
.long("jobs")
.help("deprecated: The `--jobs` flag is deprecated and will be removed in Deno 2.0. Use the `--parallel` flag with possibly the `DENO_JOBS` environment variable instead.")
.hide(true)
.num_args(0..=1)
.value_parser(value_parser!(NonZeroUsize))
.help_heading(TEST_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("files")
.help("List of file names to run")
.num_args(0..)
.action(ArgAction::Append)
.value_hint(ValueHint::AnyPath),
)
.arg(
watch_arg(true)
2024-08-12 11:55:33 -04:00
.conflicts_with("no-run")
.conflicts_with("coverage"),
)
.arg(watch_exclude_arg())
.arg(no_clear_screen_arg())
.arg(script_arg().last(true))
.arg(
Arg::new("junit-path")
.long("junit-path")
.value_name("PATH")
.value_hint(ValueHint::FilePath)
.help("Write a JUnit XML test report to PATH. Use '-' to write to stdout which is the default when PATH is not provided")
.help_heading(TEST_HEADING)
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("reporter")
.long("reporter")
.help("Select reporter to use. Default to 'pretty'")
2024-08-12 11:55:33 -04:00
.value_parser(["pretty", "dot", "junit", "tap"])
.help_heading(TEST_HEADING)
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("hide-stacktraces")
.long("hide-stacktraces")
.help("Hide stack traces for errors in failure test results.")
.action(ArgAction::SetTrue)
)
2024-08-12 11:55:33 -04:00
.arg(env_file_arg())
)
2019-06-05 13:44:46 -04:00
}
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
fn parallel_arg(descr: &str, jobs_fallback: bool) -> Arg {
let arg = Arg::new("parallel")
.long("parallel")
.help(format!("Run {descr} in parallel. Parallelism defaults to the number of available CPUs or the value of the DENO_JOBS environment variable"))
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
.action(ArgAction::SetTrue);
if jobs_fallback {
arg.conflicts_with("jobs")
} else {
arg
}
}
2023-03-26 00:06:18 -04:00
fn types_subcommand() -> Command {
command(
"types",
2024-08-12 11:55:33 -04:00
"Print runtime TypeScript declarations.
2021-04-18 09:12:55 -04:00
deno types > lib.deno.d.ts
The declaration file could be saved and used for typing information.",
UnstableArgsConfig::None,
2024-08-12 11:55:33 -04:00
)
}
2023-03-26 00:06:18 -04:00
fn upgrade_subcommand() -> Command {
command(
"upgrade",
color_print::cstr!("<g>Upgrade</> deno executable to the given version.
<g>Latest</>
deno upgrade
<g>Specific version</>
deno upgrade <p(245)>1.45.0</>
deno upgrade <p(245)>1.46.0-rc.1</>
deno upgrade <p(245)>9bc2dd29ad6ba334fd57a20114e367d3c04763d4</>
<g>Channel</>
deno upgrade <p(245)>stable</>
deno upgrade <p(245)>rc</>
deno upgrade <p(245)>canary</>
The version is downloaded from
https://github.com/denoland/deno/releases
and is used to replace the current executable.
If you want to not replace the current Deno executable but instead download an
2024-08-12 11:55:33 -04:00
update to a different location, use the --output flag:
deno upgrade --output $HOME/my_deno"),
UnstableArgsConfig::None,
)
.hide(cfg!(not(feature = "upgrade")))
.defer(|cmd| {
cmd
.arg(
Arg::new("version")
.long("version")
.help("The version to upgrade to")
.help_heading(UPGRADE_HEADING)// NOTE(bartlomieju): pre-v1.46 compat
.hide(true),
)
.arg(
Arg::new("output")
.long("output")
.help("The path to output the updated version to")
.value_parser(value_parser!(String))
.value_hint(ValueHint::FilePath)
.help_heading(UPGRADE_HEADING),
)
.arg(
Arg::new("dry-run")
.long("dry-run")
.help("Perform all checks without replacing old exe")
.action(ArgAction::SetTrue)
.help_heading(UPGRADE_HEADING),
)
.arg(
Arg::new("force")
.long("force")
.short('f')
.help("Replace current exe even if not out-of-date")
.action(ArgAction::SetTrue)
.help_heading(UPGRADE_HEADING),
)
.arg(
Arg::new("canary")
.long("canary")
.help("Upgrade to canary builds")
.action(ArgAction::SetTrue)
.help_heading(UPGRADE_HEADING)// NOTE(bartlomieju): pre-v1.46 compat
.hide(true),
)
.arg(
Arg::new("release-candidate")
.long("rc")
.help("Upgrade to a release candidate")
.conflicts_with_all(["canary", "version"])
.action(ArgAction::SetTrue)
.help_heading(UPGRADE_HEADING)
// NOTE(bartlomieju): pre-v1.46 compat
.hide(true),
)
.arg(
Arg::new("version-or-hash-or-channel")
.help(color_print::cstr!("Version <p(245)>(v1.46.0)</>, channel <p(245)>(rc, canary)</> or commit hash <p(245)>(9bc2dd29ad6ba334fd57a20114e367d3c04763d4)</>"))
.value_name("VERSION")
.action(ArgAction::Append)
.trailing_var_arg(true),
)
.arg(ca_file_arg())
.arg(unsafely_ignore_certificate_errors_arg())
})
}
// TODO(bartlomieju): this subcommand is now deprecated, remove it in Deno 2.
2023-03-26 00:06:18 -04:00
fn vendor_subcommand() -> Command {
command("vendor",
2024-08-12 11:55:33 -04:00
"⚠️ Warning: `deno vendor` is deprecated and will be removed in Deno 2.0.
Add `\"vendor\": true` to your `deno.json` or use the `--vendor` flag instead.
Vendor remote modules into a local directory.
2022-02-16 13:14:19 -05:00
Analyzes the provided modules along with their dependencies, downloads
remote modules to the output directory, and produces an import map that
maps remote specifiers to the downloaded files.
deno vendor main.ts
deno run --import-map vendor/import_map.json main.ts
Remote modules and multiple modules may also be specified:
deno vendor main.ts test.deps.ts jsr:@std/path",
UnstableArgsConfig::ResolutionOnly
2024-08-12 11:55:33 -04:00
)
.hide(true)
.defer(|cmd| cmd
.arg(
Arg::new("specifiers")
.num_args(1..)
.action(ArgAction::Append)
.required_unless_present("help"),
)
.arg(
Arg::new("output")
.long("output")
.help("The directory to output the vendored modules to")
.value_parser(value_parser!(String))
.value_hint(ValueHint::DirPath),
)
.arg(
Arg::new("force")
.long("force")
.short('f')
.help(
"Forcefully overwrite conflicting files in existing output directory",
)
.action(ArgAction::SetTrue),
)
.arg(no_config_arg())
.arg(config_arg())
.arg(import_map_arg())
.arg(lock_arg())
.arg(node_modules_dir_arg())
.arg(vendor_arg())
.arg(reload_arg())
.arg(ca_file_arg())
.arg(unsafely_ignore_certificate_errors_arg())
)
2022-02-16 13:14:19 -05:00
}
fn publish_subcommand() -> Command {
command("publish", "Publish the current working directory's package or workspace", UnstableArgsConfig::ResolutionOnly)
.defer(|cmd| {
cmd
.arg(
Arg::new("token")
.long("token")
.help("The API token to use when publishing. If unset, interactive authentication is be used")
.help_heading(PUBLISH_HEADING)
)
2024-08-12 11:55:33 -04:00
.arg(config_arg())
.arg(no_config_arg())
.arg(
Arg::new("dry-run")
.long("dry-run")
.help("Prepare the package for publishing performing all checks and validations without uploading")
.action(ArgAction::SetTrue)
.help_heading(PUBLISH_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("allow-slow-types")
.long("allow-slow-types")
.help("Allow publishing with slow types")
.action(ArgAction::SetTrue)
.help_heading(PUBLISH_HEADING),
2024-08-12 11:55:33 -04:00
)
.arg(
Arg::new("allow-dirty")
.long("allow-dirty")
.help("Allow publishing if the repository has uncommitted changed")
.action(ArgAction::SetTrue)
.help_heading(PUBLISH_HEADING),
2024-08-12 11:55:33 -04:00
).arg(
Arg::new("no-provenance")
.long("no-provenance")
.help(cstr!("Disable provenance attestation.
<p(245)>Enabled by default on Github actions, publicly links the package to where it was built and published from.</>"))
.action(ArgAction::SetTrue)
.help_heading(PUBLISH_HEADING)
)
2024-08-12 11:55:33 -04:00
.arg(check_arg(/* type checks by default */ true))
.arg(no_check_arg())
})
}
2024-08-12 11:55:33 -04:00
fn compile_args(app: Command) -> Command {
compile_args_without_check_args(app.arg(no_check_arg()))
2020-06-08 08:06:20 -04:00
}
2024-08-12 11:55:33 -04:00
fn compile_args_without_check_args(app: Command) -> Command {
app
2024-08-12 11:55:33 -04:00
.arg(import_map_arg())
.arg(no_remote_arg())
.arg(no_npm_arg())
.arg(node_modules_dir_arg())
.arg(vendor_arg())
.arg(config_arg())
.arg(no_config_arg())
.arg(reload_arg())
.arg(lock_arg())
.arg(no_lock_arg())
.arg(ca_file_arg())
.arg(unsafely_ignore_certificate_errors_arg())
}
2024-08-12 11:55:33 -04:00
fn permission_args(app: Command) -> Command {
app
.after_help(cstr!(r#"<y>Permission options:</>
Docs: <c>https://docs.deno.com/go/permissions</>
<g>-A, --allow-all</> Allow all permissions.
<g>--no-prompt</> Always throw if required permission wasn't passed.
<p(245)>Can also be set via the DENO_NO_PROMPT environment variable.</>
<g>-R, --allow-read[=<<PATH>...]</> Allow file system read access. Optionally specify allowed paths.
<p(245)>--allow-read | --allow-read="/etc,/var/log.txt"</>
<g>-W, --allow-write[=<<PATH>...]</> Allow file system write access. Optionally specify allowed paths.
<p(245)>--allow-write | --allow-write="/etc,/var/log.txt"</>
<g>-N, --allow-net[=<<IP_OR_HOSTNAME>...]</> Allow network access. Optionally specify allowed IP addresses and host names, with ports as necessary.
<p(245)>--allow-net | --allow-net="localhost:8080,deno.land"</>
<g>-E, --allow-env[=<<VARIABLE_NAME>...]</> Allow access to environment variables. Optionally specify accessible environment variables.
<p(245)>--allow-env | --allow-env="PORT,HOME,PATH"</>
<g>-S, --allow-sys[=<<API_NAME>...]</> Allow access to OS information. Optionally allow specific APIs by function name.
<p(245)>--allow-sys | --allow-sys="systemMemoryInfo,osRelease"</>
<g>--allow-run[=<<PROGRAM_NAME>...]</> Allow running subprocesses. Optionally specify allowed runnable program names.
<p(245)>--allow-run | --allow-run="whoami,ps"</>
<g>--allow-ffi[=<<PATH>...]</> (Unstable) Allow loading dynamic libraries. Optionally specify allowed directories or files.
<p(245)>--allow-ffi | --allow-ffi="./libfoo.so"</>
<g>--allow-hrtime</> Allow high-resolution time measurement. Note: this can enable timing attacks and fingerprinting.
<p(245)>--allow-hrtime</>
<g> --deny-read[=<<PATH>...]</> Deny file system read access. Optionally specify denied paths.
<p(245)>--deny-read | --deny-read="/etc,/var/log.txt"</>
<g> --deny-write[=<<PATH>...]</> Deny file system write access. Optionally specify denied paths.
<p(245)>--deny-write | --deny-write="/etc,/var/log.txt"</>
<g> --deny-net[=<<IP_OR_HOSTNAME>...]</> Deny network access. Optionally specify defined IP addresses and host names, with ports as necessary.
<p(245)>--deny-net | --deny-net="localhost:8080,deno.land"</>
<g> --deny-env[=<<VARIABLE_NAME>...]</> Deny access to environment variables. Optionally specify inacessible environment variables.
<p(245)>--deny-env | --deny-env="PORT,HOME,PATH"</>
<g>-S, --deny-sys[=<<API_NAME>...]</> Deny access to OS information. Optionally deny specific APIs by function name.
<p(245)>--deny-sys | --deny-sys="systemMemoryInfo,osRelease"</>
<g>--deny-run[=<<PROGRAM_NAME>...]</> Deny running subprocesses. Optionally specify denied runnable program names.
<p(245)>--deny-run | --deny-run="whoami,ps"</>
<g>--deny-ffi[=<<PATH>...]</> (Unstable) Deny loading dynamic libraries. Optionally specify denied directories or files.
<p(245)>--deny-ffi | --deny-ffi="./libfoo.so"</>
<g>--deny-hrtime</> Deny high-resolution time measurement.
<p(245)>--deny-hrtime</>
"#))
.arg(
Arg::new("allow-all")
.short('A')
.long("allow-all")
.action(ArgAction::SetTrue)
.help("Allow all permissions")
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-read")
.long("allow-read")
.short('R')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("Allow file system read access. Optionally specify allowed paths")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
Arg::new("deny-read")
.long("deny-read")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("Deny file system read access. Optionally specify denied paths")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-write")
.long("allow-write")
.short('W')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("Allow file system write access. Optionally specify allowed paths")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
Arg::new("deny-write")
.long("deny-write")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("Deny file system write access. Optionally specify denied paths")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-net")
.long("allow-net")
.short('N')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("IP_OR_HOSTNAME")
.help("Allow network access. Optionally specify allowed IP addresses and host names, with ports as necessary")
.value_parser(flags_net::validator)
.hide(true),
)
.arg(
Arg::new("deny-net")
.long("deny-net")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("IP_OR_HOSTNAME")
.help("Deny network access. Optionally specify denied IP addresses and host names, with ports as necessary")
.value_parser(flags_net::validator)
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-env")
.long("allow-env")
.short('E')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("VARIABLE_NAME")
.help("Allow access to system environment information. Optionally specify accessible environment variables")
2023-03-26 00:06:18 -04:00
.value_parser(|key: &str| {
if key.is_empty() || key.contains(&['=', '\0'] as &[char]) {
return Err(format!("invalid key \"{key}\""));
}
2023-03-26 00:06:18 -04:00
Ok(if cfg!(windows) {
key.to_uppercase()
} else {
key.to_string()
})
})
.hide(true),
)
.arg(
Arg::new("deny-env")
.long("deny-env")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("VARIABLE_NAME")
.help("Deny access to system environment information. Optionally specify accessible environment variables")
.value_parser(|key: &str| {
if key.is_empty() || key.contains(&['=', '\0'] as &[char]) {
return Err(format!("invalid key \"{key}\""));
}
Ok(if cfg!(windows) {
key.to_uppercase()
} else {
key.to_string()
})
})
.hide(true),
)
.arg(
Arg::new("allow-sys")
.long("allow-sys")
.short('S')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("API_NAME")
.help("Allow access to OS information. Optionally allow specific APIs by function name")
.value_parser(|key: &str| parse_sys_kind(key).map(ToString::to_string))
.hide(true),
)
.arg(
Arg::new("deny-sys")
.long("deny-sys")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("API_NAME")
.help("Deny access to OS information. Optionally deny specific APIs by function name")
.value_parser(|key: &str| parse_sys_kind(key).map(ToString::to_string))
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-run")
.long("allow-run")
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PROGRAM_NAME")
.help("Allow running subprocesses. Optionally specify allowed runnable program names")
.hide(true),
)
.arg(
Arg::new("deny-run")
.long("deny-run")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PROGRAM_NAME")
.help("Deny running subprocesses. Optionally specify denied runnable program names")
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-ffi")
.long("allow-ffi")
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("(Unstable) Allow loading dynamic libraries. Optionally specify allowed directories or files")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
Arg::new("deny-ffi")
.long("deny-ffi")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PATH")
.help("(Unstable) Deny loading dynamic libraries. Optionally specify denied directories or files")
.value_parser(value_parser!(String))
.value_hint(ValueHint::AnyPath)
.hide(true),
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("allow-hrtime")
.long("allow-hrtime")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Allow high-resolution time measurement. Note: this can enable timing attacks and fingerprinting")
.hide(true),
)
.arg(
Arg::new("deny-hrtime")
.long("deny-hrtime")
.action(ArgAction::SetTrue)
.help("Deny high-resolution time measurement. Note: this can prevent timing attacks and fingerprinting")
.hide(true),
)
.arg(
Arg::new("no-prompt")
.long("no-prompt")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.hide(true)
.help("Always throw if required permission wasn't passed"),
)
}
fn runtime_args(
app: Command,
include_perms: bool,
include_inspector: bool,
) -> Command {
2024-08-12 11:55:33 -04:00
let app = compile_args(app);
let app = if include_perms {
2024-08-12 11:55:33 -04:00
permission_args(app)
} else {
app
};
let app = if include_inspector {
2024-08-12 11:55:33 -04:00
inspect_args(app)
} else {
app
};
app
2024-08-12 11:55:33 -04:00
.arg(frozen_lockfile_arg())
.arg(cached_only_arg())
.arg(location_arg())
.arg(v8_flags_arg())
.arg(seed_arg())
.arg(enable_testing_features_arg())
.arg(strace_ops_arg())
}
2024-08-12 11:55:33 -04:00
fn inspect_args(app: Command) -> Command {
app
2020-12-11 07:18:30 -05:00
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("inspect")
.long("inspect")
.value_name("HOST_AND_PORT")
.default_missing_value("127.0.0.1:9229")
.help(cstr!("Activate inspector on host:port <p(245)>[default: 127.0.0.1:9229]</>"))
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.require_equals(true)
.value_parser(value_parser!(SocketAddr))
.help_heading(DEBUGGING_HEADING),
2020-12-11 07:18:30 -05:00
)
.arg(
2022-01-14 11:38:17 -05:00
Arg::new("inspect-brk")
.long("inspect-brk")
.value_name("HOST_AND_PORT")
.default_missing_value("127.0.0.1:9229")
.help(
"Activate inspector on host:port, wait for debugger to connect and break at the start of user script",
)
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.require_equals(true)
.value_parser(value_parser!(SocketAddr))
.help_heading(DEBUGGING_HEADING),
)
.arg(
Arg::new("inspect-wait")
.long("inspect-wait")
.value_name("HOST_AND_PORT")
.default_missing_value("127.0.0.1:9229")
.help(
"Activate inspector on host:port and wait for debugger to connect before running user code",
)
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.require_equals(true)
.value_parser(value_parser!(SocketAddr))
.help_heading(DEBUGGING_HEADING),
)
2019-04-29 19:43:06 -04:00
}
2023-03-26 00:06:18 -04:00
fn import_map_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("import-map")
.long("import-map")
.alias("importmap")
.value_name("FILE")
.help(cstr!(
"Load import map file from local file or remote URL
<p(245)>Docs: https://docs.deno.com/runtime/manual/basics/import_maps</>",
))
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::FilePath)
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
fn env_file_arg() -> Arg {
Arg::new("env-file")
.long("env-file")
.alias("env")
.value_name("FILE")
.help(cstr!(
"Load environment variables from local file
<p(245)>Only the first environment variable with a given key is used.
Existing process environment variables are not overwritten.</>"
))
.value_hint(ValueHint::FilePath)
.default_missing_value(".env")
.require_equals(true)
.num_args(0..=1)
}
2023-03-26 00:06:18 -04:00
fn reload_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("reload")
.short('r')
2023-03-26 00:06:18 -04:00
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.long("reload")
.value_name("CACHE_BLOCKLIST")
2024-08-12 11:55:33 -04:00
.help(
cstr!("Reload source code cache (recompile TypeScript)
2024-08-12 11:55:33 -04:00
<p(245)>no value Reload everything
jsr:@std/http/file-server,jsr:@std/assert/assert-equals Reloads specific modules
npm: Reload all npm modules
npm:chalk Reload specific npm module</>",
))
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::FilePath)
2023-03-26 00:06:18 -04:00
.value_parser(reload_arg_validate)
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
2023-03-26 00:06:18 -04:00
fn ca_file_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("cert")
.long("cert")
.value_name("FILE")
.help("Load certificate authority from PEM encoded file")
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::FilePath)
}
2023-03-26 00:06:18 -04:00
fn cached_only_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("cached-only")
.long("cached-only")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Require that remote dependencies are already cached")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
fn frozen_lockfile_arg() -> Arg {
Arg::new("frozen")
.long("frozen")
.alias("frozen-lockfile")
.value_parser(value_parser!(bool))
2024-08-12 11:55:33 -04:00
.value_name("BOOLEAN")
.num_args(0..=1)
.require_equals(true)
.default_missing_value("true")
.help("Error out if lockfile is out of date")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
/// Used for subcommands that operate on executable scripts only.
/// `deno fmt` has its own `--ext` arg because its possible values differ.
/// If --ext is not provided and the script doesn't have a file extension,
/// deno_graph::parse_module() defaults to js.
2023-03-26 00:06:18 -04:00
fn executable_ext_arg() -> Arg {
Arg::new("ext")
.long("ext")
.help("Set content type of the supplied file")
2023-03-26 00:06:18 -04:00
.value_parser(["ts", "tsx", "js", "jsx"])
}
2023-03-26 00:06:18 -04:00
fn location_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("location")
.long("location")
.value_name("HREF")
2023-03-26 00:06:18 -04:00
.value_parser(|href: &str| -> Result<Url, String> {
2022-01-14 11:38:17 -05:00
let url = Url::parse(href);
if url.is_err() {
return Err("Failed to parse URL".to_string());
}
let mut url = url.unwrap();
if !["http", "https"].contains(&url.scheme()) {
return Err("Expected protocol \"http\" or \"https\"".to_string());
}
url.set_username("").unwrap();
url.set_password(None).unwrap();
2023-03-26 00:06:18 -04:00
Ok(url)
})
.help("Value of 'globalThis.location' used by some web APIs")
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::Url)
}
2023-03-26 00:06:18 -04:00
fn enable_testing_features_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("enable-testing-features-do-not-use")
.long("enable-testing-features-do-not-use")
.help("INTERNAL: Enable internal features used during integration testing")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
2022-01-14 11:38:17 -05:00
.hide(true)
}
fn strace_ops_arg() -> Arg {
Arg::new("strace-ops")
.long("strace-ops")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("OPS")
.help("Trace low-level op calls")
.hide(true)
}
2023-03-26 00:06:18 -04:00
fn v8_flags_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("v8-flags")
.long("v8-flags")
2023-03-26 00:06:18 -04:00
.num_args(..)
.use_value_delimiter(true)
.require_equals(true)
2024-08-12 11:55:33 -04:00
.value_name("V8_FLAGS")
.help( cstr!("To see a list of all available flags use --v8-flags=--help
<p(245)>Flags can also be set via the DENO_V8_FLAGS environment variable.
Any flags set with this flag are appended after the DENO_V8_FLAGS environment variable</>"))
}
2023-03-26 00:06:18 -04:00
fn seed_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("seed")
.long("seed")
.value_name("NUMBER")
2022-04-11 01:01:02 -04:00
.help("Set the random number generator seed")
2023-03-26 00:06:18 -04:00
.value_parser(value_parser!(u64))
}
fn hmr_arg(takes_files: bool) -> Arg {
let arg = Arg::new("hmr")
.long("watch-hmr")
// NOTE(bartlomieju): compatibility with Deno pre-1.46
.alias("unstable-hmr")
.help("Watch for file changes and hot replace modules")
.conflicts_with("watch")
.help_heading(FILE_WATCHING_HEADING);
if takes_files {
arg
.value_name("FILES")
.num_args(0..)
.value_parser(value_parser!(String))
.use_value_delimiter(true)
.require_equals(true)
2024-08-12 11:55:33 -04:00
.help(
cstr!(
"Watch for file changes and restart process automatically.
<p(245)>Local files from entry point module graph are watched by default.
Additional paths might be watched by passing them as arguments to this flag.</>"),
)
.value_hint(ValueHint::AnyPath)
} else {
arg.action(ArgAction::SetTrue).help(cstr!(
"Watch for file changes and restart process automatically.
<p(245)>Only local files from entry point module graph are watched.</>"
))
}
}
2023-03-26 00:06:18 -04:00
fn watch_arg(takes_files: bool) -> Arg {
let arg = Arg::new("watch")
.long("watch")
.help_heading(FILE_WATCHING_HEADING);
if takes_files {
arg
.value_name("FILES")
2023-03-26 00:06:18 -04:00
.num_args(0..)
.value_parser(value_parser!(String))
.use_value_delimiter(true)
.require_equals(true)
2024-08-12 11:55:33 -04:00
.help(
cstr!(
"Watch for file changes and restart process automatically.
<p(245)>Local files from entry point module graph are watched by default.
Additional paths might be watched by passing them as arguments to this flag.</>"),
)
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::AnyPath)
} else {
arg.action(ArgAction::SetTrue).help(cstr!(
"Watch for file changes and restart process automatically.
<p(245)>Only local files from entry point module graph are watched.</>"
))
}
}
2023-03-26 00:06:18 -04:00
fn no_clear_screen_arg() -> Arg {
Arg::new("no-clear-screen")
.requires("watch")
.long("no-clear-screen")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Do not clear terminal screen when under watch mode")
.help_heading(FILE_WATCHING_HEADING)
}
fn no_code_cache_arg() -> Arg {
Arg::new("no-code-cache")
.long("no-code-cache")
.help("Disable V8 code cache feature")
.action(ArgAction::SetTrue)
}
fn watch_exclude_arg() -> Arg {
Arg::new("watch-exclude")
.long("watch-exclude")
.help("Exclude provided files/patterns from watch mode")
.value_name("FILES")
.num_args(0..)
.value_parser(value_parser!(String))
.use_value_delimiter(true)
.require_equals(true)
.value_hint(ValueHint::AnyPath)
.help_heading(FILE_WATCHING_HEADING)
}
2023-03-26 00:06:18 -04:00
fn no_check_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("no-check")
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.require_equals(true)
.value_name("NO_CHECK_TYPE")
.long("no-check")
.help("Skip type-checking. If the value of \"remote\" is supplied, diagnostic errors from remote modules will be ignored")
.help_heading(TYPE_CHECKING_HEADING)
}
fn check_arg(checks_local_by_default: bool) -> Arg {
let arg = Arg::new("check")
.conflicts_with("no-check")
.long("check")
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.require_equals(true)
.value_name("CHECK_TYPE")
.help_heading(TYPE_CHECKING_HEADING);
if checks_local_by_default {
2024-08-12 11:55:33 -04:00
arg.help(
cstr!("Set type-checking behavior. This subcommand type-checks local modules by default, so adding --check is redundant
<p(245)>If the value of \"all\" is supplied, remote modules will be included.
Alternatively, the 'deno check' subcommand can be used</>",
))
} else {
arg.help(cstr!(
"Enable type-checking. This subcommand does not type-check by default
<p(245)>If the value of \"all\" is supplied, remote modules will be included.
Alternatively, the 'deno check' subcommand can be used</>"
))
}
}
2023-03-26 00:06:18 -04:00
fn script_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("script_arg")
2023-03-26 00:06:18 -04:00
.num_args(0..)
.action(ArgAction::Append)
// NOTE: these defaults are provided
// so `deno run --v8-flags=--help` works
// without specifying file to run.
2023-03-26 00:06:18 -04:00
.default_value_ifs([
("v8-flags", "--help", Some("_")),
("v8-flags", "-help", Some("_")),
])
.help("Script arg")
.value_name("SCRIPT_ARG")
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::FilePath)
}
2023-03-26 00:06:18 -04:00
fn lock_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("lock")
.long("lock")
.value_name("FILE")
2024-08-12 11:55:33 -04:00
.default_missing_value("./deno.lock")
.help("Check the specified lock file. (If value is not provided, defaults to \"./deno.lock\")")
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.value_parser(value_parser!(String))
2022-03-14 14:41:35 -04:00
.value_hint(ValueHint::FilePath)
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
2023-03-26 00:06:18 -04:00
fn no_lock_arg() -> Arg {
Arg::new("no-lock")
.long("no-lock")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
2024-08-12 11:55:33 -04:00
.help("Disable auto discovery of the lock file")
.conflicts_with("lock")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
2023-03-26 00:06:18 -04:00
fn config_arg() -> Arg {
Arg::new("config")
.short('c')
.long("config")
.value_name("FILE")
.help(cstr!("Configure different aspects of deno including TypeScript, linting, and code formatting
<p(245)>Typically the configuration file will be called `deno.json` or `deno.jsonc` and
2024-08-12 11:55:33 -04:00
automatically detected; in that case this flag is not necessary.
Docs: https://docs.deno.com/go/config</>"))
.value_hint(ValueHint::FilePath)
}
2023-03-26 00:06:18 -04:00
fn no_config_arg() -> Arg {
Arg::new("no-config")
.long("no-config")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Disable automatic loading of the configuration file")
.conflicts_with("config")
}
2023-03-26 00:06:18 -04:00
fn no_remote_arg() -> Arg {
2022-01-14 11:38:17 -05:00
Arg::new("no-remote")
.long("no-remote")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Do not resolve remote modules")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
2023-03-26 00:06:18 -04:00
fn no_npm_arg() -> Arg {
Arg::new("no-npm")
.long("no-npm")
2023-03-26 00:06:18 -04:00
.action(ArgAction::SetTrue)
.help("Do not resolve npm modules")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
fn node_modules_dir_arg() -> Arg {
Arg::new("node-modules-dir")
.long("node-modules-dir")
2023-03-26 00:06:18 -04:00
.num_args(0..=1)
.value_parser(value_parser!(bool))
2024-08-12 11:55:33 -04:00
.value_name("DIRECTORY")
2023-03-26 00:06:18 -04:00
.default_missing_value("true")
.require_equals(true)
.help("Enables or disables the use of a local node_modules folder for npm packages")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
fn vendor_arg() -> Arg {
Arg::new("vendor")
.long("vendor")
.num_args(0..=1)
.value_parser(value_parser!(bool))
.default_missing_value("true")
.require_equals(true)
.help("Toggles local vendor folder usage for remote modules and a node_modules folder for npm packages")
.help_heading(DEPENDENCY_MANAGEMENT_HEADING)
}
fn unsafely_ignore_certificate_errors_arg() -> Arg {
Arg::new("unsafely-ignore-certificate-errors")
.hide(true)
.long("unsafely-ignore-certificate-errors")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("HOSTNAMES")
.help("DANGER: Disables verification of TLS certificates")
.value_parser(flags_net::validator)
}
fn allow_scripts_arg() -> Arg {
Arg::new("allow-scripts")
.long("allow-scripts")
.num_args(0..)
.use_value_delimiter(true)
.require_equals(true)
.value_name("PACKAGE")
.value_parser(parse_packages_allowed_scripts)
.help(cstr!("Allow running npm lifecycle scripts for the given packages
<p(245)>Note: Scripts will only be executed when using a node_modules directory (`--node-modules-dir`)</>"))
}
enum UnstableArgsConfig {
// for backwards-compatability
None,
ResolutionOnly,
ResolutionAndRuntime,
}
struct UnstableArgsIter {
idx: usize,
cfg: UnstableArgsConfig,
}
impl Iterator for UnstableArgsIter {
type Item = Arg;
fn next(&mut self) -> Option<Self::Item> {
let arg = if self.idx == 0 {
Arg::new("unstable")
.long("unstable")
.help(cstr!("Enable all unstable features and APIs. Instead of using this flag, consider enabling individual unstable features
<p(245)>To view the list of individual unstable feature flags, run this command again with --help=unstable</>"))
.action(ArgAction::SetTrue)
.hide(matches!(self.cfg, UnstableArgsConfig::None))
} else if self.idx == 1 {
Arg::new("unstable-bare-node-builtins")
.long("unstable-bare-node-builtins")
.help("Enable unstable bare node builtins feature")
.env("DENO_UNSTABLE_BARE_NODE_BUILTINS")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.hide(true)
.long_help(match self.cfg {
UnstableArgsConfig::None => None,
UnstableArgsConfig::ResolutionOnly
| UnstableArgsConfig::ResolutionAndRuntime => Some("true"),
})
.help_heading(UNSTABLE_HEADING)
} else if self.idx == 2 {
Arg::new("unstable-byonm")
.long("unstable-byonm")
.help("Enable unstable 'bring your own node_modules' feature")
.env("DENO_UNSTABLE_BYONM")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.hide(true)
.long_help(match self.cfg {
UnstableArgsConfig::None => None,
UnstableArgsConfig::ResolutionOnly
| UnstableArgsConfig::ResolutionAndRuntime => Some("true"),
})
.help_heading(UNSTABLE_HEADING)
} else if self.idx == 3 {
Arg::new("unstable-sloppy-imports")
.long("unstable-sloppy-imports")
.help("Enable unstable resolving of specifiers by extension probing, .js to .ts, and directory probing")
.env("DENO_UNSTABLE_SLOPPY_IMPORTS")
.value_parser(FalseyValueParser::new())
.action(ArgAction::SetTrue)
.hide(true)
.long_help(match self.cfg {
UnstableArgsConfig::None => None,
UnstableArgsConfig::ResolutionOnly | UnstableArgsConfig::ResolutionAndRuntime => Some("true")
})
.help_heading(UNSTABLE_HEADING)
} else if self.idx > 3 {
let granular_flag = crate::UNSTABLE_GRANULAR_FLAGS.get(self.idx - 4)?;
Arg::new(format!("unstable-{}", granular_flag.name))
.long(format!("unstable-{}", granular_flag.name))
.help(granular_flag.help_text)
.action(ArgAction::SetTrue)
.hide(true)
.help_heading(UNSTABLE_HEADING)
// we don't render long help, so using it here as a sort of metadata
.long_help(if granular_flag.show_in_help {
match self.cfg {
UnstableArgsConfig::None | UnstableArgsConfig::ResolutionOnly => {
None
}
UnstableArgsConfig::ResolutionAndRuntime => Some("true"),
}
} else {
None
})
} else {
return None;
};
self.idx += 1;
Some(arg.display_order(self.idx + 1000))
}
}
fn unstable_args(cfg: UnstableArgsConfig) -> impl IntoIterator<Item = Arg> {
UnstableArgsIter { idx: 0, cfg }
}
fn allow_scripts_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
let Some(parts) = matches.remove_many::<String>("allow-scripts") else {
return;
};
if parts.len() == 0 {
flags.allow_scripts = PackagesAllowedScripts::All;
} else {
flags.allow_scripts = PackagesAllowedScripts::Some(parts.collect());
}
}
fn add_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Add(add_parse_inner(matches, None));
}
fn add_parse_inner(
matches: &mut ArgMatches,
packages: Option<clap::parser::Values<String>>,
) -> AddFlags {
let packages = packages
.unwrap_or_else(|| matches.remove_many::<String>("packages").unwrap())
.collect();
AddFlags { packages }
}
fn remove_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Remove(RemoveFlags {
packages: matches.remove_many::<String>("packages").unwrap().collect(),
});
}
2023-03-26 00:06:18 -04:00
fn bench_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local;
runtime_args_parse(flags, matches, true, false);
// NOTE: `deno bench` always uses `--no-prompt`, tests shouldn't ever do
// interactive prompts, unless done by user code
flags.permissions.no_prompt = true;
2023-03-26 00:06:18 -04:00
let json = matches.get_flag("json");
let ignore = match matches.remove_many::<String>("ignore") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
2023-03-26 00:06:18 -04:00
let filter = matches.remove_one::<String>("filter");
2023-03-26 00:06:18 -04:00
if matches.contains_id("script_arg") {
flags
.argv
.extend(matches.remove_many::<String>("script_arg").unwrap());
}
let include = if let Some(files) = matches.remove_many::<String>("files") {
2023-03-26 00:06:18 -04:00
files.collect()
} else {
Vec::new()
};
let no_run = matches.get_flag("no-run");
flags.subcommand = DenoSubcommand::Bench(BenchFlags {
files: FileFlags { include, ignore },
filter,
json,
no_run,
watch: watch_arg_parse(matches),
});
}
2023-03-26 00:06:18 -04:00
fn bundle_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local;
compile_args_parse(flags, matches);
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
2023-03-26 00:06:18 -04:00
let source_file = matches.remove_one::<String>("source_file").unwrap();
2023-03-26 00:06:18 -04:00
let out_file =
if let Some(out_file) = matches.remove_one::<String>("out_file") {
flags.permissions.allow_write = Some(vec![]);
2023-03-26 00:06:18 -04:00
Some(out_file)
} else {
None
};
ext_arg_parse(flags, matches);
flags.subcommand = DenoSubcommand::Bundle(BundleFlags {
source_file,
out_file,
watch: watch_arg_parse(matches),
});
}
2023-03-26 00:06:18 -04:00
fn cache_parse(flags: &mut Flags, matches: &mut ArgMatches) {
compile_args_parse(flags, matches);
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
frozen_lockfile_arg_parse(flags, matches);
allow_scripts_arg_parse(flags, matches);
2023-03-26 00:06:18 -04:00
let files = matches.remove_many::<String>("file").unwrap().collect();
flags.subcommand = DenoSubcommand::Cache(CacheFlags { files });
}
2023-03-26 00:06:18 -04:00
fn check_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local;
compile_args_without_check_parse(flags, matches);
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionAndRuntime);
2023-03-26 00:06:18 -04:00
let files = matches.remove_many::<String>("file").unwrap().collect();
if matches.get_flag("all") || matches.get_flag("remote") {
flags.type_check_mode = TypeCheckMode::All;
}
flags.subcommand = DenoSubcommand::Check(CheckFlags { files });
}
fn clean_parse(flags: &mut Flags, _matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Clean;
}
2023-03-26 00:06:18 -04:00
fn compile_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local;
runtime_args_parse(flags, matches, true, false);
2023-03-26 00:06:18 -04:00
let mut script = matches.remove_many::<String>("script_arg").unwrap();
let source_file = script.next().unwrap();
let args = script.collect();
let output = matches.remove_one::<String>("output");
2023-03-26 00:06:18 -04:00
let target = matches.remove_one::<String>("target");
let icon = matches.remove_one::<String>("icon");
let no_terminal = matches.get_flag("no-terminal");
2023-03-26 00:06:18 -04:00
let include = match matches.remove_many::<String>("include") {
Some(f) => f.collect(),
None => vec![],
};
ext_arg_parse(flags, matches);
flags.subcommand = DenoSubcommand::Compile(CompileFlags {
source_file,
output,
args,
target,
no_terminal,
icon,
include,
});
}
2022-01-14 11:38:17 -05:00
fn completions_parse(
flags: &mut Flags,
2023-03-26 00:06:18 -04:00
matches: &mut ArgMatches,
mut app: Command,
2022-01-14 11:38:17 -05:00
) {
use clap_complete::generate;
use clap_complete::shells::Bash;
use clap_complete::shells::Fish;
use clap_complete::shells::PowerShell;
use clap_complete::shells::Zsh;
2022-01-14 11:38:17 -05:00
use clap_complete_fig::Fig;
let mut buf: Vec<u8> = vec![];
2022-01-14 11:38:17 -05:00
let name = "deno";
2023-03-26 00:06:18 -04:00
match matches.get_one::<String>("shell").unwrap().as_str() {
2022-01-14 11:38:17 -05:00
"bash" => generate(Bash, &mut app, name, &mut buf),
"fish" => generate(Fish, &mut app, name, &mut buf),
"powershell" => generate(PowerShell, &mut app, name, &mut buf),
"zsh" => generate(Zsh, &mut app, name, &mut buf),
"fig" => generate(Fig, &mut app, name, &mut buf),
_ => unreachable!(),
}
flags.subcommand = DenoSubcommand::Completions(CompletionsFlags {
buf: buf.into_boxed_slice(),
});
}
2023-03-26 00:06:18 -04:00
fn coverage_parse(flags: &mut Flags, matches: &mut ArgMatches) {
let files = match matches.remove_many::<String>("files") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec!["coverage".to_string()], // default
};
let ignore = match matches.remove_many::<String>("ignore") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
2023-03-26 00:06:18 -04:00
let include = match matches.remove_many::<String>("include") {
Some(f) => f.collect(),
None => vec![],
};
2023-03-26 00:06:18 -04:00
let exclude = match matches.remove_many::<String>("exclude") {
Some(f) => f.collect(),
None => vec![],
};
let r#type = if matches.get_flag("lcov") {
CoverageType::Lcov
} else if matches.get_flag("html") {
CoverageType::Html
} else if matches.get_flag("detailed") {
CoverageType::Detailed
} else {
CoverageType::Summary
};
let output = matches.remove_one::<String>("output");
flags.subcommand = DenoSubcommand::Coverage(CoverageFlags {
files: FileFlags {
include: files,
ignore,
},
output,
include,
exclude,
r#type,
});
}
2023-03-26 00:06:18 -04:00
fn doc_parse(flags: &mut Flags, matches: &mut ArgMatches) {
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
import_map_arg_parse(flags, matches);
reload_arg_parse(flags, matches);
lock_arg_parse(flags, matches);
no_lock_arg_parse(flags, matches);
no_npm_arg_parse(flags, matches);
no_remote_arg_parse(flags, matches);
let source_files_val = matches.remove_many::<String>("source_file");
let source_files = if let Some(val) = source_files_val {
let vals: Vec<String> = val.collect();
if vals.len() == 1 {
if vals[0] == "--builtin" {
DocSourceFileFlag::Builtin
} else {
DocSourceFileFlag::Paths(vec![vals[0].to_string()])
}
} else {
DocSourceFileFlag::Paths(
vals.into_iter().filter(|v| v != "--builtin").collect(),
)
}
} else {
DocSourceFileFlag::Builtin
};
2023-03-26 00:06:18 -04:00
let private = matches.get_flag("private");
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
let lint = matches.get_flag("lint");
2023-03-26 00:06:18 -04:00
let json = matches.get_flag("json");
let filter = matches.remove_one::<String>("filter");
let html = if matches.get_flag("html") {
2024-04-24 16:34:21 -04:00
let name = matches.remove_one::<String>("name");
2024-06-28 08:03:51 -04:00
let category_docs_path = matches.remove_one::<String>("category-docs");
let symbol_redirect_map_path =
matches.remove_one::<String>("symbol-redirect-map");
let strip_trailing_html = matches.get_flag("strip-trailing-html");
let default_symbol_map_path =
matches.remove_one::<String>("default-symbol-map");
let output = matches
.remove_one::<String>("output")
.unwrap_or(String::from("./docs/"));
2024-06-28 08:03:51 -04:00
Some(DocHtmlFlag {
name,
category_docs_path,
symbol_redirect_map_path,
default_symbol_map_path,
strip_trailing_html,
output,
})
} else {
None
};
flags.subcommand = DenoSubcommand::Doc(DocFlags {
source_files,
json,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint,
html,
filter,
private,
});
}
2023-03-26 00:06:18 -04:00
fn eval_parse(flags: &mut Flags, matches: &mut ArgMatches) {
runtime_args_parse(flags, matches, false, true);
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionAndRuntime);
flags.allow_all();
ext_arg_parse(flags, matches);
// TODO(@satyarohith): remove this flag in 2.0.
2023-03-26 00:06:18 -04:00
let as_typescript = matches.get_flag("ts");
#[allow(clippy::print_stderr)]
if as_typescript {
eprintln!(
"⚠️ {}",
crate::colors::yellow(
"Use `--ext=ts` instead. The `--ts` and `-T` flags are deprecated and will be removed in Deno 2.0."
),
);
flags.ext = Some("ts".to_string());
}
2023-03-26 00:06:18 -04:00
let print = matches.get_flag("print");
let mut code_args = matches.remove_many::<String>("code_arg").unwrap();
let code = code_args.next().unwrap();
flags.argv.extend(code_args);
flags.subcommand = DenoSubcommand::Eval(EvalFlags { print, code });
}
2023-03-26 00:06:18 -04:00
fn fmt_parse(flags: &mut Flags, matches: &mut ArgMatches) {
config_args_parse(flags, matches);
ext_arg_parse(flags, matches);
let include = match matches.remove_many::<String>("files") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
let ignore = match matches.remove_many::<String>("ignore") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
2019-04-29 19:43:06 -04:00
2023-03-26 00:06:18 -04:00
let use_tabs = matches.remove_one::<bool>("use-tabs");
let line_width = matches.remove_one::<NonZeroU32>("line-width");
let indent_width = matches.remove_one::<NonZeroU8>("indent-width");
let single_quote = matches.remove_one::<bool>("single-quote");
let prose_wrap = matches.remove_one::<String>("prose-wrap");
let no_semicolons = matches.remove_one::<bool>("no-semicolons");
let unstable_css = matches.get_flag("unstable-css");
let unstable_html = matches.get_flag("unstable-html");
let unstable_component = matches.get_flag("unstable-component");
let unstable_yaml = matches.get_flag("unstable-yaml");
flags.subcommand = DenoSubcommand::Fmt(FmtFlags {
2023-03-26 00:06:18 -04:00
check: matches.get_flag("check"),
files: FileFlags { include, ignore },
use_tabs,
line_width,
indent_width,
single_quote,
prose_wrap,
no_semicolons,
watch: watch_arg_parse(matches),
unstable_css,
unstable_html,
unstable_component,
unstable_yaml,
});
}
2023-03-26 00:06:18 -04:00
fn init_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Init(InitFlags {
2023-03-26 00:06:18 -04:00
dir: matches.remove_one::<String>("dir"),
lib: matches.get_flag("lib"),
serve: matches.get_flag("serve"),
});
}
2023-03-26 00:06:18 -04:00
fn info_parse(flags: &mut Flags, matches: &mut ArgMatches) {
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
reload_arg_parse(flags, matches);
config_args_parse(flags, matches);
import_map_arg_parse(flags, matches);
location_arg_parse(flags, matches);
ca_file_arg_parse(flags, matches);
unsafely_ignore_certificate_errors_parse(flags, matches);
node_modules_and_vendor_dir_arg_parse(flags, matches);
lock_args_parse(flags, matches);
no_remote_arg_parse(flags, matches);
no_npm_arg_parse(flags, matches);
2023-03-26 00:06:18 -04:00
let json = matches.get_flag("json");
flags.subcommand = DenoSubcommand::Info(InfoFlags {
2023-03-26 00:06:18 -04:00
file: matches.remove_one::<String>("file"),
json,
});
}
2023-03-26 00:06:18 -04:00
fn install_parse(flags: &mut Flags, matches: &mut ArgMatches) {
runtime_args_parse(flags, matches, true, true);
let global = matches.get_flag("global");
if global || !*DENO_FUTURE {
let root = matches.remove_one::<String>("root");
let force = matches.get_flag("force");
let name = matches.remove_one::<String>("name");
let mut cmd_values =
matches.remove_many::<String>("cmd").unwrap_or_default();
let module_url = cmd_values.next().unwrap();
let args = cmd_values.collect();
flags.subcommand = DenoSubcommand::Install(InstallFlags {
// TODO(bartlomieju): remove for 2.0
global,
kind: InstallKind::Global(InstallFlagsGlobal {
name,
module_url,
args,
root,
force,
}),
});
} else {
let local_flags = matches
.remove_many("cmd")
.map(|packages| add_parse_inner(matches, Some(packages)));
allow_scripts_arg_parse(flags, matches);
flags.subcommand = DenoSubcommand::Install(InstallFlags {
global,
kind: InstallKind::Local(local_flags),
})
}
}
2024-08-12 11:55:33 -04:00
fn json_reference_parse(
flags: &mut Flags,
_matches: &mut ArgMatches,
mut app: Command,
) {
use deno_core::serde_json::json;
app.build();
fn serialize_command(
command: &mut Command,
top_level: bool,
) -> deno_core::serde_json::Value {
let args = command
.get_arguments()
.filter(|arg| {
!arg.is_hide_set()
&& if top_level {
true
} else {
!arg.is_global_set()
}
})
.map(|arg| {
let name = arg.get_id().as_str();
let short = arg.get_short();
let long = arg.get_long();
let aliases = arg.get_visible_aliases();
let required = arg.is_required_set();
let help = arg.get_help().map(|help| help.to_string());
let usage = arg.to_string();
json!({
"name": name,
"short": short,
"long": long,
"aliases": aliases,
"required": required,
"help": help,
"usage": usage,
})
})
.collect::<Vec<_>>();
let name = command.get_name().to_string();
let about = command.get_about().map(|about| about.to_string());
let visible_aliases = command
.get_visible_aliases()
.map(|s| s.to_string())
.collect::<Vec<_>>();
let usage = command.render_usage().to_string();
let subcommands = command
.get_subcommands_mut()
.map(|command| serialize_command(command, false))
.collect::<Vec<_>>();
json!({
"name": name,
"about": about,
"visible_aliases": visible_aliases,
"args": args,
"subcommands": subcommands,
"usage": usage,
})
}
flags.subcommand = DenoSubcommand::JSONReference(JSONReferenceFlags {
json: serialize_command(&mut app, true),
})
}
fn jupyter_parse(flags: &mut Flags, matches: &mut ArgMatches) {
let conn_file = matches.remove_one::<String>("conn");
let kernel = matches.get_flag("kernel");
let install = matches.get_flag("install");
flags.subcommand = DenoSubcommand::Jupyter(JupyterFlags {
install,
kernel,
conn_file,
});
}
2023-03-26 00:06:18 -04:00
fn uninstall_parse(flags: &mut Flags, matches: &mut ArgMatches) {
let root = matches.remove_one::<String>("root");
let global = matches.get_flag("global");
2023-03-26 00:06:18 -04:00
let name = matches.remove_one::<String>("name").unwrap();
flags.subcommand = DenoSubcommand::Uninstall(UninstallFlags {
// TODO(bartlomieju): remove once `deno uninstall` supports both local and
// global installs
global,
kind: UninstallKind::Global(UninstallFlagsGlobal { name, root }),
});
}
2023-03-26 00:06:18 -04:00
fn lsp_parse(flags: &mut Flags, _matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Lsp;
}
2019-08-15 10:11:52 -04:00
2023-03-26 00:06:18 -04:00
fn lint_parse(flags: &mut Flags, matches: &mut ArgMatches) {
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
config_args_parse(flags, matches);
let files = match matches.remove_many::<String>("files") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
let ignore = match matches.remove_many::<String>("ignore") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
let fix = matches.get_flag("fix");
2023-03-26 00:06:18 -04:00
let rules = matches.get_flag("rules");
let maybe_rules_tags = matches
2023-03-26 00:06:18 -04:00
.remove_many::<String>("rules-tags")
.map(|f| f.collect());
let maybe_rules_include = matches
2023-03-26 00:06:18 -04:00
.remove_many::<String>("rules-include")
.map(|f| f.collect());
let maybe_rules_exclude = matches
2023-03-26 00:06:18 -04:00
.remove_many::<String>("rules-exclude")
.map(|f| f.collect());
2023-03-26 00:06:18 -04:00
let json = matches.get_flag("json");
let compact = matches.get_flag("compact");
let ext = matches.remove_one::<String>("ext");
flags.subcommand = DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: files,
ignore,
},
fix,
rules,
maybe_rules_tags,
maybe_rules_include,
maybe_rules_exclude,
json,
compact,
watch: watch_arg_parse(matches),
ext,
});
}
2019-08-15 10:11:52 -04:00
2023-03-26 00:06:18 -04:00
fn repl_parse(flags: &mut Flags, matches: &mut ArgMatches) {
runtime_args_parse(flags, matches, true, true);
2022-01-14 11:38:17 -05:00
unsafely_ignore_certificate_errors_parse(flags, matches);
2023-03-26 00:06:18 -04:00
let eval_files = matches
.remove_many::<String>("eval-file")
.map(|values| values.collect());
2022-01-14 11:38:17 -05:00
handle_repl_flags(
flags,
ReplFlags {
eval_files,
2023-03-26 00:06:18 -04:00
eval: matches.remove_one::<String>("eval"),
is_default_command: false,
2022-01-14 11:38:17 -05:00
},
);
}
2019-08-15 10:11:52 -04:00
fn run_parse(
flags: &mut Flags,
matches: &mut ArgMatches,
app: Command,
2024-08-12 11:55:33 -04:00
bare: bool,
) -> clap::error::Result<()> {
// todo(dsherret): remove this in Deno 2.0
// This is a hack to make https://github.com/netlify/build/pull/5767 work
// for old versions of @netlify/edge-bundler with new versions of Deno
// where Deno has gotten smarter at resolving config files.
//
// It's an unfortunate scenario, but Netlify has the version at least
// pinned to 1.x in old versions so we can remove this in Deno 2.0 in
// a few months.
fn temp_netlify_deno_1_hack(flags: &mut Flags, script_arg: &str) {
fn is_netlify_edge_bundler_entrypoint(
flags: &Flags,
script_arg: &str,
) -> bool {
// based on diff here: https://github.com/netlify/edge-bundler/blame/f1d33b74ca7aeec19a7c2149316d4547a94e43fb/node/config.ts#L85
if flags.permissions.allow_read.is_none()
|| flags.permissions.allow_write.is_none()
|| flags.config_flag != ConfigFlag::Discover
{
return false;
}
if !script_arg.contains("@netlify") {
return false;
}
let path = PathBuf::from(script_arg);
if !path.ends_with("deno/config.ts") {
return false;
}
let mut found_node_modules = false;
for component in path.components().filter_map(|c| c.as_os_str().to_str())
{
if !found_node_modules {
found_node_modules = component == "node_modules";
} else {
// make this work with pnpm and other package managers
if component.contains("@netlify") {
return true;
}
}
}
false
}
if is_netlify_edge_bundler_entrypoint(flags, script_arg) {
flags.config_flag = ConfigFlag::Disabled;
}
}
runtime_args_parse(flags, matches, true, true);
ext_arg_parse(flags, matches);
flags.code_cache_enabled = !matches.get_flag("no-code-cache");
if let Some(mut script_arg) = matches.remove_many::<String>("script_arg") {
let script = script_arg.next().unwrap();
flags.argv.extend(script_arg);
temp_netlify_deno_1_hack(flags, &script);
flags.subcommand = DenoSubcommand::Run(RunFlags {
script,
watch: watch_arg_parse_with_paths(matches),
bare,
});
} else if bare {
return Err(app.override_usage("deno [OPTIONS] [COMMAND] [SCRIPT_ARG]...").error(
clap::error::ErrorKind::MissingRequiredArgument,
"[SCRIPT_ARG] may only be omitted with --v8-flags=--help, else to use the repl with arguments, please use the `deno repl` subcommand",
));
} else {
flags.subcommand = DenoSubcommand::Task(TaskFlags {
cwd: None,
task: None,
is_run: true,
});
}
Ok(())
}
2019-08-15 10:11:52 -04:00
fn serve_parse(
flags: &mut Flags,
matches: &mut ArgMatches,
app: Command,
) -> clap::error::Result<()> {
// deno serve implies --allow-net=host:port
let port = matches.remove_one::<u16>("port").unwrap_or(8000);
let host = matches
.remove_one::<String>("host")
.unwrap_or_else(|| "0.0.0.0".to_owned());
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
let worker_count = parallel_arg_parse(matches, false).map(|v| v.get());
runtime_args_parse(flags, matches, true, true);
// If the user didn't pass --allow-net, add this port to the network
// allowlist. If the host is 0.0.0.0, we add :{port} and allow the same network perms
// as if it was passed to --allow-net directly.
let allowed = flags_net::parse(vec![if host == "0.0.0.0" {
format!(":{port}")
} else {
format!("{host}:{port}")
}])?;
match &mut flags.permissions.allow_net {
None => flags.permissions.allow_net = Some(allowed),
Some(v) => {
if !v.is_empty() {
v.extend(allowed);
}
}
}
flags.code_cache_enabled = !matches.get_flag("no-code-cache");
let mut script_arg =
matches.remove_many::<String>("script_arg").ok_or_else(|| {
let mut app = app;
let subcommand = &mut app.find_subcommand_mut("serve").unwrap();
subcommand.error(
clap::error::ErrorKind::MissingRequiredArgument,
"[SCRIPT_ARG] may only be omitted with --v8-flags=--help",
)
})?;
let script = script_arg.next().unwrap();
flags.argv.extend(script_arg);
ext_arg_parse(flags, matches);
flags.subcommand = DenoSubcommand::Serve(ServeFlags {
script,
watch: watch_arg_parse_with_paths(matches),
port,
host,
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
worker_count,
});
Ok(())
}
2023-03-26 00:06:18 -04:00
fn task_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.config_flag = matches
.remove_one::<String>("config")
.map(ConfigFlag::Path)
.unwrap_or(ConfigFlag::Discover);
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionAndRuntime);
let mut task_flags = TaskFlags {
2023-03-26 00:06:18 -04:00
cwd: matches.remove_one::<String>("cwd"),
task: None,
is_run: false,
};
2023-03-26 00:06:18 -04:00
if let Some((task, mut matches)) = matches.remove_subcommand() {
task_flags.task = Some(task);
2023-03-26 00:06:18 -04:00
flags.argv.extend(
matches
.remove_many::<std::ffi::OsString>("")
.into_iter()
.flatten()
.filter_map(|arg| arg.into_string().ok()),
);
}
flags.subcommand = DenoSubcommand::Task(task_flags);
}
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
fn parallel_arg_parse(
matches: &mut ArgMatches,
fallback_to_jobs: bool,
) -> Option<NonZeroUsize> {
if matches.get_flag("parallel") {
if let Ok(value) = env::var("DENO_JOBS") {
value.parse::<NonZeroUsize>().ok()
} else {
std::thread::available_parallelism().ok()
}
} else if fallback_to_jobs && matches.contains_id("jobs") {
// We can't change this to use the log crate because its not configured
// yet at this point since the flags haven't been parsed. This flag is
// deprecated though so it's not worth changing the code to use the log
// crate here and this is only done for testing anyway.
#[allow(clippy::print_stderr)]
{
eprintln!(
"⚠️ {}",
crate::colors::yellow(concat!(
"The `--jobs` flag is deprecated and will be removed in Deno 2.0.\n",
"Use the `--parallel` flag with possibly the `DENO_JOBS` environment variable instead.\n",
"Learn more at: https://docs.deno.com/runtime/manual/basics/env_variables"
)),
);
}
if let Some(value) = matches.remove_one::<NonZeroUsize>("jobs") {
Some(value)
} else {
std::thread::available_parallelism().ok()
}
} else {
None
}
}
2023-03-26 00:06:18 -04:00
fn test_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local;
runtime_args_parse(flags, matches, true, true);
// NOTE: `deno test` always uses `--no-prompt`, tests shouldn't ever do
// interactive prompts, unless done by user code
flags.permissions.no_prompt = true;
let ignore = match matches.remove_many::<String>("ignore") {
2023-03-26 00:06:18 -04:00
Some(f) => f.collect(),
None => vec![],
};
2023-03-26 00:06:18 -04:00
let no_run = matches.get_flag("no-run");
let trace_leaks =
matches.get_flag("trace-ops") || matches.get_flag("trace-leaks");
#[allow(clippy::print_stderr)]
if trace_leaks && matches.get_flag("trace-ops") {
// We can't change this to use the log crate because its not configured
// yet at this point since the flags haven't been parsed. This flag is
// deprecated though so it's not worth changing the code to use the log
// crate here and this is only done for testing anyway.
eprintln!(
"⚠️ {}",
crate::colors::yellow("The `--trace-ops` flag is deprecated and will be removed in Deno 2.0.\nUse the `--trace-leaks` flag instead."),
);
}
2023-03-26 00:06:18 -04:00
let doc = matches.get_flag("doc");
#[allow(clippy::print_stderr)]
let allow_none = matches.get_flag("permit-no-files")
|| if matches.get_flag("allow-none") {
eprintln!(
2024-08-12 11:55:33 -04:00
"⚠️ {}",
crate::colors::yellow("The `--allow-none` flag is deprecated and will be removed in Deno 2.0.\nUse the `--permit-no-files` flag instead."),
);
true
} else {
false
};
2023-03-26 00:06:18 -04:00
let filter = matches.remove_one::<String>("filter");
let clean = matches.get_flag("clean");
2023-03-26 00:06:18 -04:00
let fail_fast = if matches.contains_id("fail-fast") {
Some(
matches
.remove_one::<NonZeroUsize>("fail-fast")
.unwrap_or_else(|| NonZeroUsize::new(1).unwrap()),
)
} else {
None
};
2023-03-26 00:06:18 -04:00
let shuffle = if matches.contains_id("shuffle") {
Some(
matches
.remove_one::<u64>("shuffle")
.unwrap_or_else(rand::random),
)
} else {
None
};
2023-03-26 00:06:18 -04:00
if let Some(script_arg) = matches.remove_many::<String>("script_arg") {
flags.argv.extend(script_arg);
}
feat(serve): Opt-in parallelism for `deno serve` (#24920) Adds a `parallel` flag to `deno serve`. When present, we spawn multiple workers to parallelize serving requests. ```bash deno serve --parallel main.ts ``` Currently on linux we use `SO_REUSEPORT` and rely on the fact that the kernel will distribute connections in a round-robin manner. On mac and windows, we sort of emulate this by cloning the underlying file descriptor and passing a handle to each worker. The connections will not be guaranteed to be fairly distributed (and in practice almost certainly won't be), but the distribution is still spread enough to provide a significant performance increase. --- (Run on an Macbook Pro with an M3 Max, serving `deno.com` baseline:: ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 239.78ms 13.56ms 330.54ms 79.12% Req/Sec 258.58 35.56 360.00 70.64% Latency Distribution 50% 236.72ms 75% 248.46ms 90% 256.84ms 99% 268.23ms 15458 requests in 30.02s, 2.47GB read Requests/sec: 514.89 Transfer/sec: 84.33MB ``` this PR (`with --parallel` flag) ``` ❯ wrk -d 30s -c 125 --latency http://127.0.0.1:8000 Running 30s test @ http://127.0.0.1:8000 2 threads and 125 connections Thread Stats Avg Stdev Max +/- Stdev Latency 117.40ms 142.84ms 590.45ms 79.07% Req/Sec 1.33k 175.19 1.77k 69.00% Latency Distribution 50% 22.34ms 75% 223.67ms 90% 357.32ms 99% 460.50ms 79636 requests in 30.07s, 12.74GB read Requests/sec: 2647.96 Transfer/sec: 433.71MB ```
2024-08-14 18:26:21 -04:00
let concurrent_jobs = parallel_arg_parse(matches, true);
let include = if let Some(files) = matches.remove_many::<String>("files") {
2023-03-26 00:06:18 -04:00
files.collect()
} else {
Vec::new()
};
let junit_path = matches.remove_one::<String>("junit-path");
let reporter =
if let Some(reporter) = matches.remove_one::<String>("reporter") {
match reporter.as_str() {
"pretty" => TestReporterConfig::Pretty,
"junit" => TestReporterConfig::Junit,
"dot" => TestReporterConfig::Dot,
"tap" => TestReporterConfig::Tap,
_ => unreachable!(),
}
} else {
TestReporterConfig::Pretty
};
if matches!(reporter, TestReporterConfig::Dot | TestReporterConfig::Tap) {
flags.log_level = Some(Level::Error);
}
let hide_stacktraces = matches.get_flag("hide-stacktraces");
flags.subcommand = DenoSubcommand::Test(TestFlags {
no_run,
doc,
coverage_dir: matches.remove_one::<String>("coverage"),
clean,
fail_fast,
files: FileFlags { include, ignore },
filter,
shuffle,
allow_none,
concurrent_jobs,
trace_leaks,
watch: watch_arg_parse_with_paths(matches),
reporter,
junit_path,
hide_stacktraces,
});
}
2023-03-26 00:06:18 -04:00
fn types_parse(flags: &mut Flags, _matches: &mut ArgMatches) {
flags.subcommand = DenoSubcommand::Types;
}
2023-03-26 00:06:18 -04:00
fn upgrade_parse(flags: &mut Flags, matches: &mut ArgMatches) {
ca_file_arg_parse(flags, matches);
unsafely_ignore_certificate_errors_parse(flags, matches);
2023-03-26 00:06:18 -04:00
let dry_run = matches.get_flag("dry-run");
let force = matches.get_flag("force");
let canary = matches.get_flag("canary");
let release_candidate = matches.get_flag("release-candidate");
2023-03-26 00:06:18 -04:00
let version = matches.remove_one::<String>("version");
let output = matches.remove_one::<String>("output");
let version_or_hash_or_channel =
matches.remove_one::<String>("version-or-hash-or-channel");
flags.subcommand = DenoSubcommand::Upgrade(UpgradeFlags {
dry_run,
force,
release_candidate,
canary,
version,
output,
version_or_hash_or_channel,
});
}
2023-03-26 00:06:18 -04:00
fn vendor_parse(flags: &mut Flags, matches: &mut ArgMatches) {
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
2022-02-16 13:14:19 -05:00
ca_file_arg_parse(flags, matches);
unsafely_ignore_certificate_errors_parse(flags, matches);
config_args_parse(flags, matches);
2022-02-16 13:14:19 -05:00
import_map_arg_parse(flags, matches);
lock_arg_parse(flags, matches);
node_modules_and_vendor_dir_arg_parse(flags, matches);
2022-02-16 13:14:19 -05:00
reload_arg_parse(flags, matches);
flags.subcommand = DenoSubcommand::Vendor(VendorFlags {
specifiers: matches
2023-03-26 00:06:18 -04:00
.remove_many::<String>("specifiers")
.map(|p| p.collect())
2022-02-16 13:14:19 -05:00
.unwrap_or_default(),
output_path: matches.remove_one::<String>("output"),
2023-03-26 00:06:18 -04:00
force: matches.get_flag("force"),
2022-02-16 13:14:19 -05:00
});
}
fn publish_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.type_check_mode = TypeCheckMode::Local; // local by default
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionOnly);
no_check_arg_parse(flags, matches);
check_arg_parse(flags, matches);
config_args_parse(flags, matches);
flags.subcommand = DenoSubcommand::Publish(PublishFlags {
token: matches.remove_one("token"),
dry_run: matches.get_flag("dry-run"),
allow_slow_types: matches.get_flag("allow-slow-types"),
allow_dirty: matches.get_flag("allow-dirty"),
no_provenance: matches.get_flag("no-provenance"),
});
}
2023-03-26 00:06:18 -04:00
fn compile_args_parse(flags: &mut Flags, matches: &mut ArgMatches) {
compile_args_without_check_parse(flags, matches);
no_check_arg_parse(flags, matches);
check_arg_parse(flags, matches);
}
fn compile_args_without_check_parse(
flags: &mut Flags,
2023-03-26 00:06:18 -04:00
matches: &mut ArgMatches,
) {
import_map_arg_parse(flags, matches);
no_remote_arg_parse(flags, matches);
no_npm_arg_parse(flags, matches);
node_modules_and_vendor_dir_arg_parse(flags, matches);
config_args_parse(flags, matches);
reload_arg_parse(flags, matches);
lock_args_parse(flags, matches);
ca_file_arg_parse(flags, matches);
unsafely_ignore_certificate_errors_parse(flags, matches);
}
2023-03-26 00:06:18 -04:00
fn permission_args_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(read_wl) = matches.remove_many::<String>("allow-read") {
flags.permissions.allow_read = Some(read_wl.collect());
}
if let Some(read_wl) = matches.remove_many::<String>("deny-read") {
flags.permissions.deny_read = Some(read_wl.collect());
}
if let Some(write_wl) = matches.remove_many::<String>("allow-write") {
flags.permissions.allow_write = Some(write_wl.collect());
}
if let Some(write_wl) = matches.remove_many::<String>("deny-write") {
flags.permissions.deny_write = Some(write_wl.collect());
}
2023-03-26 00:06:18 -04:00
if let Some(net_wl) = matches.remove_many::<String>("allow-net") {
let net_allowlist = flags_net::parse(net_wl.collect()).unwrap();
flags.permissions.allow_net = Some(net_allowlist);
}
if let Some(net_wl) = matches.remove_many::<String>("deny-net") {
let net_denylist = flags_net::parse(net_wl.collect()).unwrap();
flags.permissions.deny_net = Some(net_denylist);
}
2023-03-26 00:06:18 -04:00
if let Some(env_wl) = matches.remove_many::<String>("allow-env") {
flags.permissions.allow_env = Some(env_wl.collect());
debug!("env allowlist: {:#?}", &flags.permissions.allow_env);
}
if let Some(env_wl) = matches.remove_many::<String>("deny-env") {
flags.permissions.deny_env = Some(env_wl.collect());
debug!("env denylist: {:#?}", &flags.permissions.deny_env);
}
2023-03-26 00:06:18 -04:00
if let Some(run_wl) = matches.remove_many::<String>("allow-run") {
flags.permissions.allow_run = Some(run_wl.collect());
debug!("run allowlist: {:#?}", &flags.permissions.allow_run);
}
if let Some(run_wl) = matches.remove_many::<String>("deny-run") {
flags.permissions.deny_run = Some(run_wl.collect());
debug!("run denylist: {:#?}", &flags.permissions.deny_run);
}
2023-03-26 00:06:18 -04:00
if let Some(sys_wl) = matches.remove_many::<String>("allow-sys") {
flags.permissions.allow_sys = Some(sys_wl.collect());
debug!("sys info allowlist: {:#?}", &flags.permissions.allow_sys);
}
if let Some(sys_wl) = matches.remove_many::<String>("deny-sys") {
flags.permissions.deny_sys = Some(sys_wl.collect());
debug!("sys info denylist: {:#?}", &flags.permissions.deny_sys);
}
if let Some(ffi_wl) = matches.remove_many::<String>("allow-ffi") {
flags.permissions.allow_ffi = Some(ffi_wl.collect());
debug!("ffi allowlist: {:#?}", &flags.permissions.allow_ffi);
}
if let Some(ffi_wl) = matches.remove_many::<String>("deny-ffi") {
flags.permissions.deny_ffi = Some(ffi_wl.collect());
debug!("ffi denylist: {:#?}", &flags.permissions.deny_ffi);
}
2023-03-26 00:06:18 -04:00
if matches.get_flag("allow-hrtime") {
flags.permissions.allow_hrtime = true;
}
if matches.get_flag("deny-hrtime") {
flags.permissions.deny_hrtime = true;
}
2023-03-26 00:06:18 -04:00
if matches.get_flag("allow-all") {
flags.allow_all();
}
2023-03-26 00:06:18 -04:00
if matches.get_flag("no-prompt") {
flags.permissions.no_prompt = true;
}
}
2022-01-14 11:38:17 -05:00
fn unsafely_ignore_certificate_errors_parse(
flags: &mut Flags,
2023-03-26 00:06:18 -04:00
matches: &mut ArgMatches,
) {
2023-03-26 00:06:18 -04:00
if let Some(ic_wl) =
matches.remove_many::<String>("unsafely-ignore-certificate-errors")
{
let ic_allowlist = flags_net::parse(ic_wl.collect()).unwrap();
flags.unsafely_ignore_certificate_errors = Some(ic_allowlist);
}
}
fn runtime_args_parse(
flags: &mut Flags,
2023-03-26 00:06:18 -04:00
matches: &mut ArgMatches,
include_perms: bool,
include_inspector: bool,
) {
unstable_args_parse(flags, matches, UnstableArgsConfig::ResolutionAndRuntime);
compile_args_parse(flags, matches);
cached_only_arg_parse(flags, matches);
frozen_lockfile_arg_parse(flags, matches);
if include_perms {
permission_args_parse(flags, matches);
}
if include_inspector {
inspect_arg_parse(flags, matches);
}
location_arg_parse(flags, matches);
v8_flags_arg_parse(flags, matches);
seed_arg_parse(flags, matches);
enable_testing_features_arg_parse(flags, matches);
env_file_arg_parse(flags, matches);
strace_ops_parse(flags, matches);
}
2023-03-26 00:06:18 -04:00
fn inspect_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.inspect = matches.remove_one::<SocketAddr>("inspect");
flags.inspect_brk = matches.remove_one::<SocketAddr>("inspect-brk");
flags.inspect_wait = matches.remove_one::<SocketAddr>("inspect-wait");
}
2023-03-26 00:06:18 -04:00
fn import_map_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.import_map_path = matches.remove_one::<String>("import-map");
}
2019-08-15 10:11:52 -04:00
fn env_file_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.env_file = matches.remove_one::<String>("env-file");
}
2023-03-26 00:06:18 -04:00
fn reload_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(cache_bl) = matches.remove_many::<String>("reload") {
let raw_cache_blocklist: Vec<String> = cache_bl.collect();
if raw_cache_blocklist.is_empty() {
2020-05-16 09:41:32 -04:00
flags.reload = true;
} else {
flags.cache_blocklist = resolve_urls(raw_cache_blocklist);
debug!("cache blocklist: {:#?}", &flags.cache_blocklist);
flags.reload = false;
2019-05-03 17:15:16 -04:00
}
}
}
2019-10-04 09:02:36 -04:00
2023-03-26 00:06:18 -04:00
fn ca_file_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.ca_data = matches.remove_one::<String>("cert").map(CaData::File);
}
2019-10-04 09:02:36 -04:00
fn enable_testing_features_arg_parse(
flags: &mut Flags,
2023-03-26 00:06:18 -04:00
matches: &mut ArgMatches,
) {
2023-03-26 00:06:18 -04:00
if matches.get_flag("enable-testing-features-do-not-use") {
flags.enable_testing_features = true
}
}
fn strace_ops_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(patterns) = matches.remove_many::<String>("strace-ops") {
flags.strace_ops = Some(patterns.collect());
}
}
2023-03-26 00:06:18 -04:00
fn cached_only_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if matches.get_flag("cached-only") {
flags.cached_only = true;
}
}
2019-10-04 09:02:36 -04:00
fn frozen_lockfile_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(&v) = matches.get_one::<bool>("frozen") {
flags.frozen_lockfile = Some(v);
}
}
2023-03-26 00:06:18 -04:00
fn ext_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.ext = matches.remove_one::<String>("ext");
}
2023-03-26 00:06:18 -04:00
fn location_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.location = matches.remove_one::<Url>("location");
}
2023-03-26 00:06:18 -04:00
fn v8_flags_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(v8_flags) = matches.remove_many::<String>("v8-flags") {
flags.v8_flags = v8_flags.collect();
}
}
2023-03-26 00:06:18 -04:00
fn seed_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(seed) = matches.remove_one::<u64>("seed") {
flags.seed = Some(seed);
flags.v8_flags.push(format!("--random-seed={seed}"));
}
}
2023-03-26 00:06:18 -04:00
fn no_check_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(cache_type) = matches.get_one::<String>("no-check") {
match cache_type.as_str() {
"remote" => flags.type_check_mode = TypeCheckMode::Local,
_ => debug!(
"invalid value for 'no-check' of '{}' using default",
cache_type
),
}
2023-03-26 00:06:18 -04:00
} else if matches.contains_id("no-check") {
flags.type_check_mode = TypeCheckMode::None;
}
}
2023-03-26 00:06:18 -04:00
fn check_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if let Some(cache_type) = matches.get_one::<String>("check") {
match cache_type.as_str() {
"all" => flags.type_check_mode = TypeCheckMode::All,
_ => debug!(
"invalid value for 'check' of '{}' using default",
cache_type
),
}
2023-03-26 00:06:18 -04:00
} else if matches.contains_id("check") {
flags.type_check_mode = TypeCheckMode::Local;
}
}
2023-03-26 00:06:18 -04:00
fn lock_args_parse(flags: &mut Flags, matches: &mut ArgMatches) {
2022-02-16 13:14:19 -05:00
lock_arg_parse(flags, matches);
no_lock_arg_parse(flags, matches);
2022-02-16 13:14:19 -05:00
}
2023-03-26 00:06:18 -04:00
fn lock_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if matches.contains_id("lock") {
2024-08-12 11:55:33 -04:00
let lockfile = matches.remove_one::<String>("lock").unwrap();
2023-03-26 00:06:18 -04:00
flags.lock = Some(lockfile);
}
}
2023-03-26 00:06:18 -04:00
fn no_lock_arg_parse(flags: &mut Flags, matches: &ArgMatches) {
if matches.get_flag("no-lock") {
flags.no_lock = true;
}
}
2023-03-26 00:06:18 -04:00
fn config_args_parse(flags: &mut Flags, matches: &mut ArgMatches) {
flags.config_flag = if matches.get_flag("no-config") {
ConfigFlag::Disabled
2023-03-26 00:06:18 -04:00
} else if let Some(config) = matches.remove_one::<String>("config") {
ConfigFlag::Path(config)
} else {
ConfigFlag::Discover
};
}
2023-03-26 00:06:18 -04:00
fn no_remote_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if matches.get_flag("no-remote") {
flags.no_remote = true;
}
}
2023-03-26 00:06:18 -04:00
fn no_npm_arg_parse(flags: &mut Flags, matches: &mut ArgMatches) {
if matches.get_flag("no-npm") {
flags.no_npm = true;
}
}
fn node_modules_and_vendor_dir_arg_parse(
flags: &mut Flags,
matches: &mut ArgMatches,
) {
2023-03-26 00:06:18 -04:00
flags.node_modules_dir = matches.remove_one::<bool>("node-modules-dir");
flags.vendor = matches.remove_one::<bool>("vendor");
}
2023-03-26 00:06:18 -04:00
fn reload_arg_validate(urlstr: &str) -> Result<String, String> {
if urlstr.is_empty() {
return Err(String::from("Missing url. Check for extra commas."));
}
match Url::from_str(urlstr) {
2023-03-26 00:06:18 -04:00
Ok(_) => Ok(urlstr.to_string()),
Err(e) => Err(e.to_string()),
}
}
fn watch_arg_parse(matches: &mut ArgMatches) -> Option<WatchFlags> {
if matches.get_flag("watch") {
Some(WatchFlags {
hmr: false,
no_clear_screen: matches.get_flag("no-clear-screen"),
exclude: matches
.remove_many::<String>("watch-exclude")
.map(|f| f.collect::<Vec<String>>())
.unwrap_or_default(),
})
} else {
None
}
}
fn watch_arg_parse_with_paths(
matches: &mut ArgMatches,
) -> Option<WatchFlagsWithPaths> {
if let Some(paths) = matches.remove_many::<String>("watch") {
return Some(WatchFlagsWithPaths {
paths: paths.collect(),
hmr: false,
no_clear_screen: matches.get_flag("no-clear-screen"),
exclude: matches
.remove_many::<String>("watch-exclude")
.map(|f| f.collect::<Vec<String>>())
.unwrap_or_default(),
});
}
if matches.try_contains_id("hmr").is_ok() {
return matches.remove_many::<String>("hmr").map(|paths| {
WatchFlagsWithPaths {
paths: paths.collect(),
hmr: true,
no_clear_screen: matches.get_flag("no-clear-screen"),
exclude: matches
.remove_many::<String>("watch-exclude")
.map(|f| f.collect::<Vec<String>>())
.unwrap_or_default(),
}
});
}
None
}
fn unstable_args_parse(
flags: &mut Flags,
matches: &mut ArgMatches,
cfg: UnstableArgsConfig,
) {
if matches.get_flag("unstable") {
flags.unstable_config.legacy_flag_enabled = true;
}
flags.unstable_config.bare_node_builtins =
matches.get_flag("unstable-bare-node-builtins");
flags.unstable_config.byonm = matches.get_flag("unstable-byonm");
flags.unstable_config.sloppy_imports =
matches.get_flag("unstable-sloppy-imports");
if matches!(cfg, UnstableArgsConfig::ResolutionAndRuntime) {
for granular_flag in crate::UNSTABLE_GRANULAR_FLAGS {
if matches.get_flag(&format!("unstable-{}", granular_flag.name)) {
flags
.unstable_config
.features
.push(granular_flag.name.to_string());
}
}
}
}
// TODO(ry) move this to utility module and add test.
/// Strips fragment part of URL. Panics on bad URL.
pub fn resolve_urls(urls: Vec<String>) -> Vec<String> {
let mut out: Vec<String> = vec![];
for urlstr in urls.iter() {
if let Ok(mut url) = Url::from_str(urlstr) {
url.set_fragment(None);
let mut full_url = String::from(url.as_str());
if full_url.len() > 1 && full_url.ends_with('/') {
full_url.pop();
}
out.push(full_url);
} else {
panic!("Bad Url: {urlstr}");
2019-06-05 13:44:46 -04:00
}
}
out
2019-04-29 19:43:06 -04:00
}
#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_eq;
/// Creates vector of strings, Vec<String>
macro_rules! svec {
($($x:expr),* $(,)?) => (vec![$($x.to_string().into()),*]);
2022-02-16 13:14:19 -05:00
}
#[test]
fn global_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "--log-level", "debug", "--quiet", "run", "script.ts"]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string()
)),
log_level: Some(Level::Error),
code_cache_enabled: true,
..Flags::default()
}
);
#[rustfmt::skip]
let r2 = flags_from_vec(svec!["deno", "run", "--log-level", "debug", "--quiet", "script.ts"]);
let flags2 = r2.unwrap();
assert_eq!(flags2, flags);
}
#[test]
fn upgrade() {
let r = flags_from_vec(svec!["deno", "upgrade", "--dry-run", "--force"]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Upgrade(UpgradeFlags {
force: true,
dry_run: true,
canary: false,
release_candidate: false,
version: None,
2020-07-06 18:21:26 -04:00
output: None,
version_or_hash_or_channel: None,
}),
..Flags::default()
}
);
}
#[test]
fn upgrade_with_output_flag() {
let r = flags_from_vec(svec!["deno", "upgrade", "--output", "example.txt"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Upgrade(UpgradeFlags {
force: false,
dry_run: false,
canary: false,
release_candidate: false,
version: None,
output: Some(String::from("example.txt")),
version_or_hash_or_channel: None,
}),
..Flags::default()
}
);
}
#[test]
fn version() {
let r = flags_from_vec(svec!["deno", "--version"]);
2023-03-26 00:06:18 -04:00
assert_eq!(
r.unwrap_err().kind(),
clap::error::ErrorKind::DisplayVersion
);
let r = flags_from_vec(svec!["deno", "-V"]);
2023-03-26 00:06:18 -04:00
assert_eq!(
r.unwrap_err().kind(),
clap::error::ErrorKind::DisplayVersion
);
}
2018-08-24 15:26:40 -04:00
#[test]
fn run_reload() {
let r = flags_from_vec(svec!["deno", "run", "-r", "script.ts"]);
let flags = r.unwrap();
assert_eq!(
flags,
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string()
)),
reload: true,
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2018-10-11 17:23:22 -04:00
#[test]
fn run_watch() {
let r = flags_from_vec(svec!["deno", "run", "--watch", "script.ts"]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: false,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"--watch",
"--no-clear-screen",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: true,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: true,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--watch-hmr",
"--no-clear-screen",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: true,
paths: vec![],
no_clear_screen: true,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--unstable-hmr",
"--no-clear-screen",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: true,
paths: vec![],
no_clear_screen: true,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--watch-hmr=foo.txt",
"--no-clear-screen",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: true,
paths: vec![String::from("foo.txt")],
no_clear_screen: true,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r =
flags_from_vec(svec!["deno", "run", "--hmr", "--watch", "script.ts"]);
assert!(r.is_err());
}
#[test]
fn run_watch_with_external() {
let r = flags_from_vec(svec!["deno", "--watch=file1,file2", "script.ts"]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("file1"), String::from("file2")],
no_clear_screen: false,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: true,
}),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_watch_with_no_clear_screen() {
let r = flags_from_vec(svec![
"deno",
"run",
"--watch",
"--no-clear-screen",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: true,
exclude: vec![],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_watch_with_excluded_paths() {
let r = flags_from_vec(svec!(
"deno",
"--watch",
"--watch-exclude=foo",
"script.ts"
));
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: false,
exclude: vec![String::from("foo")],
}),
2024-08-12 11:55:33 -04:00
bare: true,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!(
"deno",
"run",
"--watch=foo",
"--watch-exclude=bar",
"script.ts"
));
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo")],
no_clear_screen: false,
exclude: vec![String::from("bar")],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--watch",
"--watch-exclude=foo,bar",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: false,
exclude: vec![String::from("foo"), String::from("bar")],
}),
2024-08-12 11:55:33 -04:00
bare: false,
}),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"--watch=foo,bar",
"--watch-exclude=baz,qux",
"script.ts"
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo"), String::from("bar")],
no_clear_screen: false,
exclude: vec![String::from("baz"), String::from("qux"),],
}),
2024-08-12 11:55:33 -04:00
bare: true,
}),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_reload_allow_write() {
let r =
flags_from_vec(svec!["deno", "run", "-r", "--allow-write", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
reload: true,
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string()
)),
permissions: PermissionFlags {
allow_write: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn run_v8_flags() {
let r = flags_from_vec(svec!["deno", "run", "--v8-flags=--help"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default("_".to_string())),
v8_flags: svec!["--help"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
2019-01-09 11:59:54 -05:00
let r = flags_from_vec(svec![
2019-05-03 17:15:16 -04:00
"deno",
"run",
"--v8-flags=--expose-gc,--gc-stats=1",
2019-05-03 17:15:16 -04:00
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
v8_flags: svec!["--expose-gc", "--gc-stats=1"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "run", "--v8-flags=--expose-gc"]);
assert!(r.is_ok());
}
#[test]
fn serve_flags() {
let r = flags_from_vec(svec!["deno", "serve", "main.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
8000,
"0.0.0.0"
)),
permissions: PermissionFlags {
allow_net: Some(vec![
"0.0.0.0:8000".to_string(),
"127.0.0.1:8000".to_string(),
"localhost:8000".to_string()
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "serve", "--port", "5000", "main.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
5000,
"0.0.0.0"
)),
permissions: PermissionFlags {
allow_net: Some(vec![
"0.0.0.0:5000".to_string(),
"127.0.0.1:5000".to_string(),
"localhost:5000".to_string()
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"serve",
"--port",
"5000",
"--allow-net=example.com",
"main.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
5000,
"0.0.0.0"
)),
permissions: PermissionFlags {
allow_net: Some(vec![
"example.com".to_string(),
"0.0.0.0:5000".to_string(),
"127.0.0.1:5000".to_string(),
"localhost:5000".to_string()
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"serve",
"--port",
"5000",
"--allow-net",
"main.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
5000,
"0.0.0.0"
)),
permissions: PermissionFlags {
allow_net: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"serve",
"--port",
"5000",
"--host",
"example.com",
"main.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
5000,
"example.com"
)),
permissions: PermissionFlags {
allow_net: Some(vec!["example.com:5000".to_owned()]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"serve",
"--port",
"0",
"--host",
"example.com",
"main.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Serve(ServeFlags::new_default(
"main.ts".to_string(),
0,
"example.com"
)),
permissions: PermissionFlags {
allow_net: Some(vec!["example.com:0".to_owned()]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn has_permission() {
let r = flags_from_vec(svec!["deno", "--allow-read", "x.ts"]);
assert_eq!(r.unwrap().has_permission(), true);
let r = flags_from_vec(svec!["deno", "run", "--deny-read", "x.ts"]);
assert_eq!(r.unwrap().has_permission(), true);
let r = flags_from_vec(svec!["deno", "run", "x.ts"]);
assert_eq!(r.unwrap().has_permission(), false);
}
#[test]
fn has_permission_in_argv() {
let r = flags_from_vec(svec!["deno", "run", "x.ts", "--allow-read"]);
assert_eq!(r.unwrap().has_permission_in_argv(), true);
let r = flags_from_vec(svec!["deno", "x.ts", "--deny-read"]);
assert_eq!(r.unwrap().has_permission_in_argv(), true);
let r = flags_from_vec(svec!["deno", "run", "x.ts"]);
assert_eq!(r.unwrap().has_permission_in_argv(), false);
}
#[test]
fn script_args() {
let r = flags_from_vec(svec![
2019-05-03 17:15:16 -04:00
"deno",
"run",
"--allow-net",
"gist.ts",
"--title",
"X"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string()
)),
argv: svec!["--title", "X"],
permissions: PermissionFlags {
allow_net: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
2019-04-29 19:43:06 -04:00
);
}
#[test]
fn allow_all() {
let r = flags_from_vec(svec!["deno", "run", "--allow-all", "gist.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string()
)),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
2019-04-29 19:43:06 -04:00
);
}
#[test]
fn allow_read() {
let r = flags_from_vec(svec!["deno", "run", "--allow-read", "gist.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string()
)),
permissions: PermissionFlags {
allow_read: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
2019-04-29 19:43:06 -04:00
);
}
#[test]
fn short_permission_flags() {
let r = flags_from_vec(svec!["deno", "run", "-RNESW", "gist.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string()
)),
permissions: PermissionFlags {
allow_read: Some(vec![]),
allow_write: Some(vec![]),
allow_env: Some(vec![]),
allow_net: Some(vec![]),
allow_sys: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_read() {
let r = flags_from_vec(svec!["deno", "--deny-read", "gist.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "gist.ts".to_string(),
watch: None,
bare: true,
}),
permissions: PermissionFlags {
deny_read: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_hrtime() {
let r = flags_from_vec(svec!["deno", "run", "--allow-hrtime", "gist.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string(),
)),
permissions: PermissionFlags {
allow_hrtime: true,
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
2019-04-29 19:43:06 -04:00
);
}
#[test]
fn deny_hrtime() {
let r = flags_from_vec(svec!["deno", "run", "--deny-hrtime", "gist.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"gist.ts".to_string(),
)),
permissions: PermissionFlags {
deny_hrtime: true,
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn double_hyphen() {
// notice that flags passed after double dash will not
2020-02-26 05:52:15 -05:00
// be parsed to Flags but instead forwarded to
// script args as Deno.args
let r = flags_from_vec(svec![
"deno",
2019-05-03 17:15:16 -04:00
"run",
"--allow-write",
"script.ts",
"--",
"-D",
"--allow-net"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
argv: svec!["--", "-D", "--allow-net"],
permissions: PermissionFlags {
allow_write: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
2019-04-29 19:43:06 -04:00
);
}
#[test]
fn fmt() {
let r = flags_from_vec(svec!["deno", "fmt", "script_1.ts", "script_2.ts"]);
2019-04-29 19:43:06 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec!["script_1.ts".to_string(), "script_2.ts".to_string()],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "fmt", "--check"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: true,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-04-29 19:43:06 -04:00
}
);
let r = flags_from_vec(svec!["deno", "fmt"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "fmt", "--watch"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Some(Default::default()),
}),
ext: Some("ts".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"fmt",
"--watch",
"--no-clear-screen",
"--unstable-css",
"--unstable-html",
"--unstable-component",
"--unstable-yaml"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: true,
unstable_html: true,
unstable_component: true,
unstable_yaml: true,
watch: Some(WatchFlags {
hmr: false,
no_clear_screen: true,
exclude: vec![],
})
}),
ext: Some("ts".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"fmt",
"--check",
"--watch",
"foo.ts",
"--ignore=bar.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: true,
files: FileFlags {
include: vec!["foo.ts".to_string()],
ignore: vec!["bar.js".to_string()],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Some(Default::default()),
}),
ext: Some("ts".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "fmt", "--config", "deno.jsonc"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
config_flag: ConfigFlag::Path("deno.jsonc".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"fmt",
"--config",
"deno.jsonc",
"--watch",
"foo.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec!["foo.ts".to_string()],
ignore: vec![],
},
use_tabs: None,
line_width: None,
indent_width: None,
single_quote: None,
prose_wrap: None,
no_semicolons: None,
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Some(Default::default()),
}),
config_flag: ConfigFlag::Path("deno.jsonc".to_string()),
ext: Some("ts".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"fmt",
"--use-tabs",
"--line-width",
"60",
"--indent-width",
"4",
"--single-quote",
"--prose-wrap",
"never",
"--no-semicolons",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: Some(true),
line_width: Some(NonZeroU32::new(60).unwrap()),
indent_width: Some(NonZeroU8::new(4).unwrap()),
single_quote: Some(true),
prose_wrap: Some("never".to_string()),
no_semicolons: Some(true),
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
..Flags::default()
}
);
// try providing =false to the booleans
let r = flags_from_vec(svec![
"deno",
"fmt",
"--use-tabs=false",
"--single-quote=false",
"--no-semicolons=false",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Fmt(FmtFlags {
check: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
use_tabs: Some(false),
line_width: None,
indent_width: None,
single_quote: Some(false),
prose_wrap: None,
no_semicolons: Some(false),
unstable_css: false,
unstable_html: false,
unstable_component: false,
unstable_yaml: false,
watch: Default::default(),
}),
ext: Some("ts".to_string()),
..Flags::default()
}
);
2019-04-29 19:43:06 -04:00
}
#[test]
fn lint() {
let r = flags_from_vec(svec!["deno", "lint", "script_1.ts", "script_2.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string(), "script_2.ts".to_string(),],
ignore: vec![],
},
fix: false,
2020-06-12 10:42:12 -04:00
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Default::default(),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--watch",
"script_1.ts",
"script_2.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string(), "script_2.ts".to_string()],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Some(Default::default()),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--watch",
"--no-clear-screen",
"script_1.ts",
"script_2.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string(), "script_2.ts".to_string()],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Some(WatchFlags {
hmr: false,
no_clear_screen: true,
exclude: vec![],
}),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--fix",
"--ignore=script_1.ts,script_2.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec![],
ignore: vec!["script_1.ts".to_string(), "script_2.ts".to_string()],
},
fix: true,
2020-06-12 10:42:12 -04:00
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Default::default(),
ext: None,
}),
2020-06-12 10:42:12 -04:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "lint", "--rules"]);
2020-06-12 10:42:12 -04:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec![],
ignore: vec![],
},
fix: false,
rules: true,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Default::default(),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--rules",
"--rules-tags=recommended"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec![],
ignore: vec![],
},
fix: false,
rules: true,
maybe_rules_tags: Some(svec!["recommended"]),
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: false,
watch: Default::default(),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--rules-tags=",
"--rules-include=ban-untagged-todo,no-undef",
"--rules-exclude=no-const-assign"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec![],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: Some(svec![""]),
maybe_rules_include: Some(svec!["ban-untagged-todo", "no-undef"]),
maybe_rules_exclude: Some(svec!["no-const-assign"]),
json: false,
compact: false,
watch: Default::default(),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "lint", "--json", "script_1.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string()],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: true,
compact: false,
watch: Default::default(),
ext: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--config",
"Deno.jsonc",
"--json",
"script_1.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string()],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: true,
compact: false,
watch: Default::default(),
ext: None,
}),
config_flag: ConfigFlag::Path("Deno.jsonc".to_string()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"lint",
"--config",
"Deno.jsonc",
"--compact",
"script_1.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Lint(LintFlags {
files: FileFlags {
include: vec!["script_1.ts".to_string()],
ignore: vec![],
},
fix: false,
rules: false,
maybe_rules_tags: None,
maybe_rules_include: None,
maybe_rules_exclude: None,
json: false,
compact: true,
watch: Default::default(),
ext: None,
}),
config_flag: ConfigFlag::Path("Deno.jsonc".to_string()),
..Flags::default()
}
);
}
2019-04-29 19:43:06 -04:00
#[test]
fn types() {
let r = flags_from_vec(svec!["deno", "types"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Types,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
2019-04-29 19:43:06 -04:00
}
#[test]
fn cache() {
let r = flags_from_vec(svec!["deno", "cache", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Cache(CacheFlags {
files: svec!["script.ts"],
}),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
2019-04-29 19:43:06 -04:00
}
#[test]
fn check() {
let r = flags_from_vec(svec!["deno", "check", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Check(CheckFlags {
files: svec!["script.ts"],
}),
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
for all_flag in ["--remote", "--all"] {
let r = flags_from_vec(svec!["deno", "check", all_flag, "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Check(CheckFlags {
files: svec!["script.ts"],
}),
type_check_mode: TypeCheckMode::All,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"check",
all_flag,
"--no-remote",
"script.ts"
]);
2023-03-26 00:06:18 -04:00
assert_eq!(
r.unwrap_err().kind(),
clap::error::ErrorKind::ArgumentConflict
);
}
}
2019-04-29 19:43:06 -04:00
#[test]
fn info() {
let r = flags_from_vec(svec!["deno", "info", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: false,
file: Some("script.ts".to_string()),
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "info", "--reload", "script.ts"]);
2020-08-12 06:58:50 -04:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
2020-08-12 06:58:50 -04:00
json: false,
file: Some("script.ts".to_string()),
}),
2020-08-12 06:58:50 -04:00
reload: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "info", "--json", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: true,
file: Some("script.ts".to_string()),
}),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "info"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: false,
file: None
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "info", "--json"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: true,
file: None
}),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"info",
"--no-npm",
"--no-remote",
"--config",
"tsconfig.json"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: false,
file: None
}),
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
no_npm: true,
no_remote: true,
..Flags::default()
}
);
}
2019-05-03 16:24:09 -04:00
#[test]
fn tsconfig() {
let r =
flags_from_vec(svec!["deno", "run", "-c", "tsconfig.json", "script.ts"]);
2019-05-03 17:15:16 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-05-03 17:15:16 -04:00
}
);
}
#[test]
fn eval() {
let r = flags_from_vec(svec!["deno", "eval", "'console.log(\"hello\")'"]);
2019-05-03 17:15:16 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Eval(EvalFlags {
2020-05-21 10:35:36 -04:00
print: false,
code: "'console.log(\"hello\")'".to_string(),
}),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
..Flags::default()
}
);
}
2020-05-21 10:35:36 -04:00
#[test]
fn eval_p() {
let r = flags_from_vec(svec!["deno", "eval", "-p", "1+2"]);
2020-05-21 10:35:36 -04:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Eval(EvalFlags {
2020-05-21 10:35:36 -04:00
print: true,
code: "1+2".to_string(),
}),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
2020-05-21 10:35:36 -04:00
..Flags::default()
}
);
}
#[test]
fn eval_typescript() {
let r =
flags_from_vec(svec!["deno", "eval", "-T", "'console.log(\"hello\")'"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Eval(EvalFlags {
2020-05-21 10:35:36 -04:00
print: false,
code: "'console.log(\"hello\")'".to_string(),
}),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
ext: Some("ts".to_string()),
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-05-03 17:15:16 -04:00
}
);
}
#[test]
fn eval_with_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "eval", "--import-map", "import_map.json", "--no-remote", "--config", "tsconfig.json", "--no-check", "--reload", "--lock", "lock.json", "--cert", "example.crt", "--cached-only", "--location", "https:foo", "--v8-flags=--help", "--seed", "1", "--inspect=127.0.0.1:9229", "--env=.example.env", "42"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Eval(EvalFlags {
2020-05-21 10:35:36 -04:00
print: false,
code: "42".to_string(),
}),
import_map_path: Some("import_map.json".to_string()),
no_remote: true,
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
type_check_mode: TypeCheckMode::None,
reload: true,
lock: Some(String::from("lock.json")),
ca_data: Some(CaData::File("example.crt".to_string())),
cached_only: true,
location: Some(Url::parse("https://foo/").unwrap()),
v8_flags: svec!["--help", "--random-seed=1"],
seed: Some(1),
inspect: Some("127.0.0.1:9229".parse().unwrap()),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
env_file: Some(".example.env".to_owned()),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn eval_args() {
let r = flags_from_vec(svec![
"deno",
"eval",
"console.log(Deno.args)",
"arg1",
"arg2"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Eval(EvalFlags {
print: false,
code: "console.log(Deno.args)".to_string(),
}),
argv: svec!["arg1", "arg2"],
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
..Flags::default()
}
);
}
2019-05-03 17:15:16 -04:00
#[test]
fn repl() {
let r = flags_from_vec(svec!["deno"]);
2019-05-03 17:15:16 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: None,
is_default_command: true,
}),
unsafely_ignore_certificate_errors: None,
permissions: PermissionFlags {
allow_net: Some(vec![]),
allow_env: Some(vec![]),
deny_env: None,
allow_run: Some(vec![]),
deny_run: None,
allow_read: Some(vec![]),
deny_read: None,
allow_sys: Some(vec![]),
deny_sys: None,
allow_write: Some(vec![]),
deny_write: None,
allow_ffi: Some(vec![]),
deny_ffi: None,
allow_hrtime: true,
..Default::default()
},
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-05-03 17:15:16 -04:00
}
);
}
#[test]
fn repl_strace_ops() {
// Lightly test this undocumented flag
let r = flags_from_vec(svec!["deno", "repl", "--strace-ops"]);
assert_eq!(r.unwrap().strace_ops, Some(vec![]));
let r =
flags_from_vec(svec!["deno", "repl", "--strace-ops=http,websocket"]);
assert_eq!(
r.unwrap().strace_ops,
Some(vec!["http".to_string(), "websocket".to_string()])
);
}
#[test]
fn repl_with_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "repl", "-A", "--import-map", "import_map.json", "--no-remote", "--config", "tsconfig.json", "--no-check", "--reload", "--lock", "lock.json", "--cert", "example.crt", "--cached-only", "--location", "https:foo", "--v8-flags=--help", "--seed", "1", "--inspect=127.0.0.1:9229", "--unsafely-ignore-certificate-errors", "--env=.example.env"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: None,
is_default_command: false,
}),
import_map_path: Some("import_map.json".to_string()),
no_remote: true,
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
type_check_mode: TypeCheckMode::None,
reload: true,
lock: Some(String::from("lock.json")),
ca_data: Some(CaData::File("example.crt".to_string())),
cached_only: true,
location: Some(Url::parse("https://foo/").unwrap()),
v8_flags: svec!["--help", "--random-seed=1"],
seed: Some(1),
inspect: Some("127.0.0.1:9229".parse().unwrap()),
permissions: PermissionFlags {
allow_all: true,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
env_file: Some(".example.env".to_owned()),
unsafely_ignore_certificate_errors: Some(vec![]),
..Flags::default()
}
);
}
#[test]
fn repl_with_eval_flag() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "repl", "--allow-write", "--eval", "console.log('hello');"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: Some("console.log('hello');".to_string()),
is_default_command: false,
}),
permissions: PermissionFlags {
allow_write: Some(vec![]),
..Default::default()
},
type_check_mode: TypeCheckMode::None,
..Flags::default()
}
);
}
#[test]
fn repl_with_eval_file_flag() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "repl", "--eval-file=./a.js,./b.ts,https://examples.deno.land/hello-world.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: Some(vec![
"./a.js".to_string(),
"./b.ts".to_string(),
"https://examples.deno.land/hello-world.ts".to_string()
]),
eval: None,
is_default_command: false,
}),
type_check_mode: TypeCheckMode::None,
..Flags::default()
}
);
}
#[test]
fn allow_read_allowlist() {
use test_util::TempDir;
let temp_dir_guard = TempDir::new();
let temp_dir = temp_dir_guard.path().to_string();
let r = flags_from_vec(svec![
"deno",
"run",
format!("--allow-read=.,{}", temp_dir),
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
permissions: PermissionFlags {
allow_read: Some(vec![String::from("."), temp_dir]),
..Default::default()
},
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2019-06-09 09:08:20 -04:00
#[test]
fn deny_read_denylist() {
use test_util::TempDir;
let temp_dir_guard = TempDir::new();
let temp_dir = temp_dir_guard.path().to_string();
let r = flags_from_vec(svec![
"deno",
"run",
format!("--deny-read=.,{}", temp_dir),
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
permissions: PermissionFlags {
deny_read: Some(vec![String::from("."), temp_dir]),
..Default::default()
},
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_write_allowlist() {
use test_util::TempDir;
let temp_dir_guard = TempDir::new();
let temp_dir = temp_dir_guard.path().to_string();
let r = flags_from_vec(svec![
"deno",
"run",
format!("--allow-write=.,{}", temp_dir),
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
permissions: PermissionFlags {
allow_write: Some(vec![String::from("."), temp_dir]),
..Default::default()
},
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2019-06-09 09:08:20 -04:00
#[test]
fn deny_write_denylist() {
use test_util::TempDir;
let temp_dir_guard = TempDir::new();
let temp_dir = temp_dir_guard.path().to_string();
let r = flags_from_vec(svec![
"deno",
"run",
format!("--deny-write=.,{}", temp_dir),
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
permissions: PermissionFlags {
deny_write: Some(vec![String::from("."), temp_dir]),
..Default::default()
},
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_net_allowlist() {
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-net=127.0.0.1",
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_net: Some(svec!["127.0.0.1"]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2019-06-01 08:54:32 -04:00
#[test]
fn deny_net_denylist() {
let r = flags_from_vec(svec!["deno", "--deny-net=127.0.0.1", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
permissions: PermissionFlags {
deny_net: Some(svec!["127.0.0.1"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_env_allowlist() {
let r =
flags_from_vec(svec!["deno", "run", "--allow-env=HOME", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_env: Some(svec!["HOME"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_env_denylist() {
let r =
flags_from_vec(svec!["deno", "run", "--deny-env=HOME", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_env: Some(svec!["HOME"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_env_allowlist_multiple() {
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-env=HOME,PATH",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_env: Some(svec!["HOME", "PATH"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_env_denylist_multiple() {
let r =
flags_from_vec(svec!["deno", "run", "--deny-env=HOME,PATH", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_env: Some(svec!["HOME", "PATH"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_env_allowlist_validator() {
let r =
flags_from_vec(svec!["deno", "run", "--allow-env=HOME", "script.ts"]);
assert!(r.is_ok());
let r = flags_from_vec(svec!["deno", "--allow-env=H=ME", "script.ts"]);
assert!(r.is_err());
let r =
flags_from_vec(svec!["deno", "run", "--allow-env=H\0ME", "script.ts"]);
assert!(r.is_err());
}
#[test]
fn deny_env_denylist_validator() {
let r =
flags_from_vec(svec!["deno", "run", "--deny-env=HOME", "script.ts"]);
assert!(r.is_ok());
let r =
flags_from_vec(svec!["deno", "run", "--deny-env=H=ME", "script.ts"]);
assert!(r.is_err());
let r = flags_from_vec(svec!["deno", "--deny-env=H\0ME", "script.ts"]);
assert!(r.is_err());
}
#[test]
fn allow_sys() {
let r = flags_from_vec(svec!["deno", "run", "--allow-sys", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_sys: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_sys() {
let r = flags_from_vec(svec!["deno", "run", "--deny-sys", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_sys: Some(vec![]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_sys_allowlist() {
let r =
flags_from_vec(svec!["deno", "run", "--allow-sys=hostname", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_sys: Some(svec!["hostname"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_sys_denylist() {
let r = flags_from_vec(svec!["deno", "--deny-sys=hostname", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
permissions: PermissionFlags {
deny_sys: Some(svec!["hostname"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_sys_allowlist_multiple() {
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-sys=hostname,osRelease",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_sys: Some(svec!["hostname", "osRelease"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_sys_denylist_multiple() {
let r = flags_from_vec(svec![
"deno",
"run",
"--deny-sys=hostname,osRelease",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_sys: Some(svec!["hostname", "osRelease"]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_sys_allowlist_validator() {
let r =
flags_from_vec(svec!["deno", "run", "--allow-sys=hostname", "script.ts"]);
assert!(r.is_ok());
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-sys=hostname,osRelease",
"script.ts"
]);
assert!(r.is_ok());
let r =
flags_from_vec(svec!["deno", "run", "--allow-sys=foo", "script.ts"]);
assert!(r.is_err());
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-sys=hostname,foo",
"script.ts"
]);
assert!(r.is_err());
}
#[test]
fn deny_sys_denylist_validator() {
let r =
flags_from_vec(svec!["deno", "run", "--deny-sys=hostname", "script.ts"]);
assert!(r.is_ok());
let r = flags_from_vec(svec![
"deno",
"run",
"--deny-sys=hostname,osRelease",
"script.ts"
]);
assert!(r.is_ok());
let r = flags_from_vec(svec!["deno", "run", "--deny-sys=foo", "script.ts"]);
assert!(r.is_err());
let r = flags_from_vec(svec![
"deno",
"run",
"--deny-sys=hostname,foo",
"script.ts"
]);
assert!(r.is_err());
}
#[test]
fn reload_validator() {
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=http://deno.land/",
"script.ts"
]);
assert!(r.is_ok(), "should accept valid urls");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=http://deno.land/a,http://deno.land/b",
"script.ts"
]);
assert!(r.is_ok(), "should accept accept multiple valid urls");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=./relativeurl/",
"script.ts"
]);
assert!(r.is_err(), "Should reject relative urls that start with ./");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=relativeurl/",
"script.ts"
]);
assert!(r.is_err(), "Should reject relative urls");
let r =
flags_from_vec(svec!["deno", "run", "--reload=/absolute", "script.ts"]);
assert!(r.is_err(), "Should reject absolute urls");
let r = flags_from_vec(svec!["deno", "--reload=/", "script.ts"]);
assert!(r.is_err(), "Should reject absolute root url");
let r = flags_from_vec(svec!["deno", "run", "--reload=", "script.ts"]);
assert!(r.is_err(), "Should reject when nothing is provided");
let r = flags_from_vec(svec!["deno", "run", "--reload=,", "script.ts"]);
assert!(r.is_err(), "Should reject when a single comma is provided");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=,http://deno.land/a",
"script.ts"
]);
assert!(r.is_err(), "Should reject a leading comma");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=http://deno.land/a,",
"script.ts"
]);
assert!(r.is_err(), "Should reject a trailing comma");
let r = flags_from_vec(svec![
"deno",
"run",
"--reload=http://deno.land/a,,http://deno.land/b",
"script.ts"
]);
assert!(r.is_err(), "Should reject adjacent commas");
}
2019-06-08 14:42:28 -04:00
#[test]
fn bundle() {
let r = flags_from_vec(svec!["deno", "bundle", "source.ts"]);
2019-06-08 14:42:28 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: None,
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::Local,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn bundle_with_config() {
let r = flags_from_vec(svec![
"deno",
"bundle",
"--no-remote",
"--config",
"tsconfig.json",
"source.ts",
"bundle.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: Some("bundle.js".to_string()),
watch: Default::default(),
}),
permissions: PermissionFlags {
allow_write: Some(vec![]),
..Default::default()
},
no_remote: true,
type_check_mode: TypeCheckMode::Local,
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
..Flags::default()
}
);
}
#[test]
fn bundle_with_output() {
let r = flags_from_vec(svec!["deno", "bundle", "source.ts", "bundle.js"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: Some("bundle.js".to_string()),
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
allow_write: Some(vec![]),
..Default::default()
},
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn bundle_with_lock() {
let r =
flags_from_vec(svec!["deno", "bundle", "--lock=lock.json", "source.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: None,
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::Local,
lock: Some(String::from("lock.json")),
..Flags::default()
2019-06-08 14:42:28 -04:00
}
);
}
2019-06-09 09:08:20 -04:00
#[test]
fn bundle_with_reload() {
let r = flags_from_vec(svec!["deno", "bundle", "--reload", "source.ts"]);
assert_eq!(
r.unwrap(),
Flags {
reload: true,
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: None,
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn bundle_nocheck() {
let r = flags_from_vec(svec!["deno", "bundle", "--no-check", "script.ts"])
.unwrap();
assert_eq!(
r,
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "script.ts".to_string(),
out_file: None,
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::None,
..Flags::default()
}
);
}
#[test]
fn bundle_watch() {
let r = flags_from_vec(svec!["deno", "bundle", "--watch", "source.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: None,
watch: Some(Default::default()),
}),
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
)
}
#[test]
fn bundle_watch_with_no_clear_screen() {
let r = flags_from_vec(svec![
"deno",
"bundle",
"--watch",
"--no-clear-screen",
"source.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
source_file: "source.ts".to_string(),
out_file: None,
watch: Some(WatchFlags {
hmr: false,
no_clear_screen: true,
exclude: vec![],
}),
}),
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
)
}
2019-06-09 09:08:20 -04:00
#[test]
fn run_import_map() {
let r = flags_from_vec(svec![
2019-06-09 09:08:20 -04:00
"deno",
"run",
"--import-map=import_map.json",
2019-06-09 09:08:20 -04:00
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
import_map_path: Some("import_map.json".to_owned()),
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-06-09 09:08:20 -04:00
}
);
}
2019-06-09 09:08:20 -04:00
#[test]
fn info_import_map() {
let r = flags_from_vec(svec![
"deno",
"info",
"--import-map=import_map.json",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
file: Some("script.ts".to_string()),
json: false,
}),
import_map_path: Some("import_map.json".to_owned()),
..Flags::default()
}
);
}
#[test]
fn cache_import_map() {
let r = flags_from_vec(svec![
2019-07-27 10:37:03 -04:00
"deno",
"cache",
"--import-map=import_map.json",
2019-07-27 10:37:03 -04:00
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Cache(CacheFlags {
files: svec!["script.ts"],
}),
import_map_path: Some("import_map.json".to_owned()),
..Flags::default()
}
);
}
#[test]
fn doc_import_map() {
let r = flags_from_vec(svec![
"deno",
"doc",
"--import-map=import_map.json",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
source_files: DocSourceFileFlag::Paths(vec!["script.ts".to_owned()]),
private: false,
json: false,
html: None,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
filter: None,
}),
import_map_path: Some("import_map.json".to_owned()),
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-07-27 10:37:03 -04:00
}
);
2019-06-09 09:08:20 -04:00
}
#[test]
fn run_env_default() {
let r = flags_from_vec(svec!["deno", "run", "--env", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
env_file: Some(".env".to_owned()),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_env_file_default() {
let r = flags_from_vec(svec!["deno", "run", "--env-file", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
env_file: Some(".env".to_owned()),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_no_code_cache() {
let r = flags_from_vec(svec!["deno", "--no-code-cache", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
..Flags::default()
}
);
}
#[test]
fn run_env_defined() {
let r =
flags_from_vec(svec!["deno", "run", "--env=.another_env", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
env_file: Some(".another_env".to_owned()),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_env_file_defined() {
let r = flags_from_vec(svec![
"deno",
"run",
"--env-file=.another_env",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
env_file: Some(".another_env".to_owned()),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn cache_multiple() {
let r =
flags_from_vec(svec!["deno", "cache", "script.ts", "script_two.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Cache(CacheFlags {
files: svec!["script.ts", "script_two.ts"],
}),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn run_seed() {
let r = flags_from_vec(svec!["deno", "run", "--seed", "250", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
2020-11-27 14:47:35 -05:00
seed: Some(250_u64),
v8_flags: svec!["--random-seed=250"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn run_seed_with_v8_flags() {
let r = flags_from_vec(svec![
"deno",
"run",
"--seed",
"250",
"--v8-flags=--expose-gc",
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
2020-11-27 14:47:35 -05:00
seed: Some(250_u64),
v8_flags: svec!["--expose-gc", "--random-seed=250"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
2019-06-15 10:08:11 -04:00
}
#[test]
fn install() {
let r =
flags_from_vec(svec!["deno", "install", "jsr:@std/http/file-server"]);
2019-06-15 10:08:11 -04:00
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Install(InstallFlags {
kind: InstallKind::Global(InstallFlagsGlobal {
name: None,
module_url: "jsr:@std/http/file-server".to_string(),
args: vec![],
root: None,
force: false,
}),
global: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"install",
"-g",
"jsr:@std/http/file-server"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Install(InstallFlags {
kind: InstallKind::Global(InstallFlagsGlobal {
name: None,
module_url: "jsr:@std/http/file-server".to_string(),
args: vec![],
root: None,
force: false,
}),
global: true,
}),
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-06-15 10:08:11 -04:00
}
);
}
2019-06-15 10:08:11 -04:00
#[test]
fn install_with_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "install", "--import-map", "import_map.json", "--no-remote", "--config", "tsconfig.json", "--no-check", "--unsafely-ignore-certificate-errors", "--reload", "--lock", "lock.json", "--cert", "example.crt", "--cached-only", "--allow-read", "--allow-net", "--v8-flags=--help", "--seed", "1", "--inspect=127.0.0.1:9229", "--name", "file_server", "--root", "/foo", "--force", "--env=.example.env", "jsr:@std/http/file-server", "foo", "bar"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Install(InstallFlags {
kind: InstallKind::Global(InstallFlagsGlobal {
name: Some("file_server".to_string()),
module_url: "jsr:@std/http/file-server".to_string(),
args: svec!["foo", "bar"],
root: Some("/foo".to_string()),
force: true,
}),
global: false,
}),
import_map_path: Some("import_map.json".to_string()),
no_remote: true,
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
type_check_mode: TypeCheckMode::None,
reload: true,
lock: Some(String::from("lock.json")),
ca_data: Some(CaData::File("example.crt".to_string())),
cached_only: true,
v8_flags: svec!["--help", "--random-seed=1"],
seed: Some(1),
inspect: Some("127.0.0.1:9229".parse().unwrap()),
unsafely_ignore_certificate_errors: Some(vec![]),
permissions: PermissionFlags {
allow_net: Some(vec![]),
allow_read: Some(vec![]),
..Default::default()
},
env_file: Some(".example.env".to_owned()),
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn uninstall() {
let r = flags_from_vec(svec!["deno", "uninstall", "file_server"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Uninstall(UninstallFlags {
kind: UninstallKind::Global(UninstallFlagsGlobal {
name: "file_server".to_string(),
root: None,
}),
global: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "uninstall", "-g", "file_server"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Uninstall(UninstallFlags {
kind: UninstallKind::Global(UninstallFlagsGlobal {
name: "file_server".to_string(),
root: None,
}),
global: true,
}),
..Flags::default()
}
);
}
#[test]
fn uninstall_with_help_flag() {
let r = flags_from_vec(svec!["deno", "uninstall", "--help"]);
assert!(r.is_ok());
}
#[test]
fn log_level() {
let r =
flags_from_vec(svec!["deno", "run", "--log-level=debug", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
log_level: Some(Level::Debug),
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2019-06-26 06:02:13 -04:00
2020-03-10 08:26:17 -04:00
#[test]
fn quiet() {
let r = flags_from_vec(svec!["deno", "-q", "script.ts"]);
2020-03-10 08:26:17 -04:00
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
2020-03-10 08:26:17 -04:00
log_level: Some(Level::Error),
code_cache_enabled: true,
2020-03-10 08:26:17 -04:00
..Flags::default()
}
);
}
2019-06-26 06:02:13 -04:00
#[test]
fn completions() {
let r = flags_from_vec(svec!["deno", "completions", "zsh"]).unwrap();
match r.subcommand {
DenoSubcommand::Completions(CompletionsFlags { buf }) => {
assert!(!buf.is_empty())
}
_ => unreachable!(),
}
2019-06-26 06:02:13 -04:00
}
#[test]
fn run_with_args() {
let r = flags_from_vec(svec![
"deno",
"run",
"script.ts",
"--allow-read",
"--allow-net"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
argv: svec!["--allow-read", "--allow-net"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--location",
"https:foo",
"--allow-read",
"script.ts",
"--allow-net",
"-r",
"--help",
"--foo",
"bar"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
location: Some(Url::parse("https://foo/").unwrap()),
permissions: PermissionFlags {
allow_read: Some(vec![]),
..Default::default()
},
argv: svec!["--allow-net", "-r", "--help", "--foo", "bar"],
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "run", "script.ts", "foo", "bar"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
argv: svec!["foo", "bar"],
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "run", "script.ts", "-"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
argv: svec!["-"],
code_cache_enabled: true,
..Flags::default()
}
);
let r =
flags_from_vec(svec!["deno", "run", "script.ts", "-", "foo", "bar"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
argv: svec!["-", "foo", "bar"],
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn no_check() {
let r = flags_from_vec(svec!["deno", "--no-check", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
type_check_mode: TypeCheckMode::None,
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn no_check_remote() {
let r =
flags_from_vec(svec!["deno", "run", "--no-check=remote", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
type_check_mode: TypeCheckMode::Local,
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn repl_with_unsafely_ignore_certificate_errors() {
let r = flags_from_vec(svec![
"deno",
"repl",
"--eval",
"console.log('hello');",
"--unsafely-ignore-certificate-errors"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: Some("console.log('hello');".to_string()),
is_default_command: false,
}),
unsafely_ignore_certificate_errors: Some(vec![]),
type_check_mode: TypeCheckMode::None,
..Flags::default()
}
);
}
#[test]
fn run_with_unsafely_ignore_certificate_errors() {
let r = flags_from_vec(svec![
"deno",
"run",
"--unsafely-ignore-certificate-errors",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
unsafely_ignore_certificate_errors: Some(vec![]),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn run_with_unsafely_treat_insecure_origin_as_secure_with_ipv6_address() {
let r = flags_from_vec(svec![
"deno",
"run",
"--unsafely-ignore-certificate-errors=deno.land,localhost,[::],127.0.0.1,[::1],1.2.3.4",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
unsafely_ignore_certificate_errors: Some(svec![
"deno.land",
"localhost",
"[::]",
"127.0.0.1",
"[::1]",
"1.2.3.4"
]),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn repl_with_unsafely_treat_insecure_origin_as_secure_with_ipv6_address() {
let r = flags_from_vec(svec![
"deno",
"repl",
"--unsafely-ignore-certificate-errors=deno.land,localhost,[::],127.0.0.1,[::1],1.2.3.4"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: None,
is_default_command: false,
}),
unsafely_ignore_certificate_errors: Some(svec![
"deno.land",
"localhost",
"[::]",
"127.0.0.1",
"[::1]",
"1.2.3.4"
]),
type_check_mode: TypeCheckMode::None,
..Flags::default()
}
);
}
#[test]
fn no_remote() {
let r = flags_from_vec(svec!["deno", "run", "--no-remote", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
no_remote: true,
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
#[test]
fn no_npm() {
let r = flags_from_vec(svec!["deno", "run", "--no-npm", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
no_npm: true,
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn local_npm() {
let r = flags_from_vec(svec!["deno", "--node-modules-dir", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
node_modules_dir: Some(true),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--node-modules-dir=false",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
node_modules_dir: Some(false),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn vendor_flag() {
let r = flags_from_vec(svec!["deno", "run", "--vendor", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
vendor: Some(true),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "run", "--vendor=false", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
vendor: Some(false),
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn cached_only() {
let r = flags_from_vec(svec!["deno", "run", "--cached-only", "script.ts"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
cached_only: true,
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
}
);
}
2019-07-31 11:02:20 -04:00
2019-10-12 17:13:52 -04:00
#[test]
fn allow_net_allowlist_with_ports() {
let r = flags_from_vec(svec![
2019-10-12 17:13:52 -04:00
"deno",
"run",
2019-10-12 17:13:52 -04:00
"--allow-net=deno.land,:8000,:4545",
"script.ts"
]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_net: Some(svec![
"deno.land",
"0.0.0.0:8000",
"127.0.0.1:8000",
"localhost:8000",
"0.0.0.0:4545",
"127.0.0.1:4545",
"localhost:4545"
]),
..Default::default()
},
code_cache_enabled: true,
2020-02-26 05:52:15 -05:00
..Flags::default()
2019-10-12 17:13:52 -04:00
}
);
}
#[test]
fn deny_net_denylist_with_ports() {
let r = flags_from_vec(svec![
"deno",
"run",
"--deny-net=deno.land,:8000,:4545",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_net: Some(svec![
"deno.land",
"0.0.0.0:8000",
"127.0.0.1:8000",
"localhost:8000",
"0.0.0.0:4545",
"127.0.0.1:4545",
"localhost:4545"
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn allow_net_allowlist_with_ipv6_address() {
let r = flags_from_vec(svec![
"deno",
"run",
"--allow-net=deno.land,deno.land:80,[::],127.0.0.1,[::1],1.2.3.4:5678,:5678,[::1]:8080",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
allow_net: Some(svec![
"deno.land",
"deno.land:80",
"[::]",
"127.0.0.1",
"[::1]",
"1.2.3.4:5678",
"0.0.0.0:5678",
"127.0.0.1:5678",
"localhost:5678",
"[::1]:8080"
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn deny_net_denylist_with_ipv6_address() {
let r = flags_from_vec(svec![
"deno",
"run",
"--deny-net=deno.land,deno.land:80,[::],127.0.0.1,[::1],1.2.3.4:5678,:5678,[::1]:8080",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
permissions: PermissionFlags {
deny_net: Some(svec![
"deno.land",
"deno.land:80",
"[::]",
"127.0.0.1",
"[::1]",
"1.2.3.4:5678",
"0.0.0.0:5678",
"127.0.0.1:5678",
"localhost:5678",
"[::1]:8080"
]),
..Default::default()
},
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn test_no_colon_in_value_name() {
2024-08-12 11:55:33 -04:00
let app =
runtime_args(Command::new("test_inspect_completion_value"), true, true);
let inspect_args = app
.get_arguments()
.filter(|arg| arg.get_id() == "inspect")
.collect::<Vec<_>>();
// The value_name cannot have a : otherwise it breaks shell completions for zsh.
let value_name = "HOST_AND_PORT";
let arg = inspect_args
.iter()
.any(|v| v.get_value_names().unwrap() == [value_name]);
assert_eq!(arg, true);
}
#[test]
fn test_with_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "test", "--unstable", "--no-npm", "--no-remote", "--trace-leaks", "--no-run", "--filter", "- foo", "--coverage=cov", "--clean", "--location", "https:foo", "--allow-net", "--permit-no-files", "dir1/", "dir2/", "--", "arg1", "arg2"]);
assert_eq!(
r.unwrap(),
2020-02-26 05:52:15 -05:00
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: true,
doc: false,
fail_fast: None,
filter: Some("- foo".to_string()),
allow_none: true,
files: FileFlags {
include: vec!["dir1/".to_string(), "dir2/".to_string()],
ignore: vec![],
},
shuffle: None,
concurrent_jobs: None,
trace_leaks: true,
coverage_dir: Some("cov".to_string()),
clean: true,
watch: Default::default(),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
unstable_config: UnstableConfig {
legacy_flag_enabled: true,
..Default::default()
},
no_npm: true,
no_remote: true,
location: Some(Url::parse("https://foo/").unwrap()),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
allow_net: Some(vec![]),
..Default::default()
},
argv: svec!["arg1", "arg2"],
..Flags::default()
}
);
}
2020-04-02 09:26:40 -04:00
#[test]
fn run_with_cafile() {
let r = flags_from_vec(svec![
2020-04-02 09:26:40 -04:00
"deno",
"run",
"--cert",
"example.crt",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
ca_data: Some(CaData::File("example.crt".to_owned())),
code_cache_enabled: true,
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
}
#[test]
fn run_with_enable_testing_features() {
let r = flags_from_vec(svec![
"deno",
"run",
"--enable-testing-features-do-not-use",
"script.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
enable_testing_features: true,
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn test_with_concurrent_jobs() {
let r = flags_from_vec(svec!["deno", "test", "--jobs=4"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
reporter: Default::default(),
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: Some(NonZeroUsize::new(4).unwrap()),
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--jobs=0"]);
assert!(r.is_err());
}
#[test]
fn test_with_fail_fast() {
let r = flags_from_vec(svec!["deno", "test", "--fail-fast=3"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: Some(NonZeroUsize::new(3).unwrap()),
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Default::default(),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--fail-fast=0"]);
assert!(r.is_err());
}
#[test]
fn test_with_enable_testing_features() {
let r = flags_from_vec(svec![
"deno",
"test",
"--enable-testing-features-do-not-use"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Default::default(),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
enable_testing_features: true,
..Flags::default()
}
);
}
#[test]
fn test_reporter() {
let r = flags_from_vec(svec!["deno", "test", "--reporter=pretty"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
reporter: TestReporterConfig::Pretty,
..Default::default()
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--reporter=dot"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
reporter: TestReporterConfig::Dot,
..Default::default()
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
log_level: Some(Level::Error),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--reporter=junit"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
reporter: TestReporterConfig::Junit,
..Default::default()
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--reporter=tap"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
reporter: TestReporterConfig::Tap,
..Default::default()
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
log_level: Some(Level::Error),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"test",
"--reporter=dot",
"--junit-path=report.xml"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
reporter: TestReporterConfig::Dot,
junit_path: Some("report.xml".to_string()),
..Default::default()
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
log_level: Some(Level::Error),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--junit-path"]);
assert!(r.is_err());
}
#[test]
fn test_shuffle() {
let r = flags_from_vec(svec!["deno", "test", "--shuffle=1"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: Some(1),
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Default::default(),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn test_watch() {
let r = flags_from_vec(svec!["deno", "test", "--watch"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Some(Default::default()),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn test_watch_explicit_cwd() {
let r = flags_from_vec(svec!["deno", "test", "--watch", "./"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec!["./".to_string()],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Some(Default::default()),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn test_watch_with_no_clear_screen() {
let r =
flags_from_vec(svec!["deno", "test", "--watch", "--no-clear-screen"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
no_run: false,
doc: false,
fail_fast: None,
filter: None,
allow_none: false,
shuffle: None,
files: FileFlags {
include: vec![],
ignore: vec![],
},
concurrent_jobs: None,
trace_leaks: false,
coverage_dir: None,
clean: false,
watch: Some(WatchFlagsWithPaths {
hmr: false,
no_clear_screen: true,
exclude: vec![],
paths: vec![],
}),
reporter: Default::default(),
junit_path: None,
hide_stacktraces: false,
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
}
#[test]
fn test_watch_with_paths() {
let r = flags_from_vec(svec!("deno", "test", "--watch=foo"));
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo")],
no_clear_screen: false,
exclude: vec![],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "test", "--watch=foo,bar"]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo"), String::from("bar")],
no_clear_screen: false,
exclude: vec![],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
}
#[test]
fn test_watch_with_excluded_paths() {
let r =
flags_from_vec(svec!("deno", "test", "--watch", "--watch-exclude=foo",));
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: false,
exclude: vec![String::from("foo")],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec!(
"deno",
"test",
"--watch=foo",
"--watch-exclude=bar",
));
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo")],
no_clear_screen: false,
exclude: vec![String::from("bar")],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"test",
"--watch",
"--watch-exclude=foo,bar",
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![],
no_clear_screen: false,
exclude: vec![String::from("foo"), String::from("bar")],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"test",
"--watch=foo,bar",
"--watch-exclude=baz,qux",
]);
let flags = r.unwrap();
assert_eq!(
flags,
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
watch: Some(WatchFlagsWithPaths {
hmr: false,
paths: vec![String::from("foo"), String::from("bar")],
no_clear_screen: false,
exclude: vec![String::from("baz"), String::from("qux"),],
}),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
}
#[test]
fn test_coverage_default_dir() {
let r = flags_from_vec(svec!["deno", "test", "--coverage"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
coverage_dir: Some("coverage".to_string()),
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
}
#[test]
fn test_hide_stacktraces() {
let r = flags_from_vec(svec!["deno", "test", "--hide-stacktraces"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Test(TestFlags {
hide_stacktraces: true,
..TestFlags::default()
}),
type_check_mode: TypeCheckMode::Local,
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
..Flags::default()
}
);
}
2020-04-02 09:26:40 -04:00
#[test]
fn bundle_with_cafile() {
let r = flags_from_vec(svec![
2020-04-02 09:26:40 -04:00
"deno",
"bundle",
"--cert",
"example.crt",
"source.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bundle(BundleFlags {
2020-04-02 09:26:40 -04:00
source_file: "source.ts".to_string(),
out_file: None,
watch: Default::default(),
}),
type_check_mode: TypeCheckMode::Local,
ca_data: Some(CaData::File("example.crt".to_owned())),
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
}
#[test]
fn upgrade_with_ca_file() {
let r = flags_from_vec(svec!["deno", "upgrade", "--cert", "example.crt"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Upgrade(UpgradeFlags {
force: false,
dry_run: false,
canary: false,
release_candidate: false,
version: None,
2020-07-06 18:21:26 -04:00
output: None,
version_or_hash_or_channel: None,
}),
ca_data: Some(CaData::File("example.crt".to_owned())),
..Flags::default()
}
);
}
#[test]
fn upgrade_release_candidate() {
let r = flags_from_vec(svec!["deno", "upgrade", "--rc"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Upgrade(UpgradeFlags {
force: false,
dry_run: false,
canary: false,
release_candidate: true,
version: None,
output: None,
version_or_hash_or_channel: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "upgrade", "--rc", "--canary"]);
assert!(r.is_err());
let r = flags_from_vec(svec!["deno", "upgrade", "--rc", "--version"]);
assert!(r.is_err());
}
2020-04-02 09:26:40 -04:00
#[test]
fn cache_with_cafile() {
let r = flags_from_vec(svec![
2020-04-02 09:26:40 -04:00
"deno",
"cache",
2020-04-02 09:26:40 -04:00
"--cert",
"example.crt",
"script.ts",
"script_two.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Cache(CacheFlags {
2020-04-02 09:26:40 -04:00
files: svec!["script.ts", "script_two.ts"],
}),
ca_data: Some(CaData::File("example.crt".to_owned())),
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
}
2020-04-02 09:26:40 -04:00
#[test]
fn info_with_cafile() {
let r = flags_from_vec(svec![
2020-04-02 09:26:40 -04:00
"deno",
"info",
"--cert",
"example.crt",
"https://example.com"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Info(InfoFlags {
json: false,
2020-04-02 09:26:40 -04:00
file: Some("https://example.com".to_string()),
}),
ca_data: Some(CaData::File("example.crt".to_owned())),
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
}
2020-04-02 09:26:40 -04:00
#[test]
fn doc() {
let r = flags_from_vec(svec!["deno", "doc", "--json", "path/to/module.ts"]);
2020-04-02 09:26:40 -04:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
2020-04-02 09:26:40 -04:00
json: true,
html: None,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
source_files: DocSourceFileFlag::Paths(svec!["path/to/module.ts"]),
filter: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "doc", "--html", "path/to/module.ts"]);
2024-04-24 16:34:21 -04:00
assert!(r.is_ok());
let r = flags_from_vec(svec![
"deno",
"doc",
"--html",
"--name=My library",
"path/to/module.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
json: false,
lint: false,
html: Some(DocHtmlFlag {
2024-04-24 16:34:21 -04:00
name: Some("My library".to_string()),
2024-06-28 08:03:51 -04:00
category_docs_path: None,
symbol_redirect_map_path: None,
default_symbol_map_path: None,
strip_trailing_html: false,
output: String::from("./docs/"),
}),
source_files: DocSourceFileFlag::Paths(svec!["path/to/module.ts"]),
filter: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"doc",
"--html",
"--name=My library",
"--lint",
"--output=./foo",
"path/to/module.ts"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
json: false,
html: Some(DocHtmlFlag {
2024-04-24 16:34:21 -04:00
name: Some("My library".to_string()),
2024-06-28 08:03:51 -04:00
category_docs_path: None,
symbol_redirect_map_path: None,
default_symbol_map_path: None,
strip_trailing_html: false,
output: String::from("./foo"),
}),
lint: true,
source_files: DocSourceFileFlag::Paths(svec!["path/to/module.ts"]),
2020-04-02 09:26:40 -04:00
filter: None,
}),
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
let r =
flags_from_vec(svec!["deno", "doc", "--html", "--name=My library",]);
assert!(r.is_err());
let r = flags_from_vec(svec![
2020-04-02 09:26:40 -04:00
"deno",
"doc",
"--filter",
"SomeClass.someField",
2020-04-02 09:26:40 -04:00
"path/to/module.ts",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
2020-04-02 09:26:40 -04:00
json: false,
html: None,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
source_files: DocSourceFileFlag::Paths(vec![
"path/to/module.ts".to_string()
]),
2020-04-02 09:26:40 -04:00
filter: Some("SomeClass.someField".to_string()),
}),
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "doc"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
json: false,
html: None,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
source_files: Default::default(),
filter: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"doc",
"--filter",
"Deno.Listener",
"--builtin"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
json: false,
html: None,
source_files: DocSourceFileFlag::Builtin,
filter: Some("Deno.Listener".to_string()),
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"doc",
"--no-npm",
"--no-remote",
"--private",
"path/to/module.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: true,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
json: false,
html: None,
source_files: DocSourceFileFlag::Paths(svec!["path/to/module.js"]),
filter: None,
}),
no_npm: true,
no_remote: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"doc",
"path/to/module.js",
"path/to/module2.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
json: false,
html: None,
source_files: DocSourceFileFlag::Paths(vec![
"path/to/module.js".to_string(),
"path/to/module2.js".to_string()
]),
filter: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"doc",
"path/to/module.js",
"--builtin",
"path/to/module2.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
json: false,
html: None,
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
lint: false,
source_files: DocSourceFileFlag::Paths(vec![
"path/to/module.js".to_string(),
"path/to/module2.js".to_string()
]),
filter: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "doc", "--lint",]);
assert!(r.is_err());
feat: `deno doc --lint` (#21032) Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
2023-10-31 18:19:42 -04:00
let r = flags_from_vec(svec![
"deno",
"doc",
"--lint",
"path/to/module.js",
"path/to/module2.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Doc(DocFlags {
private: false,
lint: true,
json: false,
html: None,
source_files: DocSourceFileFlag::Paths(vec![
"path/to/module.js".to_string(),
"path/to/module2.js".to_string()
]),
filter: None,
}),
..Flags::default()
}
);
2020-04-02 09:26:40 -04:00
}
2020-04-02 09:26:40 -04:00
#[test]
fn inspect_default_host() {
let r = flags_from_vec(svec!["deno", "run", "--inspect", "foo.js"]);
2020-04-02 09:26:40 -04:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"foo.js".to_string(),
)),
inspect: Some("127.0.0.1:9229".parse().unwrap()),
code_cache_enabled: true,
2020-04-02 09:26:40 -04:00
..Flags::default()
}
);
}
2020-11-30 14:35:12 -05:00
#[test]
fn inspect_wait() {
let r = flags_from_vec(svec!["deno", "--inspect-wait", "foo.js"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "foo.js".to_string(),
watch: None,
bare: true,
}),
inspect_wait: Some("127.0.0.1:9229".parse().unwrap()),
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--inspect-wait=127.0.0.1:3567",
"foo.js"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"foo.js".to_string(),
)),
inspect_wait: Some("127.0.0.1:3567".parse().unwrap()),
code_cache_enabled: true,
..Flags::default()
}
);
}
2020-11-30 14:35:12 -05:00
#[test]
fn compile() {
let r = flags_from_vec(svec![
2020-11-30 14:35:12 -05:00
"deno",
"compile",
"https://examples.deno.land/color-logging.ts"
2020-11-30 14:35:12 -05:00
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Compile(CompileFlags {
source_file: "https://examples.deno.land/color-logging.ts"
.to_string(),
output: None,
args: vec![],
target: None,
no_terminal: false,
icon: None,
include: vec![]
}),
type_check_mode: TypeCheckMode::Local,
2020-11-30 14:35:12 -05:00
..Flags::default()
}
);
}
#[test]
fn compile_with_flags() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "compile", "--import-map", "import_map.json", "--no-remote", "--config", "tsconfig.json", "--no-check", "--unsafely-ignore-certificate-errors", "--reload", "--lock", "lock.json", "--cert", "example.crt", "--cached-only", "--location", "https:foo", "--allow-read", "--allow-net", "--v8-flags=--help", "--seed", "1", "--no-terminal", "--icon", "favicon.ico", "--output", "colors", "--env=.example.env", "https://examples.deno.land/color-logging.ts", "foo", "bar", "-p", "8080"]);
2020-11-30 14:35:12 -05:00
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Compile(CompileFlags {
source_file: "https://examples.deno.land/color-logging.ts"
.to_string(),
output: Some(String::from("colors")),
args: svec!["foo", "bar", "-p", "8080"],
target: None,
no_terminal: true,
icon: Some(String::from("favicon.ico")),
include: vec![]
}),
2020-11-30 14:35:12 -05:00
import_map_path: Some("import_map.json".to_string()),
no_remote: true,
config_flag: ConfigFlag::Path("tsconfig.json".to_owned()),
type_check_mode: TypeCheckMode::None,
2020-11-30 14:35:12 -05:00
reload: true,
lock: Some(String::from("lock.json")),
ca_data: Some(CaData::File("example.crt".to_string())),
cached_only: true,
location: Some(Url::parse("https://foo/").unwrap()),
permissions: PermissionFlags {
allow_read: Some(vec![]),
allow_net: Some(vec![]),
..Default::default()
},
unsafely_ignore_certificate_errors: Some(vec![]),
v8_flags: svec!["--help", "--random-seed=1"],
seed: Some(1),
env_file: Some(".example.env".to_owned()),
2020-11-30 14:35:12 -05:00
..Flags::default()
}
);
}
#[test]
fn coverage() {
let r = flags_from_vec(svec!["deno", "coverage", "foo.json"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Coverage(CoverageFlags {
files: FileFlags {
include: vec!["foo.json".to_string()],
ignore: vec![],
},
include: vec![r"^file:".to_string()],
exclude: vec![r"test\.(js|mjs|ts|jsx|tsx)$".to_string()],
..CoverageFlags::default()
}),
..Flags::default()
}
);
}
#[test]
fn coverage_with_lcov_and_out_file() {
let r = flags_from_vec(svec![
"deno",
"coverage",
"--lcov",
"--output=foo.lcov",
"foo.json"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Coverage(CoverageFlags {
files: FileFlags {
include: vec!["foo.json".to_string()],
ignore: vec![],
},
include: vec![r"^file:".to_string()],
exclude: vec![r"test\.(js|mjs|ts|jsx|tsx)$".to_string()],
r#type: CoverageType::Lcov,
output: Some(String::from("foo.lcov")),
}),
..Flags::default()
}
);
}
#[test]
fn coverage_with_default_files() {
let r = flags_from_vec(svec!["deno", "coverage",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Coverage(CoverageFlags {
files: FileFlags {
include: vec!["coverage".to_string()],
ignore: vec![],
},
include: vec![r"^file:".to_string()],
exclude: vec![r"test\.(js|mjs|ts|jsx|tsx)$".to_string()],
..CoverageFlags::default()
}),
..Flags::default()
}
);
}
#[test]
fn location_with_bad_scheme() {
#[rustfmt::skip]
let r = flags_from_vec(svec!["deno", "run", "--location", "foo:", "mod.ts"]);
assert!(r.is_err());
assert!(r
.unwrap_err()
.to_string()
.contains("Expected protocol \"http\" or \"https\""));
}
#[test]
fn test_config_path_args() {
let flags = flags_from_vec(svec!["deno", "run", "foo.js"]).unwrap();
let cwd = std::env::current_dir().unwrap();
assert_eq!(flags.config_path_args(&cwd), Some(vec![cwd.clone()]));
let flags = flags_from_vec(svec!["deno", "run", "sub_dir/foo.js"]).unwrap();
let cwd = std::env::current_dir().unwrap();
assert_eq!(
flags.config_path_args(&cwd),
Some(vec![cwd.join("sub_dir").clone()])
);
let flags =
flags_from_vec(svec!["deno", "https://example.com/foo.js"]).unwrap();
assert_eq!(flags.config_path_args(&cwd), None);
let flags =
flags_from_vec(svec!["deno", "lint", "dir/a/a.js", "dir/b/b.js"])
.unwrap();
assert_eq!(
flags.config_path_args(&cwd),
Some(vec![cwd.join("dir/a/a.js"), cwd.join("dir/b/b.js")])
);
let flags = flags_from_vec(svec!["deno", "lint"]).unwrap();
assert_eq!(flags.config_path_args(&cwd), Some(vec![cwd.clone()]));
let flags = flags_from_vec(svec![
"deno",
"fmt",
"dir/a/a.js",
"dir/a/a2.js",
"dir/b.js"
])
.unwrap();
assert_eq!(
flags.config_path_args(&cwd),
Some(vec![
cwd.join("dir/a/a.js"),
cwd.join("dir/a/a2.js"),
cwd.join("dir/b.js")
])
);
}
#[test]
fn test_no_clear_watch_flag_without_watch_flag() {
let r = flags_from_vec(svec!["deno", "run", "--no-clear-screen", "foo.js"]);
assert!(r.is_err());
let error_message = r.unwrap_err().to_string();
assert!(&error_message
2023-03-26 00:06:18 -04:00
.contains("error: the following required arguments were not provided:"));
assert!(&error_message.contains("--watch[=<FILES>...]"));
}
2022-02-16 13:14:19 -05:00
#[test]
fn vendor_minimal() {
let r = flags_from_vec(svec!["deno", "vendor", "mod.ts",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Vendor(VendorFlags {
specifiers: svec!["mod.ts"],
force: false,
output_path: None,
}),
..Flags::default()
}
);
}
#[test]
fn vendor_all() {
let r = flags_from_vec(svec![
"deno",
"vendor",
"--config",
"deno.json",
"--import-map",
"import_map.json",
"--lock",
"lock.json",
"--force",
"--output",
"out_dir",
"--reload",
"mod.ts",
"deps.test.ts",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Vendor(VendorFlags {
specifiers: svec!["mod.ts", "deps.test.ts"],
force: true,
output_path: Some(String::from("out_dir")),
2022-02-16 13:14:19 -05:00
}),
config_flag: ConfigFlag::Path("deno.json".to_owned()),
2022-02-16 13:14:19 -05:00
import_map_path: Some("import_map.json".to_string()),
lock: Some(String::from("lock.json")),
2022-02-16 13:14:19 -05:00
reload: true,
..Flags::default()
}
);
}
#[test]
fn task_subcommand() {
let r = flags_from_vec(svec!["deno", "task", "build", "hello", "world",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["hello", "world"],
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "task", "build"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "task", "--cwd", "foo", "build"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: Some("foo".to_string()),
task: Some("build".to_string()),
is_run: false,
}),
..Flags::default()
}
);
}
#[test]
fn task_subcommand_double_hyphen() {
let r = flags_from_vec(svec![
"deno",
"task",
"-c",
"deno.json",
"build",
"--",
"hello",
"world",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["--", "hello", "world"],
config_flag: ConfigFlag::Path("deno.json".to_owned()),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno", "task", "--cwd", "foo", "build", "--", "hello", "world"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: Some("foo".to_string()),
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["--", "hello", "world"],
..Flags::default()
}
);
}
#[test]
fn task_subcommand_double_hyphen_only() {
// edge case, but it should forward
let r = flags_from_vec(svec!["deno", "task", "build", "--"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["--"],
..Flags::default()
}
);
}
#[test]
fn task_following_arg() {
let r = flags_from_vec(svec!["deno", "task", "build", "-1", "--test"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["-1", "--test"],
..Flags::default()
}
);
}
#[test]
fn task_following_double_hyphen_arg() {
let r = flags_from_vec(svec!["deno", "task", "build", "--test"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
argv: svec!["--test"],
..Flags::default()
}
);
}
#[test]
fn task_with_global_flags() {
// can fail if the custom parser in task_parse() starts at the wrong index
let r = flags_from_vec(svec!["deno", "--quiet", "task", "build"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: Some("build".to_string()),
is_run: false,
}),
log_level: Some(log::Level::Error),
..Flags::default()
}
);
}
#[test]
fn task_subcommand_empty() {
let r = flags_from_vec(svec!["deno", "task"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: None,
is_run: false,
}),
..Flags::default()
}
);
}
#[test]
fn task_subcommand_config() {
let r = flags_from_vec(svec!["deno", "task", "--config", "deno.jsonc"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: None,
is_run: false,
}),
config_flag: ConfigFlag::Path("deno.jsonc".to_string()),
..Flags::default()
}
);
}
#[test]
fn task_subcommand_config_short() {
let r = flags_from_vec(svec!["deno", "task", "-c", "deno.jsonc"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Task(TaskFlags {
cwd: None,
task: None,
is_run: false,
}),
config_flag: ConfigFlag::Path("deno.jsonc".to_string()),
..Flags::default()
}
);
}
#[test]
fn task_subcommand_noconfig_invalid() {
let r = flags_from_vec(svec!["deno", "task", "--no-config"]);
2023-03-26 00:06:18 -04:00
assert_eq!(
r.unwrap_err().kind(),
clap::error::ErrorKind::UnknownArgument
);
}
#[test]
fn bench_with_flags() {
let r = flags_from_vec(svec![
"deno",
"bench",
"--json",
"--unstable",
"--no-npm",
"--no-remote",
"--no-run",
"--filter",
"- foo",
"--location",
"https:foo",
"--allow-net",
"dir1/",
"dir2/",
"--",
"arg1",
"arg2"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bench(BenchFlags {
filter: Some("- foo".to_string()),
json: true,
no_run: true,
files: FileFlags {
include: vec!["dir1/".to_string(), "dir2/".to_string()],
ignore: vec![],
},
watch: Default::default(),
}),
unstable_config: UnstableConfig {
legacy_flag_enabled: true,
..Default::default()
},
no_npm: true,
no_remote: true,
type_check_mode: TypeCheckMode::Local,
location: Some(Url::parse("https://foo/").unwrap()),
permissions: PermissionFlags {
allow_net: Some(vec![]),
no_prompt: true,
..Default::default()
},
argv: svec!["arg1", "arg2"],
..Flags::default()
}
);
}
#[test]
fn bench_watch() {
let r = flags_from_vec(svec!["deno", "bench", "--watch"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Bench(BenchFlags {
filter: None,
json: false,
no_run: false,
files: FileFlags {
include: vec![],
ignore: vec![],
},
watch: Some(Default::default()),
}),
permissions: PermissionFlags {
no_prompt: true,
..Default::default()
},
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn run_with_check() {
let r = flags_from_vec(svec!["deno", "run", "--check", "script.ts",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
type_check_mode: TypeCheckMode::Local,
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "run", "--check=all", "script.ts",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
type_check_mode: TypeCheckMode::All,
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "--check=foo", "script.ts",]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
type_check_mode: TypeCheckMode::None,
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--no-check",
"--check",
"script.ts",
]);
assert!(r.is_err());
}
#[test]
fn no_config() {
let r = flags_from_vec(svec!["deno", "run", "--no-config", "script.ts",]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
config_flag: ConfigFlag::Disabled,
code_cache_enabled: true,
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"run",
"--config",
"deno.json",
"--no-config",
"script.ts",
]);
assert!(r.is_err());
}
#[test]
fn init() {
let r = flags_from_vec(svec!["deno", "init"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: None,
lib: false,
serve: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "init", "foo"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: Some(String::from("foo")),
lib: false,
serve: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "init", "--quiet"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: None,
lib: false,
serve: false,
}),
log_level: Some(Level::Error),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "init", "--lib"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: None,
lib: true,
serve: false,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "init", "--serve"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: None,
lib: false,
serve: true,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "init", "foo", "--lib"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Init(InitFlags {
dir: Some(String::from("foo")),
lib: true,
serve: false,
}),
..Flags::default()
}
);
}
#[test]
fn jupyter() {
let r = flags_from_vec(svec!["deno", "jupyter"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Jupyter(JupyterFlags {
install: false,
kernel: false,
conn_file: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "jupyter", "--install"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Jupyter(JupyterFlags {
install: true,
kernel: false,
conn_file: None,
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"jupyter",
"--kernel",
"--conn",
"path/to/conn/file"
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Jupyter(JupyterFlags {
install: false,
kernel: true,
conn_file: Some(String::from("path/to/conn/file")),
}),
..Flags::default()
}
);
let r = flags_from_vec(svec![
"deno",
"jupyter",
"--install",
"--conn",
"path/to/conn/file"
]);
r.unwrap_err();
let r = flags_from_vec(svec!["deno", "jupyter", "--kernel",]);
r.unwrap_err();
let r = flags_from_vec(svec!["deno", "jupyter", "--install", "--kernel",]);
r.unwrap_err();
}
#[test]
fn publish_args() {
let r = flags_from_vec(svec![
"deno",
"publish",
"--no-provenance",
"--dry-run",
"--allow-slow-types",
"--allow-dirty",
"--token=asdf",
]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Publish(PublishFlags {
token: Some("asdf".to_string()),
dry_run: true,
allow_slow_types: true,
allow_dirty: true,
no_provenance: true,
}),
type_check_mode: TypeCheckMode::Local,
..Flags::default()
}
);
}
#[test]
fn add_subcommand() {
let r = flags_from_vec(svec!["deno", "add"]);
r.unwrap_err();
let r = flags_from_vec(svec!["deno", "add", "@david/which"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Add(AddFlags {
packages: svec!["@david/which"],
}),
..Flags::default()
}
);
let r = flags_from_vec(svec!["deno", "add", "@david/which", "@luca/hello"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Add(AddFlags {
packages: svec!["@david/which", "@luca/hello"],
}),
..Flags::default()
}
);
}
#[test]
fn remove_subcommand() {
let r = flags_from_vec(svec!["deno", "remove"]);
r.unwrap_err();
let r = flags_from_vec(svec!["deno", "remove", "@david/which"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Remove(RemoveFlags {
packages: svec!["@david/which"],
}),
..Flags::default()
}
);
let r =
flags_from_vec(svec!["deno", "remove", "@david/which", "@luca/hello"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Remove(RemoveFlags {
packages: svec!["@david/which", "@luca/hello"],
}),
..Flags::default()
}
);
}
#[test]
fn run_with_frozen_lockfile() {
let cases = [
(Some("--frozen"), Some(true)),
(Some("--frozen=true"), Some(true)),
(Some("--frozen=false"), Some(false)),
(None, None),
];
for (flag, frozen) in cases {
let mut args = svec!["deno", "run"];
if let Some(f) = flag {
args.push(f.into());
}
args.push("script.ts".into());
let r = flags_from_vec(args);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags::new_default(
"script.ts".to_string(),
)),
frozen_lockfile: frozen,
code_cache_enabled: true,
..Flags::default()
}
);
}
}
#[test]
fn allow_scripts() {
let cases = [
(Some("--allow-scripts"), Ok(PackagesAllowedScripts::All)),
(None, Ok(PackagesAllowedScripts::None)),
(
Some("--allow-scripts=npm:foo"),
Ok(PackagesAllowedScripts::Some(svec!["npm:foo"])),
),
(
Some("--allow-scripts=npm:foo,npm:bar"),
Ok(PackagesAllowedScripts::Some(svec!["npm:foo", "npm:bar"])),
),
(Some("--allow-scripts=foo"), Err("Invalid package")),
];
for (flag, value) in cases {
let mut args = svec!["deno", "cache"];
if let Some(flag) = flag {
args.push(flag.into());
}
args.push("script.ts".into());
let r = flags_from_vec(args);
match value {
Ok(value) => {
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Cache(CacheFlags {
files: svec!["script.ts"],
}),
allow_scripts: value,
..Flags::default()
}
);
}
Err(e) => {
let err = r.unwrap_err();
assert!(
err.to_string().contains(e),
"expected to contain '{e}' got '{err}'"
);
}
}
}
}
#[test]
fn bare_run() {
let r = flags_from_vec(svec!["deno", "--no-config", "script.ts"]);
assert_eq!(
r.unwrap(),
Flags {
2024-08-12 11:55:33 -04:00
subcommand: DenoSubcommand::Run(RunFlags {
script: "script.ts".to_string(),
watch: None,
bare: true,
}),
config_flag: ConfigFlag::Disabled,
code_cache_enabled: true,
..Flags::default()
}
);
}
#[test]
fn bare_global() {
let r = flags_from_vec(svec!["deno", "--log-level=debug"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Repl(ReplFlags {
eval_files: None,
eval: None,
is_default_command: true,
}),
log_level: Some(Level::Debug),
permissions: PermissionFlags {
allow_all: false,
allow_net: Some(vec![]),
allow_env: Some(vec![]),
allow_run: Some(vec![]),
allow_read: Some(vec![]),
allow_sys: Some(vec![]),
allow_write: Some(vec![]),
allow_ffi: Some(vec![]),
allow_hrtime: true,
..Default::default()
},
..Flags::default()
}
);
}
#[test]
fn bare_with_flag_no_file() {
let r = flags_from_vec(svec!["deno", "--no-config"]);
let err = r.unwrap_err();
assert!(err.to_string().contains("error: [SCRIPT_ARG] may only be omitted with --v8-flags=--help, else to use the repl with arguments, please use the `deno repl` subcommand"));
assert!(err
.to_string()
.contains("Usage: deno [OPTIONS] [COMMAND] [SCRIPT_ARG]..."));
}
#[test]
fn equal_help_output() {
for command in clap_root().get_subcommands() {
if command.get_name() == "help" {
continue;
}
let long_flag = if let DenoSubcommand::Help(help) =
flags_from_vec(svec!["deno", command.get_name(), "--help"])
.unwrap()
.subcommand
{
help.help.to_string()
} else {
unreachable!()
};
let short_flag = if let DenoSubcommand::Help(help) =
flags_from_vec(svec!["deno", command.get_name(), "-h"])
.unwrap()
.subcommand
{
help.help.to_string()
} else {
unreachable!()
};
let subcommand = if let DenoSubcommand::Help(help) =
flags_from_vec(svec!["deno", "help", command.get_name()])
.unwrap()
.subcommand
{
help.help.to_string()
} else {
unreachable!()
};
assert_eq!(long_flag, short_flag, "{} subcommand", command.get_name());
assert_eq!(long_flag, subcommand, "{} subcommand", command.get_name());
}
}
}