CLI ssr: allow specifying macro and parens strategy

Summary:
Structural Search (SSR) matches the syntax tree used internally in ELP, called HIR. This is conceptually similar to Erlang Abstract Forms.

When we lower the surface Erlang language into this, we expand macros and strip of parentheses, as the precedence of items is captured in the actual HIR representation.

But sometimes when we are searching over Erlang code we want to explicitly match parentheses, e.g. if we want to find all instances of redundant duplicate ones.

This diff allows you to do this by issue the command

```
elp ssr --parens "((_A))"
```

Likewise, sometimes you are interested in occurrences of macros. This can now be provided using a match like

```
elp ssr --macros no-expand "?BAR(_X)"
```

Reviewed By: TD5

Differential Revision: D85876784

fbshipit-source-id: ba62d83ed8ea9c7ac30cceda2cac446ecdeefb06

Author: alanz

crates/elp/src/bin/args.rs

@@ -13,12 +13,17 @@ use std::env;
 use std::fs;
 use std::path::PathBuf;
 
+use anyhow::Result;
+use anyhow::bail;
 use bpaf::Bpaf;
 use bpaf::Parser;
 use bpaf::construct;
 use bpaf::long;
 use elp_ide::elp_ide_db::DiagnosticCode;
 use elp_project_model::buck::BuckQueryConfig;
+use hir::fold::MacroStrategy;
+use hir::fold::ParenStrategy;
+use hir::fold::Strategy;
 use itertools::Itertools;
 use serde::Deserialize;
 
@@ -367,6 +372,20 @@ pub struct Ssr {
     )]
     pub format: Option<String>,
 
+    /// Macro expansion strategy: expand | no-expand | visible-expand (default expand)
+    #[bpaf(
+        long("macros"),
+        argument("STRATEGY"),
+        complete(macros_completer),
+        fallback(None),
+        guard(macros_guard, "Please supply a valid macro expansion value")
+    )]
+    pub macro_strategy: Option<String>,
+
+    /// Explicitly match parentheses. If omitted, they are ignored.
+    #[bpaf(long("parens"))]
+    pub paren_strategy: bool,
+
     /// Report system memory usage and other statistics
     #[bpaf(long("report-system-stats"))]
     pub report_system_stats: bool,
@@ -706,6 +725,21 @@ fn format_guard(format: &Option<String>) -> bool {
     }
 }
 
+fn macros_completer(_: &Option<String>) -> Vec<(String, Option<String>)> {
+    vec![
+        ("expand".to_string(), None),
+        ("no-expand".to_string(), None),
+        ("visible-expand".to_string(), None),
+    ]
+}
+
+fn macros_guard(format: &Option<String>) -> bool {
+    match format {
+        None => true,
+        Some(_) => parse_macro_strategy(format).is_ok(),
+    }
+}
+
 #[allow(clippy::ptr_arg)] // This is needed in the BPAF macros
 fn at_least_1(data: &Vec<String>) -> bool {
     !data.is_empty()
@@ -788,6 +822,19 @@ impl Lint {
     }
 }
 
