feat: add --package-json flag to deno add/install/remove/uninstall (#33199)

- Adds a `--package-json` flag to `deno add`, `deno install`, `deno
remove`, and `deno uninstall` subcommands
- When set, forces all dependency management to use `package.json`
instead of `deno.json`, bypassing the distance-based config file
heuristic
- Creates a new `package.json` if one doesn't exist
- JSR packages are converted to their npm-compatible form
(`npm:@jsr/...`) when written to `package.json`

Author: bartlomieju

cli/args/flags.rs

@@ -121,6 +121,7 @@ pub struct AddFlags {
   pub default_registry: Option<DefaultRegistry>,
   pub lockfile_only: bool,
   pub save_exact: bool,
+  pub package_json: bool,
 }
 
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
@@ -145,6 +146,7 @@ pub struct AuditFlags {
 pub struct RemoveFlags {
   pub packages: Vec<String>,
   pub lockfile_only: bool,
+  pub package_json: bool,
 }
 
 #[derive(Clone, Debug, Eq, PartialEq)]
@@ -2350,6 +2352,7 @@ Or multiple dependencies at once:
           .help("Save exact version without the caret (^)")
           .action(ArgAction::SetTrue),
       )
+      .arg(package_json_arg())
   })
 }
 
@@ -2520,6 +2523,7 @@ You can remove multiple dependencies at once:
       )
       .args(lock_args())
       .arg(lockfile_only_arg())
+      .arg(package_json_arg())
   })
 }
 
@@ -3717,6 +3721,7 @@ These must be added to the path manually if required."), UnstableArgsConfig::Res
             .conflicts_with("global"),
         )
         .arg(lockfile_only_arg().conflicts_with("global"))
+        .arg(package_json_arg().conflicts_with("entrypoint").conflicts_with("global"))
         .arg(
           Arg::new("os")
             .long("os")
@@ -3758,6 +3763,15 @@ fn lockfile_only_arg() -> Arg {
     .help("Install only updating the lockfile")
 }
 
+fn package_json_arg() -> Arg {
+  Arg::new("package-json")
+    .long("package-json")
+    .action(ArgAction::SetTrue)
+    .help(
+      "Force using package.json for dependency management instead of deno.json",
+    )
+}
+
 fn json_reference_subcommand() -> Command {
   Command::new("json_reference").hide(true)
 }
@@ -3975,6 +3989,7 @@ The installation root is determined, in order of precedence:
       )
       .args(lock_args())
       .arg(lockfile_only_arg())
+      .arg(package_json_arg().conflicts_with("global"))
   })
 }
 
@@ -6427,6 +6442,7 @@ fn add_parse_inner(
     default_registry,
     lockfile_only: matches.get_flag("lockfile-only"),
     save_exact: matches.get_flag("save-exact"),
+    package_json: matches.get_flag("package-json"),
   }
 }
 
@@ -6435,6 +6451,7 @@ fn remove_parse(flags: &mut Flags, matches: &mut ArgMatches) {
   flags.subcommand = DenoSubcommand::Remove(RemoveFlags {
     packages: matches.remove_many::<String>("packages").unwrap().collect(),
     lockfile_only: matches.get_flag("lockfile-only"),
+    package_json: matches.get_flag("package-json"),
   });
 }
 
@@ -7345,6 +7362,7 @@ fn uninstall_parse(flags: &mut Flags, matches: &mut ArgMatches) {
     UninstallKind::Local(RemoveFlags {
       packages,
       lockfile_only: matches.get_flag("lockfile-only"),
+      package_json: matches.get_flag("package-json"),
     })
   };
 
@@ -11473,6 +11491,7 @@ mod tests {
           kind: UninstallKind::Local(RemoveFlags {
             packages: vec!["@std/load".to_string()],
             lockfile_only: true,
+            package_json: false,
           }),
         }),
         frozen_lockfile: Some(true),
@@ -11489,6 +11508,7 @@ mod tests {
           kind: UninstallKind::Local(RemoveFlags {
             packages: vec!["file_server".to_string(), "@std/load".to_string()],
             lockfile_only: false,
+            package_json: false,
           }),
         }),
         ..Flags::default()
