Added --manifest-path command line option.

Closes #261.

Author: orium

src/lib.rs

@@ -54,15 +54,23 @@ pub struct Project {
 impl Project {
     /// Creates a [`Project`] the current directory.  It will search ancestor paths until it finds
     /// the root of the project.
-    pub fn from_current_dir() -> Result<Project, ProjectError> {
-        let metadata = Project::get_cargo_metadata()?;
+    pub fn from_current_dir(manifest_path: Option<&Path>) -> Result<Project, ProjectError> {
+        let metadata = Project::get_cargo_metadata(manifest_path)?;
         let package = metadata.root_package().ok_or(ProjectError::ProjectHasNoRootPackage)?;
 
         Ok(Project::from_package(package))
     }
 
-    fn get_cargo_metadata() -> Result<cargo_metadata::Metadata, ProjectError> {
-        Ok(cargo_metadata::MetadataCommand::new().exec()?)
+    fn get_cargo_metadata(
+        manifest_path: Option<&Path>,
+    ) -> Result<cargo_metadata::Metadata, ProjectError> {
+        let mut command = cargo_metadata::MetadataCommand::new();
+
+        if let Some(manifest_path) = manifest_path {
+            command.manifest_path(manifest_path);
+        }
+
+        Ok(command.exec()?)
     }
 
     fn select_package<'a>(
@@ -74,8 +82,11 @@ impl Project {
         })
     }
 
-    pub fn from_current_dir_workspace_project(project_name: &str) -> Result<Project, ProjectError> {
-        let metadata = Project::get_cargo_metadata()?;
+    pub fn from_current_dir_workspace_project(
+        manifest_path: Option<&Path>,
+        project_name: &str,
+    ) -> Result<Project, ProjectError> {
+        let metadata = Project::get_cargo_metadata(manifest_path)?;
 
         let package = Project::select_package(&metadata, project_name)
             .ok_or_else(|| ProjectError::ProjectHasNoPackage(project_name.to_owned()))?;

src/main.rs

@@ -436,8 +436,10 @@ fn update_readme(
 
 fn run(options: options::Options) -> Result<(), RunError> {
     let project: Project = match options.workspace_project {
-        None => Project::from_current_dir()?,
-        Some(ref project) => Project::from_current_dir_workspace_project(project)?,
+        None => Project::from_current_dir(options.manifest_path.as_deref())?,
+        Some(ref project) => {
+            Project::from_current_dir_workspace_project(options.manifest_path.as_deref(), project)?
+        }
     };
     let entryfile: &Path =
         entrypoint(&project, &options.entrypoint).ok_or(RunError::NoEntrySourceFile)?;
@@ -495,8 +497,13 @@ fn run(options: options::Options) -> Result<(), RunError> {
 fn main() {
     let cmd_options = options::cmd_options();
 
-    let exit_code: ExitCode = match std::env::current_dir() {
-        Ok(current_dir) => match options::config_file_options(current_dir) {
+    let directory = cmd_options
+        .manifest_path()
+        .and_then(|path| path.parent())
+        .map_or_else(std::env::current_dir, |p| Ok(p.to_owned()));
+
+    let exit_code: ExitCode = match directory {
+        Ok(dir) => match options::config_file_options(dir) {
             Ok(config_file_options) => {
                 let options = options::merge_options(cmd_options, config_file_options);
 

src/options.rs

@@ -81,9 +81,16 @@ pub struct CmdOptions {
     intralinks_strip_links: bool,
     force: bool,
     readme_path: Option<PathBuf>,
+    manifest_path: Option<PathBuf>,
     heading_base_level: Option<u8>,
 }
 
+impl CmdOptions {
+    pub fn manifest_path(&self) -> Option<&Path> {
+        self.manifest_path.as_deref()
+    }
+}
+
 fn get_cmd_args() -> Vec<OsString> {
     let mut args: Vec<OsString> = std::env::args_os().collect();
     let subcommand: &str = {
@@ -127,7 +134,13 @@ pub fn cmd_options() -> CmdOptions {
             Arg::new("readme-path")
                 .long("readme-path")
                 .short('r')
-                .help("README file path to use (overrides of what is specified in the project `Cargo.toml`)")
+                .help("README file path to use (overrides what is specified in the project `Cargo.toml`)")
+                .value_parser(value_parser!(PathBuf)),
+        )
+        .arg(
+            Arg::new("manifest-path")
+                .long("manifest-path")
+                .help("path to `Cargo.toml`")
                 .value_parser(value_parser!(PathBuf)),
         )
         .arg(
@@ -178,6 +191,7 @@ pub fn cmd_options() -> CmdOptions {
     let entrypoint = cmd_opts.get_one::<EntrypointOpt>("entrypoint").cloned();
 
     let readme_path = cmd_opts.get_one::<PathBuf>("readme-path").cloned();
+    let manifest_path = cmd_opts.get_one::<PathBuf>("manifest-path").cloned();
 
     let heading_base_level = cmd_opts.get_one::<u8>("heading-base-level").copied();
 
@@ -190,6 +204,7 @@ pub fn cmd_options() -> CmdOptions {
         intralinks_strip_links: cmd_opts.get_flag("intralinks-strip-links"),
         force: cmd_opts.get_flag("force"),
         readme_path,
+        manifest_path,
         heading_base_level,
     }
 }
@@ -314,6 +329,7 @@ pub struct Options {
     pub no_fail_on_warnings: bool,
     pub force: bool,
     pub readme_path: Option<PathBuf>,
+    pub manifest_path: Option<PathBuf>,
     pub intralinks: Option<IntralinksConfig>,
     pub heading_base_level: Option<u8>,
 }
@@ -343,6 +359,7 @@ pub fn merge_options(
         readme_path: cmd_options
             .readme_path
             .or_else(|| config_file_options.as_mut().and_then(|c| c.readme_path.take())),
+        manifest_path: cmd_options.manifest_path,
         intralinks: Some(IntralinksConfig {
             docs_rs: IntralinksDocsRsConfig {
                 docs_rs_base_url: config_file_options
@@ -425,6 +442,7 @@ mod tests {
             intralinks_strip_links: true,
             force: true,
             readme_path: Some(PathBuf::from("rEaDmE.md")),
+            manifest_path: Some(PathBuf::from("foo/Cargo.toml")),
             heading_base_level: Some(4),
         };
         let config_file_options = ConfigFileOptions {
@@ -452,6 +470,7 @@ mod tests {
             no_fail_on_warnings: true,
             force: true,
             readme_path: Some(PathBuf::from("rEaDmE.md")),
+            manifest_path: Some(PathBuf::from("foo/Cargo.toml")),
             intralinks: Some(IntralinksConfig {
                 docs_rs: IntralinksDocsRsConfig {
                     docs_rs_base_url: Some("https://internaldocs.rs".to_owned()),

tests/option_cmd_manifest_path/.cargo-rdme.toml

@@ -0,0 +1,2 @@
+[intralinks]
+docs-rs-base-url = "https://this-should-not-be-used.rs"

tests/option_cmd_manifest_path/README-expected.md

@@ -0,0 +1,10 @@
+header
+
+<!-- cargo-rdme start -->
+
+This [beautiful crate](https://mydocs.rs/integration_test/latest/integration_test/) is cool because it contains [modules](https://mydocs.rs/integration_test/latest/integration_test/amodule/) and may use
+[copy](https://doc.rust-lang.org/stable/std/fs/fn.copy.html).
+
+<!-- cargo-rdme end -->
+
+footer

tests/option_cmd_manifest_path/README-template.md

@@ -0,0 +1,9 @@
+header
+
+<!-- cargo-rdme start -->
+
+Some old text here.
+
+<!-- cargo-rdme end -->
+
+footer

tests/option_cmd_manifest_path/foo/.cargo-rdme.toml

@@ -0,0 +1,2 @@
+[intralinks]
+docs-rs-base-url = "https://mydocs.rs"

tests/option_cmd_manifest_path/foo/Cargo.lock

@@ -0,0 +1,4 @@
+[package]
+name = "integration_test"
+version = "0.1.0"
+edition = "2021"

tests/option_cmd_manifest_path/foo/Cargo.toml

@@ -0,0 +1,6 @@
+//! This [beautiful crate](crate) is cool because it contains [modules](crate::amodule) and may use
+//! [copy](::std::fs::copy).
+
+mod amodule {}
+
+fn main() {}