Added behavior to ignore matching directories

good-fences.js

@@ -13,6 +13,7 @@
      .option('-o, --output <string>', 'path to write found violations')
      .option('--baseUrl <string>', "Overrides `compilerOptions.baseUrl` property read from '--project' argument")
      .option('--ignoreExternalFences', 'Ignore external fences (e.g. those in `node_modules`)', false)
+     .option('--ignoredDirs', 'Ignore matching dirs (e.g. `--ignoreDirs lib` will ignore all source and fence files in all subdirs with name `lib`', [])
      .arguments('<path> [morePaths...]', 'Dirs to look for fence and source files')
  program.parse(process.argv);
 
@@ -24,7 +25,8 @@
     project: options.project,
     baseUrl: options.baseUrl,
     errOutputPath: options.errOutputPath,
-    ignoreExternalFences: options.ignoreExternalFences ? 1 : 0
+    ignoreExternalFences: options.ignoreExternalFences ? 1 : 0,
+    ignoredDirs: options.ignoredDirs
 });
  result.forEach(r => {
      console.error(r.detailedMessage);

src/good_fences_runner.rs

@@ -28,11 +28,12 @@ impl GoodFencesRunner {
         tsconfig_paths_json: TsconfigPathsJson,
         directory_paths_to_walk: &Vec<&str>,
         external_fences: ExternalFences,
+        ignored_dirs: Vec<String>,
     ) -> GoodFencesRunner {
         // find files
         let walked_files = directory_paths_to_walk
             .iter()
-            .map(|path| discover_fences_and_files(path, external_fences))
+            .map(|path| discover_fences_and_files(path, external_fences, ignored_dirs.clone()))
             .flatten();
 
         let (fences_wrapped, sources_wrapped): (Vec<WalkFileData>, Vec<WalkFileData>) =
@@ -232,6 +233,7 @@ mod test {
                 .unwrap(),
             &vec!["tests/good_fences_integration/src"],
             ExternalFences::Ignore,
+            Vec::new(),
         );
 
         assert_eq!(
@@ -437,6 +439,7 @@ mod test {
                 .unwrap(),
             &vec!["tests/good_fences_integration"],
             ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let mut violations = good_fences_runner.find_import_violations();
@@ -509,6 +512,7 @@ mod test {
                 .unwrap(),
             &vec!["tests/good_fences_integration/src"],
             ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let orphans = good_fences_runner.find_undefined_tags();

src/lib.rs

@@ -33,6 +33,7 @@ pub fn good_fences(opts: GoodFencesOptions) -> Vec<GoodFencesError> {
             Some(ief) => ief,
             None => ExternalFences::Include,
         },
+        opts.ignored_dirs,
     );
 
     println!("beginning fence evaluations");
@@ -79,6 +80,7 @@ pub struct GoodFencesOptions {
     pub base_url: Option<String>,
     pub err_output_path: Option<String>,
     pub ignore_external_fences: Option<ExternalFences>,
+    pub ignored_dirs: Vec<String>,
 }
 
 #[napi]

src/walk_dirs.rs

@@ -56,23 +56,25 @@ lazy_static! {
 pub fn discover_fences_and_files(
     start_path: &str,
     ignore_external_fences: ExternalFences,
+    ignored_dirs: Vec<String>,
 ) -> Vec<WalkFileData> {
     let walk_dir = WalkDirGeneric::<(TagList, WalkFileData)>::new(start_path).process_read_dir(
         move |read_dir_state, children| {
             // Custom filter -- retain only directories and fence.json files
             children.retain(|dir_entry_result| {
                 dir_entry_result
                     .as_ref()
-                    .map(|dir_entry| {
-                        dir_entry.file_type.is_dir()
-                            || match dir_entry.file_name.to_str() {
-                                Some(file_name_str) => {
-                                    !(ignore_external_fences == ExternalFences::Ignore
-                                        && file_name_str == "node_modules")
-                                        && should_retain_file(file_name_str)
-                                }
-                                None => false,
+                    .map(|dir_entry| match dir_entry.file_name.to_str() {
+                        Some(file_name_str) => {
+                            if dir_entry.file_type.is_dir() {
+                                return !(ignore_external_fences == ExternalFences::Ignore
+                                    && file_name_str == "node_modules")
+                                    && !ignored_dirs.contains(&file_name_str.to_string());
+                            } else {
+                                return should_retain_file(file_name_str);
                             }
+                        }
+                        None => todo!(),
                     })
                     .unwrap_or(false)
             });
@@ -240,6 +242,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "tests/walk_dir_simple",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected_root_fence = Fence {
@@ -271,6 +274,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "./tests/comments_panel_test",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected = "tests/comments_panel_test/packages/accelerator/accelerator-common/src/CommentsPanel/index.ts";
@@ -294,6 +298,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "tests/walk_dir_simple",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected_subsubdir_fence = Fence {
@@ -322,6 +327,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "tests/walk_dir_simple",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected_root_ts_file = SourceFile {
@@ -348,6 +354,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "tests/walk_dir_simple",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected_subdir_ts_file = SourceFile {
@@ -375,6 +382,7 @@ mod test {
         let discovered: Vec<WalkFileData> = discover_fences_and_files(
             "tests/walk_dir_simple",
             crate::walk_dirs::ExternalFences::Ignore,
+            Vec::new(),
         );
 
         let expected_subdir_ts_file = SourceFile {