@@ -14596,6 +14616,7 @@ mod tests {
             default_registry: Some(DefaultRegistry::Npm),
             lockfile_only: false,
             save_exact: false,
+            package_json: false,
           })
         );
       }
@@ -14614,6 +14635,7 @@ mod tests {
           default_registry: Some(DefaultRegistry::Npm),
           lockfile_only: true,
           save_exact: false,
+          package_json: false,
         });
         expected_flags.frozen_lockfile = Some(true);
         assert_eq!(r.unwrap(), expected_flags);
@@ -14628,6 +14650,7 @@ mod tests {
             default_registry: Some(DefaultRegistry::Npm),
             lockfile_only: false,
             save_exact: false,
+            package_json: false,
           }),
         );
       }
@@ -14641,6 +14664,7 @@ mod tests {
             default_registry: Some(DefaultRegistry::Npm),
             lockfile_only: false,
             save_exact: false,
+            package_json: false,
           }),
         );
       }
@@ -14654,6 +14678,7 @@ mod tests {
             default_registry: Some(DefaultRegistry::Jsr),
             lockfile_only: false,
             save_exact: false,
+            package_json: false,
           }),
         );
       }
@@ -14672,6 +14697,7 @@ mod tests {
         subcommand: DenoSubcommand::Remove(RemoveFlags {
           packages: svec!["@david/which"],
           lockfile_only: false,
+          package_json: false,
         }),
         ..Flags::default()
       }
@@ -14691,6 +14717,7 @@ mod tests {
         subcommand: DenoSubcommand::Remove(RemoveFlags {
           packages: svec!["@david/which", "@luca/hello"],
           lockfile_only: true,
+          package_json: false,
         }),
         frozen_lockfile: Some(true),
         ..Flags::default()

cli/tools/pm/mod.rs

@@ -345,14 +345,46 @@ impl std::fmt::Display for AddCommandName {
   }
 }
 