+fn parse_macro_strategy(macro_strategy: &Option<String>) -> Result<MacroStrategy> {
+    match macro_strategy.as_deref() {
+        Some("no-expand") => Ok(MacroStrategy::DoNotExpand),
+        Some("expand") => Ok(MacroStrategy::Expand),
+        Some("visible-expand") => Ok(MacroStrategy::ExpandButIncludeMacroCall),
+        None => Ok(MacroStrategy::Expand),
+        Some(s) => bail!(
+            "Invalid macro strategy '{}'. Valid options are: expand, no-expand, visible-expand",
+            s
+        ),
+    }
+}
+
 impl Ssr {
     pub fn is_format_normal(&self) -> bool {
         self.format.is_none()
@@ -796,6 +843,16 @@ impl Ssr {
     pub fn is_format_json(&self) -> bool {
         self.format == Some("json".to_string())
     }
+
+    pub fn parse_strategy(&self) -> Result<Strategy> {
+        let macros = parse_macro_strategy(&self.macro_strategy)?;
+        let parens = if self.paren_strategy {
+            ParenStrategy::VisibleParens
+        } else {
+            ParenStrategy::InvisibleParens
+        };
+        Ok(Strategy { macros, parens })
+    }
 }
 
 impl ParseAllElp {

crates/elp/src/bin/main.rs

@@ -2047,6 +2047,73 @@ mod tests {
         )
     }
 
+    #[test]
+    fn lint_ssr_as_cli_parens_visible() {
+        simple_snapshot(
+            args_vec!["ssr", "--parens", "(_@A)",],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_parens_visible.stdout"),
+            true,
+            None,
+        )
+    }
+
+    #[test]
+    fn lint_ssr_as_cli_parens_invisible() {
+        // Invisible parens are the default
+        simple_snapshot(
+            args_vec!["ssr", "(((3)))",],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_parens_invisible.stdout"),
+            true,
+            None,
+        )
+    }
+
+    #[test]
+    fn lint_ssr_as_cli_macros_expand() {
+        simple_snapshot(
+            args_vec!["ssr", "--macros", "expand", "?BAR(_@AA)", "{4}"],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_macros_expand.stdout"),
+            true,
+            None,
+        )
+    }
+
+    #[test]
+    fn lint_ssr_as_cli_macros_expand_is_default() {
+        simple_snapshot(
+            args_vec!["ssr", "?BAR(_@AA)", "{4}"],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_macros_expand.stdout"),
+            true,
+            None,
+        )
+    }
+
+    #[test]
+    fn lint_ssr_as_cli_macros_visible_expand() {
+        simple_snapshot(
+            args_vec!["ssr", "--macros", "visible-expand", "?BAR(_@AA)", "{4}"],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_macros_visible_expand.stdout"),
+            true,
+            None,
+        )
+    }
+
+    #[test]
+    fn lint_ssr_as_cli_macros_no_expand() {
+        simple_snapshot(
+            args_vec!["ssr", "--macros", "no-expand", "?BAR(_@AA)", "{4}"],
+            "linter",
+            expect_file!("../resources/test/linter/ssr_ad_hoc_cli_macros_no_expand.stdout"),
+            true,
+            None,
+        )
+    }
+
     #[test_case(false ; "rebar")]
     #[test_case(true  ; "buck")]
     fn eqwalizer_tests_check(buck: bool) {

crates/elp/src/bin/ssr_cli.rs

@@ -78,13 +78,17 @@ pub fn run_ssr_command(
         }
     }
 
+    // Parse the strategy from CLI arguments
+    let strategy = args.parse_strategy()?;
+
     // Create the lint config with all SSR patterns
     let mut lint_config = LintConfig::default();
     for pattern in &args.ssr_specs {
         let normalized_pattern = normalize_ssr_pattern(pattern);
         let ssr_lint = diagnostics::Lint::LintMatchSsr(MatchSsr {
             ssr_pattern: normalized_pattern,
             message: None,
+            strategy: Some(strategy),
         });
         lint_config.ad_hoc_lints.lints.push(ssr_lint);
     }

crates/elp/src/lib.rs

@@ -192,6 +192,7 @@ mod tests {
                     Lint::LintMatchSsr(MatchSsr {
                         ssr_pattern: "ssr: _@A = 10.".to_string(),
                         message: None,
+                        strategy: None,
                     }),
                 ],
             },

crates/elp/src/resources/test/linter/parse_elp_lint_explicit_enable_output.stdout

@@ -1,9 +1,11 @@
-Diagnostics reported in 6 modules:
+Diagnostics reported in 7 modules:
   app_a: 2
       4:4-4:34::[Warning] [W0011] module `app_a` belongs to app `app_a`, but reads env for `misc`
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
   app_a_edoc: 1
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
+  app_a_ssr: 1
+      0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
   app_a_unused_param: 2
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
       4:4-4:5::[Warning] [L1268] variable 'X' is unused

crates/elp/src/resources/test/linter/parse_elp_no_lint_specified_json_output.stdout

@@ -8,6 +8,8 @@
 {"path":"app_a/src/app_a.erl","line":16,"char":1,"code":"ELP","severity":"warning","name":"L1230 (L1230)","original":null,"replacement":null,"description":"function baz/2 is unused\n\nFor more information see: /erlang-error-index/l/L1230","docPath":null}
 {"path":"app_a/src/app_a_edoc.erl","line":1,"char":1,"code":"ELP","severity":"error","name":"W0012 (compile-warn-missing-spec)","original":null,"replacement":null,"description":"Please add \"-compile(warn_missing_spec_all).\" to the module. If exported functions are not all specced, they need to be specced.\n\nFor more information see: /erlang-error-index/w/W0012","docPath":"website/docs/erlang-error-index/w/W0012.md"}
 {"path":"app_a/src/app_a_edoc.erl","line":1,"char":9,"code":"ELP","severity":"disabled","name":"W0046 (undocumented_module)","original":null,"replacement":null,"description":"The module is not documented.\n\nFor more information see: /erlang-error-index/w/W0046","docPath":"website/docs/erlang-error-index/w/W0046.md"}
+{"path":"app_a/src/app_a_ssr.erl","line":1,"char":1,"code":"ELP","severity":"error","name":"W0012 (compile-warn-missing-spec)","original":null,"replacement":null,"description":"Please add \"-compile(warn_missing_spec_all).\" to the module. If exported functions are not all specced, they need to be specced.\n\nFor more information see: /erlang-error-index/w/W0012","docPath":"website/docs/erlang-error-index/w/W0012.md"}
+{"path":"app_a/src/app_a_ssr.erl","line":1,"char":9,"code":"ELP","severity":"disabled","name":"W0046 (undocumented_module)","original":null,"replacement":null,"description":"The module is not documented.\n\nFor more information see: /erlang-error-index/w/W0046","docPath":"website/docs/erlang-error-index/w/W0046.md"}
 {"path":"app_a/src/app_a_unused_param.erl","line":1,"char":1,"code":"ELP","severity":"error","name":"W0012 (compile-warn-missing-spec)","original":null,"replacement":null,"description":"Please add \"-compile(warn_missing_spec_all).\" to the module. If exported functions are not all specced, they need to be specced.\n\nFor more information see: /erlang-error-index/w/W0012","docPath":"website/docs/erlang-error-index/w/W0012.md"}
 {"path":"app_a/src/app_a_unused_param.erl","line":1,"char":9,"code":"ELP","severity":"disabled","name":"W0046 (undocumented_module)","original":null,"replacement":null,"description":"The module is not documented.\n\nFor more information see: /erlang-error-index/w/W0046","docPath":"website/docs/erlang-error-index/w/W0046.md"}
 {"path":"app_a/src/app_a_unused_param.erl","line":5,"char":5,"code":"ELP","severity":"warning","name":"L1268 (L1268)","original":null,"replacement":null,"description":"variable 'X' is unused\n\nFor more information see: /erlang-error-index/l/L1268","docPath":null}

crates/elp/src/resources/test/linter/parse_elp_no_lint_specified_output.stdout

@@ -1,5 +1,5 @@
 Reporting all diagnostics codes
-Diagnostics reported in 8 modules:
+Diagnostics reported in 9 modules:
   app_a: 8
       4:4-4:34::[Warning] [W0011] module `app_a` belongs to app `app_a`, but reads env for `misc`
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
@@ -12,6 +12,9 @@ Diagnostics reported in 8 modules:
   app_a_edoc: 2
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
       0:8-0:18::[WeakWarning] [W0046] The module is not documented.
+  app_a_ssr: 2
+      0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
+      0:8-0:17::[WeakWarning] [W0046] The module is not documented.
   app_a_unused_param: 3
       0:0-0:0::[Error] [W0012] Please add "-compile(warn_missing_spec_all)." to the module. If exported functions are not all specced, they need to be specced.
       0:8-0:26::[WeakWarning] [W0046] The module is not documented.

crates/elp/src/resources/test/linter/ssr_ad_hoc_cli_macros_expand.stdout

@@ -0,0 +1,3 @@
+Matches found in 1 modules:
+  app_a_ssr: 1
+      10:10-10:17::[WeakWarning] [ad-hoc: ssr-match] SSR pattern matched: ssr: {4}.

crates/elp/src/resources/test/linter/ssr_ad_hoc_cli_macros_no_expand.stdout

@@ -0,0 +1,3 @@
+Matches found in 1 modules:
+  app_a_ssr: 1
+      10:10-10:17::[WeakWarning] [ad-hoc: ssr-match] SSR pattern matched: ssr: ?BAR(_@AA).

crates/elp/src/resources/test/linter/ssr_ad_hoc_cli_macros_visible_expand.stdout

@@ -0,0 +1,4 @@
+Matches found in 1 modules:
+  app_a_ssr: 2
+      10:10-10:17::[WeakWarning] [ad-hoc: ssr-match] SSR pattern matched: ssr: ?BAR(_@AA).
+      10:10-10:17::[WeakWarning] [ad-hoc: ssr-match] SSR pattern matched: ssr: {4}.