summaryrefslogtreecommitdiff
path: root/src/flags.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/flags.rs')
-rw-r--r--src/flags.rs291
1 files changed, 0 insertions, 291 deletions
diff --git a/src/flags.rs b/src/flags.rs
deleted file mode 100644
index d6a63a9fb..000000000
--- a/src/flags.rs
+++ /dev/null
@@ -1,291 +0,0 @@
-// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
-use deno_core::v8_set_flags;
-use getopts;
-use getopts::Options;
-
-// Creates vector of strings, Vec<String>
-#[cfg(test)]
-macro_rules! svec {
- ($($x:expr),*) => (vec![$($x.to_string()),*]);
-}
-
-#[cfg_attr(feature = "cargo-clippy", allow(stutter))]
-#[derive(Clone, Debug, PartialEq, Default)]
-pub struct DenoFlags {
- pub help: bool,
- pub log_debug: bool,
- pub version: bool,
- pub reload: bool,
- pub recompile: bool,
- pub allow_read: bool,
- pub allow_write: bool,
- pub allow_net: bool,
- pub allow_env: bool,
- pub allow_run: bool,
- pub no_prompts: bool,
- pub types: bool,
- pub prefetch: bool,
- pub info: bool,
- pub fmt: bool,
-}
-
-pub fn get_usage(opts: &Options) -> String {
- format!(
- "Usage: deno script.ts {}
-Environment variables:
- DENO_DIR Set deno's base directory
- NO_COLOR Set to disable color",
- opts.usage("")
- )
-}
-
-/// Checks provided arguments for known options and sets appropriate Deno flags
-/// for them. Unknown options are returned for further use.
-/// Note:
-///
-/// 1. This assumes that privileged flags do not accept parameters deno --foo bar.
-/// This assumption is currently valid. But if it were to change in the future,
-/// this parsing technique would need to be modified. I think we want to keep the
-/// privileged flags minimal - so having this restriction is maybe a good thing.
-///
-/// 2. Misspelled flags will be forwarded to user code - e.g. --allow-ne would
-/// not cause an error. I also think this is ok because missing any of the
-/// privileged flags is not destructive. Userland flag parsing would catch these
-/// errors.
-fn set_recognized_flags(
- opts: &Options,
- flags: &mut DenoFlags,
- args: Vec<String>,
-) -> Result<Vec<String>, getopts::Fail> {
- let mut rest = Vec::<String>::new();
- // getopts doesn't allow parsing unknown options so we check them
- // one-by-one and handle unrecognized ones manually
- // better solution welcome!
- for arg in args {
- let fake_args = vec![arg];
- match opts.parse(&fake_args) {
- Err(getopts::Fail::UnrecognizedOption(_)) => {
- rest.extend(fake_args);
- }
- Err(e) => {
- return Err(e);
- }
- Ok(matches) => {
- if matches.opt_present("help") {
- flags.help = true;
- }
- if matches.opt_present("log-debug") {
- flags.log_debug = true;
- }
- if matches.opt_present("version") {
- flags.version = true;
- }
- if matches.opt_present("reload") {
- flags.reload = true;
- }
- if matches.opt_present("recompile") {
- flags.recompile = true;
- }
- if matches.opt_present("allow-read") {
- flags.allow_read = true;
- }
- if matches.opt_present("allow-write") {
- flags.allow_write = true;
- }
- if matches.opt_present("allow-net") {
- flags.allow_net = true;
- }
- if matches.opt_present("allow-env") {
- flags.allow_env = true;
- }
- if matches.opt_present("allow-run") {
- flags.allow_run = true;
- }
- if matches.opt_present("allow-all") {
- flags.allow_read = true;
- flags.allow_env = true;
- flags.allow_net = true;
- flags.allow_run = true;
- flags.allow_read = true;
- flags.allow_write = true;
- }
- if matches.opt_present("no-prompt") {
- flags.no_prompts = true;
- }
- if matches.opt_present("types") {
- flags.types = true;
- }
- if matches.opt_present("prefetch") {
- flags.prefetch = true;
- }
- if matches.opt_present("info") {
- flags.info = true;
- }
- if matches.opt_present("fmt") {
- flags.fmt = true;
- }
-
- if !matches.free.is_empty() {
- rest.extend(matches.free);
- }
- }
- }
- }
- Ok(rest)
-}
-
-#[cfg_attr(feature = "cargo-clippy", allow(stutter))]
-pub fn set_flags(
- args: Vec<String>,
-) -> Result<(DenoFlags, Vec<String>, String), String> {
- // TODO: all flags passed after "--" are swallowed by v8_set_flags
- // eg. deno --allow-net ./test.ts -- --title foobar
- // args === ["deno", "--allow-net" "./test.ts"]
- let args = v8_set_flags(args);
-
- let mut opts = Options::new();
- // TODO(kevinkassimo): v8_set_flags intercepts '-help' with single '-'
- // Resolve that and then uncomment line below (enabling Go style -long-flag)
- // opts.long_only(true);
- opts.optflag("", "allow-read", "Allow file system read access");
- opts.optflag("", "allow-write", "Allow file system write access");
- opts.optflag("", "allow-net", "Allow network access");
- opts.optflag("", "allow-env", "Allow environment access");
- opts.optflag("", "allow-run", "Allow running subprocesses");
- opts.optflag("A", "allow-all", "Allow all permissions");
- opts.optflag("", "no-prompt", "Do not use prompts");
- opts.optflag("", "recompile", "Force recompilation of TypeScript code");
- opts.optflag("h", "help", "Print this message");
- opts.optflag("D", "log-debug", "Log debug output");
- opts.optflag("v", "version", "Print the version");
- opts.optflag("r", "reload", "Reload cached remote resources");
- opts.optflag("", "v8-options", "Print V8 command line options");
- opts.optflag("", "types", "Print runtime TypeScript declarations");
- opts.optflag("", "prefetch", "Prefetch the dependencies");
- opts.optflag("", "info", "Show source file related info");
- opts.optflag("", "fmt", "Format code");
-
- let mut flags = DenoFlags::default();
-
- let rest =
- set_recognized_flags(&opts, &mut flags, args).map_err(|e| e.to_string())?;
- Ok((flags, rest, get_usage(&opts)))
-}
-
-#[test]
-fn test_set_flags_1() {
- let (flags, rest, _) = set_flags(svec!["deno", "--version"]).unwrap();
- assert_eq!(rest, svec!["deno"]);
- assert_eq!(
- flags,
- DenoFlags {
- version: true,
- ..DenoFlags::default()
- }
- );
-}
-
-#[test]
-fn test_set_flags_2() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "-r", "-D", "script.ts"]).unwrap();
- assert_eq!(rest, svec!["deno", "script.ts"]);
- assert_eq!(
- flags,
- DenoFlags {
- log_debug: true,
- reload: true,
- ..DenoFlags::default()
- }
- );
-}
-
-#[test]
-fn test_set_flags_3() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "-r", "script.ts", "--allow-write"]).unwrap();
- assert_eq!(rest, svec!["deno", "script.ts"]);
- assert_eq!(
- flags,
- DenoFlags {
- reload: true,
- allow_write: true,
- ..DenoFlags::default()
- }
- );
-}
-
-#[test]
-fn test_set_flags_4() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "-Dr", "script.ts", "--allow-write"]).unwrap();
- assert_eq!(rest, svec!["deno", "script.ts"]);
- assert_eq!(
- flags,
- DenoFlags {
- log_debug: true,
- reload: true,
- allow_write: true,
- ..DenoFlags::default()
- }
- );
-}
-
-#[test]
-fn test_set_flags_5() {
- let (flags, rest, _) = set_flags(svec!["deno", "--types"]).unwrap();
- assert_eq!(rest, svec!["deno"]);
- assert_eq!(
- flags,
- DenoFlags {
- types: true,
- ..DenoFlags::default()
- }
- )
-}
-
-#[test]
-fn test_set_flags_6() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "gist.ts", "--title", "X", "--allow-net"]).unwrap();
- assert_eq!(rest, svec!["deno", "gist.ts", "--title", "X"]);
- assert_eq!(
- flags,
- DenoFlags {
- allow_net: true,
- ..DenoFlags::default()
- }
- )
-}
-
-#[test]
-fn test_set_flags_7() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "gist.ts", "--allow-all"]).unwrap();
- assert_eq!(rest, svec!["deno", "gist.ts"]);
- assert_eq!(
- flags,
- DenoFlags {
- allow_net: true,
- allow_env: true,
- allow_run: true,
- allow_read: true,
- allow_write: true,
- ..DenoFlags::default()
- }
- )
-}
-
-#[test]
-fn test_set_flags_8() {
- let (flags, rest, _) =
- set_flags(svec!["deno", "gist.ts", "--allow-read"]).unwrap();
- assert_eq!(rest, svec!["deno", "gist.ts"]);
- assert_eq!(
- flags,
- DenoFlags {
- allow_read: true,
- ..DenoFlags::default()
- }
- )
-}
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-23 23:28:32 +0000