feat(apply): rename restore to apply

Fixes: #227

CONTRIBUTING.md

@@ -80,20 +80,20 @@ To build `node-maintainer`:
 
 ## Working on the installer
 
-Orogene's "install" command is called `restore`. During development, you can
+Orogene's "install" command is called `apply`. During development, you can
 call it like this:
 
 ```sh
-$ cargo run [--release] -- restore [--root ../path/to/test/react-app] [--oro-cache ./path/to/cache] [--loglevel info]
+$ cargo run [--release] -- apply [--root ../path/to/test/react-app] [--oro-cache ./path/to/cache] [--loglevel info]
 ```
 
 It might be worth it to run with `--release` every time if you plan on seeing
-restores to completion, because debug builds of orogene are pretty slow.
+applies to completion, because debug builds of orogene are pretty slow.
 
-The restore command itself is defined in `src/commands/restore.rs`, and is
+The apply command itself is defined in `src/commands/apply.rs`, and is
 pretty much a UI wrapper around `crates/node-maintainer`'s APIs.
 
-If you're only interested in the dependency resolution aspect of `restore`,
+If you're only interested in the dependency resolution aspect of `apply`,
 you can run with `--lockfile-only`, which will skip the much more expensive
 extraction process.
 
@@ -104,7 +104,7 @@ orogene uses [tracing](https://docs.rs/tracing) and
 logging capabilities, which can be configured through `--loglevel`. The syntax
 for this option is documented
 [here](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives).
-For example, `cargo run -- restore --loglevel node_maintainer=trace,info` will
+For example, `cargo run -- apply --loglevel node_maintainer=trace,info` will
 default to INFO-level logging for everything, but also include TRACE-level
 logging for anything logged by `node-maintainer` (node the underscore. It's
 based on the module name, not the crate.)

book/src/SUMMARY.md

@@ -13,8 +13,8 @@
 
 # Commands
 
+- [apply](./commands/apply.md)
 - [ping](./commands/ping.md)
-- [restore](./commands/restore.md)
 - [view](./commands/view.md)
 
 ---

book/src/commands/apply.md

@@ -0,0 +1 @@
+{{#include ../../../tests/snapshots/help__apply.snap:8:}}

crates/node-maintainer/src/maintainer.rs

@@ -74,7 +74,7 @@ impl NodeMaintainerOptions {
         self
     }
 
-    /// Controls number of concurrent operations during various restore steps
+    /// Controls number of concurrent operations during various apply steps
     /// (resolution fetches, extractions, etc). Tuning this might help reduce
     /// memory usage.
     pub fn concurrency(mut self, concurrency: usize) -> Self {

examples/render-benchmarks.rs

@@ -83,7 +83,7 @@ fn exec_benchmark(prepare: &str) -> Result<BenchmarkResults> {
                 &json_output,
                 "--warmup",
                 "1",
-                "../release/oro restore --cache pm-cache",
+                "../release/oro apply --ignore-scripts --cache pm-cache",
                 "bun install --ignore-scripts",
                 "npm install --ignore-scripts --cache pm-cache",
                 "npx -p pnpm pnpm install --ignore-scripts --store-dir pm-cache",

src/commands/restore.rs → src/commands/apply.rs

@@ -12,10 +12,13 @@ use url::Url;
 
 use crate::commands::OroCommand;
 
-/// Resolves and extracts a `node_modules/` tree.
+/// Applies the current project's requested dependencies to `node_modules/`,
+/// adding, removing, and updating dependencies as needed. This command is
+/// intended to be an idempotent way to make sure your `node_modules` is in
+/// the right state to execute, based on your declared dependencies.
 #[derive(Debug, Args)]
-#[clap(visible_aliases(["r", "res"]))]
-pub struct RestoreCmd {
+#[clap(visible_aliases(["a", "ap", "app"]))]
+pub struct ApplyCmd {
     /// When extracting packages, prefer to copy files files instead of
     /// linking them.
     ///
@@ -47,7 +50,7 @@ pub struct RestoreCmd {
     #[arg(long, default_value = "latest")]
     default_tag: String,
 
-    /// Controls number of concurrent operations during various restore steps
+    /// Controls number of concurrent operations during various apply steps
     /// (resolution fetches, extractions, etc).
     ///
     /// Tuning this might help reduce memory usage (if lowered), or improve
@@ -104,7 +107,7 @@ pub struct RestoreCmd {
 }
 
 #[async_trait]
-impl OroCommand for RestoreCmd {
+impl OroCommand for ApplyCmd {
     async fn execute(self) -> Result<()> {
         let total_time = std::time::Instant::now();
         let root = &self.root;
@@ -142,7 +145,7 @@ impl OroCommand for RestoreCmd {
     }
 }
 
-impl RestoreCmd {
+impl ApplyCmd {
     fn configured_maintainer(&self) -> NodeMaintainerOptions {
         let root = &self.root;
         let mut nm = NodeMaintainerOptions::new();

src/commands/mod.rs

@@ -1,8 +1,8 @@
 use async_trait::async_trait;
 use miette::Result;
 
+pub mod apply;
 pub mod ping;
-pub mod restore;
 pub mod view;
 
 #[async_trait]

src/lib.rs

@@ -397,9 +397,9 @@ where
 
 #[derive(Debug, Subcommand)]
 pub enum OroCmd {
-    Ping(commands::ping::PingCmd),
+    Apply(commands::apply::ApplyCmd),
 
-    Restore(commands::restore::RestoreCmd),
+    Ping(commands::ping::PingCmd),
 
     View(commands::view::ViewCmd),
 
@@ -413,13 +413,14 @@ impl OroCommand for Orogene {
         log_command_line();
         match self.subcommand {
             OroCmd::Ping(cmd) => cmd.execute().await,
-            OroCmd::Restore(cmd) => cmd.execute().await,
+            OroCmd::Apply(cmd) => cmd.execute().await,
             OroCmd::View(cmd) => cmd.execute().await,
             OroCmd::HelpMarkdown(cmd) => cmd.execute().await,
         }
     }
 }
 
+/// Used for generating markdown documentation for Orogene commands.
 #[derive(Debug, Args)]
 pub struct HelpMarkdownCmd {
     #[arg()]

tests/help.rs

@@ -3,13 +3,13 @@ use std::process::{Command, Output, Stdio};
 static BIN: &str = env!("CARGO_BIN_EXE_oro");
 
 #[test]
-fn ping_markdown() {
-    insta::assert_snapshot!("ping", sub_md("ping"));
+fn apply_markdown() {
+    insta::assert_snapshot!("apply", sub_md("apply"));
 }
 
 #[test]
-fn restore_markdown() {
-    insta::assert_snapshot!("restore", sub_md("restore"));
+fn ping_markdown() {
+    insta::assert_snapshot!("ping", sub_md("ping"));
 }
 
 #[test]

tests/snapshots/help__restore.snap → tests/snapshots/help__apply.snap

@@ -1,21 +1,21 @@
 ---
 source: tests/help.rs
-expression: "sub_md(\"restore\")"
+expression: "sub_md(\"apply\")"
 ---
 stderr:
 
 stdout:
-# oro restore
+# oro apply
 
-Resolves and extracts a `node_modules/` tree
+Applies the current project's requested dependencies to `node_modules/`, adding, removing, and updating dependencies as needed. This command is intended to be an idempotent way to make sure your `node_modules` is in the right state to execute, based on your declared dependencies
 
 ### Usage:
 
 ```
-oro restore [OPTIONS]
+oro apply [OPTIONS]
 ```
 
-[aliases: r, res]
+[aliases: a, ap, app]
 
 ### Options
 
@@ -47,7 +47,7 @@ Default dist-tag to use when resolving package versions
 
 #### `--concurrency <CONCURRENCY>`
 
-Controls number of concurrent operations during various restore steps (resolution fetches, extractions, etc).
+Controls number of concurrent operations during various apply steps (resolution fetches, extractions, etc).
 
 Tuning this might help reduce memory usage (if lowered), or improve performance (if increased).