+fn create_package_json(
+  flags: &Arc<Flags>,
+  options: &CliOptions,
+) -> Result<CliFactory, AnyError> {
+  std::fs::write(options.initial_cwd().join("package.json"), "{}\n")
+    .context("Failed to create package.json file")?;
+  log::info!("Created package.json configuration file.");
+  let factory = CliFactory::from_flags(flags.clone());
+  Ok(factory)
+}
+
 fn load_configs(
   flags: &Arc<Flags>,
   has_jsr_specifiers: impl FnOnce() -> bool,
+  force_package_json: bool,
 ) -> Result<(CliFactory, Option<ConfigUpdater>, Option<ConfigUpdater>), AnyError>
 {
   let cli_factory = CliFactory::from_flags(flags.clone());
   let options = cli_factory.cli_options()?;
   let start_dir = &options.start_dir;
+
+  if force_package_json {
+    let npm_config = match start_dir.member_pkg_json() {
+      Some(pkg_json) => Some(ConfigUpdater::new(
+        ConfigKind::PackageJson,
+        pkg_json.path.clone(),
+      )?),
+      None => {
+        let pkg_json_path = options.initial_cwd().join("package.json");
+        let factory = create_package_json(flags, options)?;
+        return Ok((
+          factory,
+          Some(ConfigUpdater::new(ConfigKind::PackageJson, pkg_json_path)?),
+          None,
+        ));
+      }
+    };
+    return Ok((cli_factory, npm_config, None));
+  }
+
   let npm_config = match start_dir.member_pkg_json() {
     Some(pkg_json) => Some(ConfigUpdater::new(
       ConfigKind::PackageJson,
@@ -407,10 +439,12 @@ pub async fn add(
   cmd_name: AddCommandName,
 ) -> Result<(), AnyError> {
   let save_exact = add_flags.save_exact;
-  let (cli_factory, mut npm_config, mut deno_config) =
-    load_configs(&flags, || {
-      add_flags.packages.iter().any(|s| s.starts_with("jsr:"))
-    })?;
+  let force_package_json = add_flags.package_json;
+  let (cli_factory, mut npm_config, mut deno_config) = load_configs(
+    &flags,
+    || add_flags.packages.iter().any(|s| s.starts_with("jsr:")),
+    force_package_json,
+  )?;
 
   if let Some(deno) = &deno_config
     && deno.obj().get("importMap").is_some()
@@ -586,7 +620,11 @@ pub async fn add(
       selected_package.selected_version
     );
 
-    if selected_package.package_name.starts_with("npm:") && prefer_npm_config {
+    if force_package_json {
+      npm_config.as_mut().unwrap().add(selected_package, dev);
+    } else if selected_package.package_name.starts_with("npm:")
+      && prefer_npm_config
+    {
       if let Some(npm) = &mut npm_config {
         npm.add(selected_package, dev);
       } else {
@@ -901,9 +939,15 @@ pub async fn remove(
   flags: Arc<Flags>,
   remove_flags: RemoveFlags,
 ) -> Result<(), AnyError> {
-  let (_, npm_config, deno_config) = load_configs(&flags, || false)?;
+  let force_package_json = remove_flags.package_json;
+  let (_, npm_config, deno_config) =
+    load_configs(&flags, || false, force_package_json)?;
 
-  let mut configs = [npm_config, deno_config];
+  let mut configs = if force_package_json {
+    [npm_config, None]
+  } else {
+    [npm_config, deno_config]
+  };
 
   let mut removed_packages = vec![];
 

tests/specs/add/package_json_flag/__test__.jsonc

@@ -0,0 +1,52 @@
+{
+  "tempDir": true,
+  "tests": {
+    "forces_all_deps_to_package_json": {
+      // When both deno.json and package.json exist, --package-json forces
+      // all packages (including jsr) into package.json
+      "steps": [
+        {
+          "args": "add --package-json npm:@denotest/esm-basic jsr:@denotest/add",
+          "output": "add.out"
+        },
+        {
+          "args": [
+            "eval",
+            "console.log(Deno.readTextFileSync('package.json').trim())"
+          ],
+          "output": "package.json.out"
+        },
+        {
+          "args": [
+            "eval",
+            "console.log(Deno.readTextFileSync('deno.json').trim())"
+          ],
+          "output": "{}\n"
+        }
+      ]
+    },
+    "creates_package_json_if_missing": {
+      // When only deno.json exists, --package-json creates package.json
+      "steps": [
+        {
+          "args": [
+            "eval",
+            "Deno.removeSync('package.json')"
+          ],
+          "output": ""
+        },
+        {
+          "args": "add --package-json npm:@denotest/esm-basic",
+          "output": "add_create.out"
+        },
+        {
+          "args": [
+            "eval",
+            "console.log(Deno.readTextFileSync('package.json').trim())"
+          ],
+          "output": "created_package.json.out"
+        }
+      ]
+    }
+  }
+}

tests/specs/add/package_json_flag/add.out

@@ -0,0 +1,5 @@
+[UNORDERED_START]
+Add npm:@denotest/esm-basic@1.0.0
+Add jsr:@denotest/add@1.0.0
+[UNORDERED_END]
+[WILDCARD]

tests/specs/add/package_json_flag/add_create.out

@@ -0,0 +1,2 @@
+Created package.json configuration file.
+[WILDCARD]

tests/specs/add/package_json_flag/created_package.json.out

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@denotest/esm-basic": "^1.0.0"
+  }
+}

tests/specs/add/package_json_flag/deno.json

@@ -0,0 +1 @@
+{}

tests/specs/add/package_json_flag/package.json

@@ -0,0 +1 @@
+{}

tests/specs/add/package_json_flag/package.json.out

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "@denotest/add": "npm:@jsr/denotest__add@^1.0.0",
+    "@denotest/esm-basic": "^1.0.0"
+  }
+}

tests/specs/remove/package_json_flag/__test__.jsonc

@@ -0,0 +1,22 @@
+{
+  "tempDir": true,
+  "steps": [
+    {
+      // First add a package to package.json using --package-json
+      "args": "add --package-json npm:@denotest/esm-basic",
+      "output": "[WILDCARD]"
+    },
+    {
+      // Then remove it using --package-json
+      "args": "remove --package-json @denotest/esm-basic",
+      "output": "remove.out"
+    },
+    {
+      "args": [
+        "eval",
+        "console.log(Deno.readTextFileSync('package.json').trim())"
+      ],
+      "output": "{\n}\n"
+    }
+  ]
+}