Enable the --detect-directory option by default; Issue #16

Author: Marek Suchánek

README.md

@@ -115,8 +115,6 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
 
     This creates the two modules and an assembly that features the include statements for the modules.
 
-* To let `newdoc` automatically fill out the include path, add the `--detect-directory` or `-D` option. Otherwise, `newdoc` uses the `<path>` placeholder in generated include statements.
-
 
 ## Packaging and distributing newdoc as an RPM
 

src/cmd_line.rs

@@ -83,7 +83,10 @@ pub fn get_args() -> ArgMatches<'static> {
             Arg::with_name("detect-directory")
                 .short("D")
                 .long("detect-directory")
-                .help("Detect the include path, rather than using the <path> placeholder"),
+                .help("Detect the include path, rather than using the <path> placeholder. This is now the default behavior")
+                // I'm enabling this option by default, without a way to disable it.
+                // Let the users test the new behavior and evaluate.
+                .hidden(true),
         )
         .arg(
             Arg::with_name("no-prefixes")

src/main.rs

@@ -18,6 +18,10 @@ pub struct Options {
 fn main() {
     let cmdline_args = cmd_line::get_args();
 
+    if cmdline_args.is_present("detect-directory") {
+        eprintln!("I: The `--detect-directory` (`-D`) option is now enabled by default.");
+    }
+
     // Set current options based on the command-line options
     let options = Options {
         // Comments and prefixes are enabled (true) by default unless you disable them
@@ -32,7 +36,12 @@ fn main() {
         } else {
             String::from(".")
         },
-        detect_directory: cmdline_args.is_present("detect-directory"),
+        // I'm turning this into the default behavior.
+        // For now, I'm goin to keep the switch as is, just always true,
+        // So that I can easily revert the changes later if needed.
+        // After this change has had proper user testing, let's remove the switch
+        // and the dead code.
+        detect_directory: true,
     };
 
     // Store all modules except for the populated assembly that will be created in this Vec