ast-grep-cli 0.9.2__tar.gz → 0.10.0__tar.gz

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ast-grep-cli
-Version: 0.9.2
+Version: 0.10.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/Cargo.lock

@@ -98,7 +98,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ansi_term",
  "anyhow",
@@ -126,7 +126,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-config"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "anyhow",
  "ast-grep-core",
@@ -142,7 +142,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-core"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "bit-set",
  "regex",
@@ -153,7 +153,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-dynamic"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ast-grep-core",
  "ignore",
@@ -165,7 +165,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-language"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ast-grep-core",
  "ast-grep-tree-sitter-c-sharp",
@@ -193,7 +193,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-lsp"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ast-grep-config",
  "ast-grep-core",
@@ -205,7 +205,7 @@ dependencies = [
 
 [[package]]
 name = "ast-grep-napi"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ast-grep-config",
  "ast-grep-core",
@@ -274,7 +274,7 @@ checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
 
 [[package]]
 name = "benches"
-version = "0.9.2"
+version = "0.10.0"
 dependencies = [
  "ast-grep-config",
  "ast-grep-core",
@@ -747,9 +747,9 @@ dependencies = [
 
 [[package]]
 name = "globset"
-version = "0.4.11"
+version = "0.4.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1391ab1f92ffcc08911957149833e682aa3fe252b9f45f966d2ef972274c97df"
+checksum = "aca8bbd8e0707c1887a8bbb7e6b40e228f251ff5d62c8220a4a7a53c73aff006"
 dependencies = [
  "aho-corasick",
  "bstr",
@@ -1437,9 +1437,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.103"
+version = "1.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d03b412469450d4404fe8499a268edd7f8b79fecb074b0d812ad64ca21f4031b"
+checksum = "076066c5f1078eac5b722a31827a8832fe108bed65dfa75e233c89f8206e976c"
 dependencies = [
  "indexmap",
  "itoa",
@@ -1776,9 +1776,9 @@ dependencies = [
 
 [[package]]
 name = "tree-sitter-c"
-version = "0.20.3"
+version = "0.20.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4dc4f11ece4d78d5a62591fe2456e9ca76211f0a60939913852ff6dfa023cb07"
+checksum = "fa1bb73a4101c88775e4fefcd0543ee25e192034484a5bd45cb99eefb997dca9"
 dependencies = [
  "cc",
  "tree-sitter",
@@ -1786,9 +1786,9 @@ dependencies = [
 
 [[package]]
 name = "tree-sitter-cpp"
-version = "0.20.1"
+version = "0.20.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0dbedbf4066bfab725b3f9e2a21530507419a7d2f98621d3c13213502b734ec0"
+checksum = "1c88fd925d0333e63ac64e521f5bd79c53019e569ffbbccfeef346a326f459e9"
 dependencies = [
  "cc",
  "tree-sitter",
@@ -1899,9 +1899,9 @@ dependencies = [
 
 [[package]]
 name = "tree-sitter-python"
-version = "0.20.2"
+version = "0.20.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dda114f58048f5059dcf158aff691dffb8e113e6d2b50d94263fd68711975287"
+checksum = "f47ebd9cac632764b2f4389b08517bf2ef895431dd163eb562e3d2062cc23a14"
 dependencies = [
  "cc",
  "tree-sitter",

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/Cargo.toml

@@ -8,7 +8,7 @@ default-run = "sg"
 readme = "../../README.md"
 license-file = "../../LICENSE"
 
-version= "0.9.2"
+version= "0.10.0"
 authors= ["Herrington Darkholme <2883231+HerringtonDarkholme@users.noreply.github.com>"]
 edition= "2021"
 # license.workspace = true
@@ -42,7 +42,7 @@ ignore= { version = "0.4.20" }
 inquire = "0.6.2"
 num_cpus = "1.16.0"
 serde= { version = "1.0", features = ["derive"] }
-serde_json = "1.0.103"
+serde_json = "1.0.104"
 serde_yaml = "0.9.25"
 similar = { version = "2.2.1", features = ["inline"] }
 tokio = { version = "1", features = ["rt-multi-thread", "io-std"] }

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/src/config.rs

@@ -7,6 +7,7 @@ use ast_grep_config::{
 };
 use ast_grep_language::config_file_type;
 use clap::ValueEnum;
+use ignore::overrides::OverrideBuilder;
 use ignore::WalkBuilder;
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
@@ -44,9 +45,7 @@ pub struct AstGrepConfig {
   pub util_dirs: Option<Vec<PathBuf>>,
   /// configuration for custom languages
   #[serde(skip_serializing_if = "Option::is_none")]
-  pub custom_languages: Option<HashMap<String, CustomLang>>, // /// overriding config for rules
-                                                             // #[serde(skip_serializing_if="Option::is_none")]
-                                                             // pub rules: Option<Vec<()>>,
+  pub custom_languages: Option<HashMap<String, CustomLang>>,
 }
 
 pub fn find_rules(config_path: Option<PathBuf>) -> Result<RuleCollection<SgLang>> {
@@ -156,7 +155,7 @@ pub struct TestHarness {
   pub path_map: HashMap<String, PathBuf>,
 }
 
-pub fn find_tests(config_path: Option<PathBuf>) -> Result<TestHarness> {
+pub fn find_tests(config_path: Option<PathBuf>, glob_filter: Option<&str>) -> Result<TestHarness> {
   let config_path =
     find_config_path_with_default(config_path, None).context(EC::ReadConfiguration)?;
   let config_str = read_to_string(&config_path).context(EC::ReadConfiguration)?;
@@ -173,7 +172,12 @@ pub fn find_tests(config_path: Option<PathBuf>) -> Result<TestHarness> {
       test_cases: new_cases,
       snapshots: new_snapshots,
       path_map: new_path_map,
-    } = read_test_files(base_dir, &test.test_dir, test.snapshot_dir.as_deref())?;
+    } = read_test_files(
+      base_dir,
+      &test.test_dir,
+      test.snapshot_dir.as_deref(),
+      glob_filter,
+    )?;
     path_map.extend(new_path_map);
     test_cases.extend(new_cases);
     snapshots.extend(new_snapshots);
@@ -185,22 +189,46 @@ pub fn find_tests(config_path: Option<PathBuf>) -> Result<TestHarness> {
   })
 }
 
+fn build_test_dir_walker(
+  test_path: &Path,
+  snapshot_dirname: &Path,
+  glob_filter: Option<&str>,
+) -> Result<ignore::Walk> {
+  let snapshot_glob = snapshot_dirname.join("*");
+
+  let glob_override = OverrideBuilder::new(test_path)
+    .add(glob_filter.unwrap_or("*"))?
+    .add(
+      snapshot_glob
+        .to_str()
+        .expect("snapshot glob should be valid utf-8"),
+    )?
+    .build()?;
+
+  let walker = WalkBuilder::new(test_path)
+    .types(config_file_type())
+    .overrides(glob_override)
+    .build();
+
+  Ok(walker)
+}
+
 pub fn read_test_files(
   base_dir: &Path,
-  test_dir: &Path,
-  snapshot_dir: Option<&Path>,
+  test_dirname: &Path,
+  snapshot_dirname: Option<&Path>,
+  glob_filter: Option<&str>,
 ) -> Result<TestHarness> {
   let mut test_cases = vec![];
   let mut snapshots = HashMap::new();
   let mut path_map = HashMap::new();
-  let dir_path = base_dir.join(test_dir);
-  let snapshot_dir = snapshot_dir.unwrap_or_else(|| SNAPSHOT_DIR.as_ref());
-  let snapshot_dir = dir_path.join(snapshot_dir);
-  let walker = WalkBuilder::new(&dir_path)
-    .types(config_file_type())
-    .build();
+  let test_path = base_dir.join(test_dirname);
+  let snapshot_dirname = snapshot_dirname.unwrap_or_else(|| SNAPSHOT_DIR.as_ref());
+  let snapshot_path = test_path.join(snapshot_dirname);
+  let walker = build_test_dir_walker(&test_path, snapshot_dirname, glob_filter)
+    .with_context(|| EC::TestCaseGlobFilter)?;
   for dir in walker {
-    let config_file = dir.with_context(|| EC::WalkRuleDir(dir_path.clone()))?;
+    let config_file = dir.with_context(|| EC::WalkRuleDir(test_path.clone()))?;
     // file_type is None only if it is stdin, safe to unwrap here
     if !config_file
       .file_type()
@@ -211,14 +239,14 @@ pub fn read_test_files(
     }
     let path = config_file.path();
     let yaml = read_to_string(path).with_context(|| EC::ReadRule(path.to_path_buf()))?;
-    if path.starts_with(&snapshot_dir) {
+    if path.starts_with(&snapshot_path) {
       let snapshot: TestSnapshots =
         from_str(&yaml).with_context(|| EC::ParseTest(path.to_path_buf()))?;
       snapshots.insert(snapshot.id.clone(), snapshot);
     } else {
       let test_case: TestCase =
         from_str(&yaml).with_context(|| EC::ParseTest(path.to_path_buf()))?;
-      path_map.insert(test_case.id.clone(), dir_path.join(SNAPSHOT_DIR));
+      path_map.insert(test_case.id.clone(), test_path.join(snapshot_dirname));
       test_cases.push(test_case);
     }
   }
@@ -229,14 +257,17 @@ pub fn read_test_files(
   })
 }
 
+/// Returns the base_directory where config is and config object.
 pub fn read_config_from_dir<P: AsRef<Path>>(path: P) -> Result<Option<(PathBuf, AstGrepConfig)>> {
-  let config_path =
+  let mut config_path =
     find_config_path_with_default(None, Some(path.as_ref())).context(EC::ReadConfiguration)?;
   if !config_path.is_file() {
     return Ok(None);
   }
   let config_str = read_to_string(&config_path).context(EC::ReadConfiguration)?;
   let sg_config = from_str(&config_str).context(EC::ParseConfiguration)?;
+  // remove sgconfig.yml from the path
+  config_path.pop(); // ./sg_config -> ./
   Ok(Some((config_path, sg_config)))
 }
 
@@ -268,12 +299,13 @@ fn find_config_path_with_default(
   }
 }
 
+/// File types to ignore
 #[derive(Clone, Copy, Deserialize, Serialize, ValueEnum)]
 pub enum IgnoreFile {
   /// Search hidden files and directories. By default, hidden files and directories are skipped.
   Hidden,
   /// Don't respect .ignore files.
-  /// This does *not* affect whether ripgrep will ignore files and directories whose names begin with a dot.
+  /// This does *not* affect whether ast-grep will ignore files and directories whose names begin with a dot.
   /// For that, use --no-ignore hidden.
   Dot,
   /// Don't respect ignore files that are manually configured for the repository such as git's '.git/info/exclude'.

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/src/error.rs

@@ -4,8 +4,6 @@ use anyhow::{Error, Result};
 use std::fmt;
 use std::path::PathBuf;
 
-use crate::utils::ansi_link;
-
 const DOC_SITE_HOST: &str = "https://ast-grep.github.io";
 const PATTERN_GUIDE: Option<&str> = Some("/guide/pattern-syntax.html");
 const CONFIG_GUIDE: Option<&str> = Some("/guide/rule-config.html");
@@ -43,6 +41,7 @@ pub enum ErrorContext {
   WriteFile(PathBuf),
   // Test
   TestFail(String),
+  TestCaseGlobFilter,
   // New
   ProjectAlreadyExist,
   ProjectNotExist,
@@ -63,7 +62,8 @@ impl ErrorContext {
       NoTestDirConfigured | NoUtilDirConfigured => 4,
       ReadConfiguration | ReadRule(_) | WalkRuleDir(_) | WriteFile(_) => 5,
       StdInIsNotInteractive => 6,
-      ParseTest(_) | ParseRule(_) | ParseConfiguration | GlobPattern | ParsePattern => 8,
+      ParseTest(_) | ParseRule(_) | ParseConfiguration | GlobPattern | ParsePattern
+      | TestCaseGlobFilter => 8,
       ProjectAlreadyExist | FileAlreadyExist(_) => 17,
       InsufficientCLIArgument(_) => 22,
       OpenEditor | StartLanguageServer => 126,
@@ -181,6 +181,11 @@ impl ErrorMessage {
         "You can use ast-grep playground to debug your rules and test cases.",
         PLAYGROUND,
       ),
+      TestCaseGlobFilter => Self::new(
+        "Cannot parse the test case glob pattern.",
+        "The pattern provided to filter test cases to run is not a valid glob. Please refer to the doc and fix the error.",
+        CLI_USAGE,
+      ),
       ProjectAlreadyExist => Self::new(
         "ast-grep project already exists.",
         "You are already inside a sub-folder of an ast-grep project. Try finding sgconfig.yml in ancestor directory?",
@@ -231,6 +236,17 @@ pub fn exit_with_error(error: Error) -> Result<()> {
   Err(error)
 }
 
+// use raw ansi escape code to render links in terminal. references:
+// https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+// https://github.com/zkat/miette/blob/c25676cb1f4266c2607836e6359f15b9cbd8637e/src/handlers/graphical.rs#L186
+fn ansi_link(url: String) -> String {
+  format!(
+    "\u{1b}]8;;{}\u{1b}\\{}\u{1b}]8;;\u{1b}\\",
+    url,
+    ansi_term::Color::Cyan.italic().paint(&url)
+  )
+}
+
 struct ErrorFormat<'a> {
   context: &'a ErrorContext,
   inner: &'a Error,

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/src/lib.rs

@@ -158,6 +158,9 @@ mod test_cli {
     ok("run -p test dir1 dir2 dir3"); // multiple paths
     ok("run -p testm -r restm -U"); // update all
     ok("run -p testm -r restm --update-all"); // update all
+    ok("run -p test --json compact"); // argument after --json should not be parsed as JsonStyle
+    ok("run -p test --json=pretty dir");
+    ok("run -p test --json dir"); // arg after --json should not be parsed as JsonStyle
     error("run test");
     error("run --debug-query test"); // missing lang
     error("run -r Test dir");
@@ -185,6 +188,8 @@ mod test_cli {
     error("scan -f gitlab");
     error("scan -f github -i");
     error("scan -f local");
+    error("scan --json=dir"); // wrong json flag
+    error("scan --json= not-pretty"); // wrong json flag
   }
 
   #[test]

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/src/new.rs

@@ -65,11 +65,10 @@ impl NewArg {
   }
 
   fn choose_language(&self) -> Result<SgLang> {
-    if self.yes {
-      self
-        .lang
-        .map(Ok)
-        .unwrap_or_else(|| Err(anyhow::anyhow!(EC::InsufficientCLIArgument("lang"))))
+    if let Some(lang) = self.lang {
+      Ok(lang)
+    } else if self.yes {
+      Err(anyhow::anyhow!(EC::InsufficientCLIArgument("lang")))
     } else {
       Ok(inquire::Select::new("Choose rule's language", SgLang::all_langs()).prompt()?)
     }
@@ -119,12 +118,12 @@ pub fn run_create_new(mut arg: NewArg) -> Result<()> {
   }
 }
 
+// base_dir, config
 type FoundConfig = (PathBuf, AstGrepConfig);
 
 fn run_create_entity(entity: Entity, arg: NewArg) -> Result<()> {
   // check if we are under a project dir
-  if let Some(mut found) = read_config_from_dir(&arg.base_dir)? {
-    found.0.pop(); // remove sgconfig.yml from the path
+  if let Some(found) = read_config_from_dir(&arg.base_dir)? {
     return do_create_entity(entity, found, arg);
   }
   // check if we creating a project
@@ -148,10 +147,10 @@ fn do_create_entity(entity: Entity, found: FoundConfig, arg: NewArg) -> Result<(
 
 fn ask_entity_type(arg: NewArg) -> Result<()> {
   // 1. check if we are under a sgconfig.yml
-  if let Some(sg_config) = read_config_from_dir(&arg.base_dir)? {
+  if let Some(found) = read_config_from_dir(&arg.base_dir)? {
     // 2. ask users what to create if yes
     let entity = arg.ask_entity_type()?;
-    do_create_entity(entity, sg_config, arg)
+    do_create_entity(entity, found, arg)
   } else {
     // 3. ask users to provide project info if no sgconfig found
     print!("No sgconfig.yml found. ");
@@ -192,7 +191,7 @@ fn default_rule(id: &str, lang: SgLang) -> String {
   format!(
     r#"id: {id}
 message: Add your rule message here....
-severity: error # error, warning, hint, info
+severity: error # error, warning, info, hint
 language: {lang}
 rule:
   pattern: Your Rule Pattern here...
@@ -202,8 +201,7 @@ rule:
 }
 
 fn create_new_rule(found: FoundConfig, arg: NewArg) -> Result<()> {
-  let base_dir = found.0;
-  let sg_config = found.1;
+  let (base_dir, sg_config) = found;
   let name = arg.ask_name("rule")?;
   let rule_dir = if sg_config.rule_dirs.len() > 1 {
     let dirs = sg_config.rule_dirs.iter().map(|p| p.display()).collect();
@@ -279,8 +277,7 @@ rule:
 }
 
 fn create_new_util(found: FoundConfig, arg: NewArg) -> Result<()> {
-  let base_dir = found.0;
-  let sg_config = found.1;
+  let (base_dir, sg_config) = found;
   let Some(utils) = sg_config.util_dirs else {
     return Err(anyhow::anyhow!(EC::NoUtilDirConfigured));
   };
@@ -339,6 +336,19 @@ mod test {
     Ok(())
   }
 
+  fn create_util(temp: &Path) -> Result<()> {
+    let arg = NewArg {
+      entity: Some(Entity::Util),
+      name: Some("test-utils".into()),
+      lang: Some(SupportLang::Rust.into()),
+      yes: true,
+      base_dir: temp.to_path_buf(),
+    };
+    run_create_new(arg).unwrap();
+    assert!(temp.join("utils/test-utils.yml").exists());
+    Ok(())
+  }
+
   #[test]
   fn test_create_new() -> Result<()> {
     let dir = TempDir::new("sgtest")?;
@@ -347,4 +357,13 @@ mod test {
     drop(dir); // drop at the end since temp dir clean up is done in Drop
     Ok(())
   }
+
+  #[test]
+  fn test_create_util() -> Result<()> {
+    let dir = TempDir::new("sgtest")?;
+    create_project(dir.path())?;
+    create_util(dir.path())?;
+    drop(dir); // drop at the end since temp dir clean up is done in Drop
+    Ok(())
+  }
 }

{ast_grep_cli-0.9.2 → ast_grep_cli-0.10.0}/crates/cli/src/print/cloud_print.rs

@@ -5,7 +5,7 @@ use clap::ValueEnum;
 
 use anyhow::Result;
 use ast_grep_core::{NodeMatch as SgNodeMatch, StrDoc};
-pub use codespan_reporting::{files::SimpleFile, term::ColorArg};
+use codespan_reporting::files::SimpleFile;
 use std::io::{Stdout, Write};
 use std::sync::Mutex;