Removed refs to --rules #29

Author: rimutaka

README.md

@@ -94,7 +94,6 @@ _mx_ and _rimutaka_ are the same person. Let's add both emails to StackMuncher c
     GitHub validation: not set
 
     Local stack reports: /home/ubuntu/rust/stm_app/reports/home_ubuntu_rust_stm_app_6213a4b2
-    Code analysis rules: /home/ubuntu/rust/stm_app/stm_rules
     Config file: /home/ubuntu/rust/stm_app/.stm_config/config.json
 ```
 The app stored two emails from `--emails` param in its config file and printed its full config info (`config` command). From now on it will look for commits from _[email protected]_ and _[email protected]_.
@@ -181,14 +180,12 @@ Example:
     GitHub validation: https://gist.github.com/rimutaka/fb8fc0f87ee78231f064131022c8154a
 
     Local stack reports: /home/ubuntu/rust/stm_app/reports
-    Code analysis rules: /home/ubuntu/rust/stm_app/stm_rules
     Config file: /home/ubuntu/rust/stm_app/.stm_config/config.json
 ```
 
 #### Debug settings
 
 * `--log error|warn|info|debug|trace`: the log is written to _stdout_. Defaults to `error` for least verbose output. Redirect the output to a file or _null device_ to completely silence it. E.g. `stackmuncher --log debug >> ~/stm_trace.log`
-* `--rules "path to code analysis rules"`: a path to an alternative location of code analysis rules. The path can be relative or absolute. Defaults to the application folder.
 * `--reports "path to reports folder"`: a path to an alternative location for saving stack reports. The path can be relative or absolute. Defaults to the application folder.
 * `--config "path to config folder"`: a path to an alternative location of the config folder. The path can be relative or absolute. Defaults to the application folder.
 
@@ -202,12 +199,11 @@ Example:
 _The current version of the app is at alpha-stage and should be used for testing purposes only._
 
 1. Only a small number of computer languages are recognized.
-2. Profiles can be accessed via `/?dev=...` links only.
-3. The app may include private library names in the report - do not use it on commercially-sensitive projects.
-4. The only way to delete a profile is to email [email protected].
-5. Your Github profile may already be included in the Directory, but it cannot be linked to your private profile.
-6. It may take up to 2 minutes for a profile to be created/updated after a report submission.
-7. Very large reports (over 50MB) are likely to be rejected.
+2. The app may include private library names in the report - do not use it on commercially-sensitive projects.
+3. The only way to delete a profile is to email [email protected].
+4. It may take up to 2 minutes for a profile to be created/updated after a report submission.
+5. Very large reports (over 50MB) are likely to be rejected.
+6. Repositories with more than 10,000 files are not processed.
 
 ## Troubleshooting
 

stackmuncher/src/config.rs

@@ -284,9 +284,9 @@ pub(crate) async fn new_config_with_defaults(current_dir: PathBuf) -> (Config, P
     };
     let is_local_release = exec_dir.ends_with("target/release") || exec_dir.ends_with("target\\release");
 
-    // look for the rules in the current working dir if in debug mode
+    // use the current working dir if in debug mode
     // otherwise default to a platform-specific location
-    // this can be overridden by `--rules` CLI param
+    // this can be overridden by `--report` and `--config` CLI param
     let (report_dir, config_dir, log_level) = if is_local_release {
         // this branch activates when the app is called directly from `stm_app/target/release` folder, but all the config files are 2 levels up
         // go 2 steps up in the hierarchy to get to the root of stm_app project

stackmuncher/src/help.rs

@@ -125,7 +125,22 @@ pub(crate) fn emit_gist_instructions(gist_content: &String) {
 
 /// Prints out either Win or nix/Mac Welcome msg.
 pub(crate) fn emit_welcome_msg(config: AppConfig) {
-    let pub_key = ReportSignature::get_public_key(&config.user_key_pair);
+    // directory profile URL depends on if it's public or not
+    let dir_profile_url = match &config.gh_login {
+        Some(login) if !login.is_empty() => format!("https://stackmuncher.com/{}", login),
+        _ => format!("https://stackmuncher.com/?dev={}", ReportSignature::get_public_key(&config.user_key_pair)),
+    };
+
+    let profile_msg = match &config.gh_login {
+        Some(login) if !login.is_empty() => String::new(),
+        _ => format!(
+            "
+    An anonymous profile is created in the Directory the first time you run this app.
+    Run `stackmuncher{exe_suffix} github` to make your profile public with details from your GitHub account.
+    ",
+            exe_suffix = EXE_SUFFIX
+        ),
+    };
 
     println!("\
 StackMuncher app analyzes your technology stack and showcases it in the Global Directory of Software Developers.
@@ -136,11 +151,8 @@ USAGE:
     
 YOUR DIRECTORY PROFILE: 
 
-    https://stackmuncher.com/?dev={pub_key}
-
-    An anonymous profile is created in the Directory the first time you run this app.
-    Run `stackmuncher{exe_suffix} github` to make your profile public with details from your GitHub account.
-
+    {dir_profile_url}
+    {profile_msg}
 CODE PRIVACY:
     All code analysis is done locally. Not a single line of code is leaving your machine. View the source code at https://github.com/stackmuncher.
 
@@ -151,8 +163,6 @@ OPTIONS:
     --gist                                         a URL of your GitHub login validation Gist, run `stackmuncher{exe_suffix} github` for details
 
     --project \"path to project to be analyzed\"    can be relative or absolute, defaults to the current working directory
-
-    --rules \"path to code analysis rules\"         can be relative or absolute, defaults to the application folder
     --reports \"path to reports folder\"            can be relative or absolute, defaults to the application folder
     --config \"path to config folder\"              can be relative or absolute, defaults to the application folder
 
@@ -166,5 +176,5 @@ MORE INFO:
 
     https://stackmuncher.com/about      about the Directory
     https://github.com/stackmuncher     source code, issues and more
-    ",exe_suffix=EXE_SUFFIX, pub_key=pub_key);
+    ",exe_suffix=EXE_SUFFIX, dir_profile_url=dir_profile_url, profile_msg=profile_msg);
 }

stackmuncher_lib/src/code_rules.rs

@@ -27,10 +27,6 @@ pub struct CodeRules {
     /// file path, including directories
     pub file_ext_regex: Regex,
 
-    /// A compiled regex for extracting the file name without path or extension.
-    /// E.g. `/dir/dir/cs.json` -> `cs`
-    pub file_name_as_ext_regex: Regex,
-
     /// Contains names of newly added munchers to assist merging multiple instances
     /// of CodeRules for parallel processing.
     pub new_munchers: Option<HashSet<String>>,
@@ -57,7 +53,6 @@ impl CodeRules {
             files_types: BTreeMap::new(),
             munchers: BTreeMap::new(),
             file_ext_regex: Regex::new("\\.[a-zA-Z0-1_]+$").unwrap(),
-            file_name_as_ext_regex: Regex::new("[a-zA-Z0-1_]+\\.json$").unwrap(),
             new_munchers: None,
         };
 
@@ -99,7 +94,7 @@ impl CodeRules {
                         // Insert None if the muncher could not be loaded so that it doesn't try to load it again
                         self.munchers
                             .insert(muncher_name.clone(), Muncher::new(contents, &muncher_name));
-                            
+
                         // indicate to the caller that there were new munchers added so they can be shared with other threads
                         if self.new_munchers.is_none() {
                             self.new_munchers = Some(HashSet::new());