Merge #997

997: Improve filtering of file roots r=matklad a=vipentti

`ProjectWorkspace::to_roots` now returns a new `ProjectRoot` which contains
information regarding whether or not the given path is part of the current
workspace or an external dependency. This information can then be used in
`ra_batch` and `ra_lsp_server` to implement more advanced filtering. This allows
us to filter some unnecessary folders from external dependencies such as tests,
examples and benches.

Relates to discussion in #869 

Co-authored-by: Ville Penttinen <[email protected]>

2 files changed, 61 insertions, 29 deletions

diff --git a/crates/ra_batch/src/lib.rs b/crates/ra_batch/src/lib.rs
index a054d0da3..deb9f95d7 100644
--- a/crates/ra_batch/src/lib.rs
+++ b/crates/ra_batch/src/lib.rs
@@ -1,5 +1,7 @@
+mod vfs_filter;
+
 use std::sync::Arc;
-use std::path::{Path, PathBuf};
+use std::path::Path;
 use std::collections::HashSet;
 
 use rustc_hash::FxHashMap;
@@ -9,7 +11,8 @@ use ra_db::{
 };
 use ra_hir::{db, HirInterner};
 use ra_project_model::ProjectWorkspace;
-use ra_vfs::{Vfs, VfsChange, RootEntry, Filter, RelativePath};
+use ra_vfs::{Vfs, VfsChange};
+use vfs_filter::IncludeRustFiles;
 
 type Result<T> = std::result::Result<T, failure::Error>;
 
@@ -43,30 +46,6 @@ fn vfs_root_to_id(r: ra_vfs::VfsRoot) -> SourceRootId {
     SourceRootId(r.0.into())
 }
 
-struct IncludeRustFiles;
-
-impl IncludeRustFiles {
-    fn to_entry(path: PathBuf) -> RootEntry {
-        RootEntry::new(path, Box::new(Self {}))
-    }
-}
-
-impl Filter for IncludeRustFiles {
-    fn include_dir(&self, dir_path: &RelativePath) -> bool {
-        const IGNORED_FOLDERS: &[&str] = &["node_modules", "target", ".git"];
-
-        let is_ignored = dir_path.components().any(|c| IGNORED_FOLDERS.contains(&c.as_str()));
-
-        let hidden = dir_path.components().any(|c| c.as_str().starts_with("."));
-
-        !is_ignored && !hidden
-    }
-
-    fn include_file(&self, file_path: &RelativePath) -> bool {
-        file_path.extension() == Some("rs")
-    }
-}
-
 impl BatchDatabase {
     pub fn load(crate_graph: CrateGraph, vfs: &mut Vfs) -> BatchDatabase {
         let mut db =
@@ -122,9 +101,8 @@ impl BatchDatabase {
         let root = std::env::current_dir()?.join(root);
         let ws = ProjectWorkspace::discover(root.as_ref())?;
         let mut roots = Vec::new();
-        roots.push(root.clone());
-        roots.extend(ws.to_roots());
-        let roots = roots.into_iter().map(IncludeRustFiles::to_entry).collect::<Vec<_>>();
+        roots.push(IncludeRustFiles::member(root.clone()));
+        roots.extend(IncludeRustFiles::from_roots(ws.to_roots()));
         let (mut vfs, roots) = Vfs::new(roots);
         let mut load = |path: &Path| {
             let vfs_file = vfs.load(path);
diff --git a/crates/ra_batch/src/vfs_filter.rs b/crates/ra_batch/src/vfs_filter.rs
new file mode 100644
index 000000000..dd20c1203
--- /dev/null
+++ b/crates/ra_batch/src/vfs_filter.rs
@@ -0,0 +1,54 @@
+use std::path::PathBuf;

+use ra_project_model::ProjectRoot;

+use ra_vfs::{RootEntry, Filter, RelativePath};

+

+/// `IncludeRustFiles` is used to convert

+/// from `ProjectRoot` to `RootEntry` for VFS

+pub struct IncludeRustFiles {

+    root: ProjectRoot,

+}

+

+impl IncludeRustFiles {

+    pub fn from_roots<R>(roots: R) -> impl Iterator<Item = RootEntry>

+    where

+        R: IntoIterator<Item = ProjectRoot>,

+    {

+        roots.into_iter().map(IncludeRustFiles::from_root)

+    }

+

+    pub fn from_root(root: ProjectRoot) -> RootEntry {

+        IncludeRustFiles::from(root).into()

+    }

+

+    #[allow(unused)]

+    pub fn external(path: PathBuf) -> RootEntry {

+        IncludeRustFiles::from_root(ProjectRoot::new(path, false))

+    }

+

+    pub fn member(path: PathBuf) -> RootEntry {

+        IncludeRustFiles::from_root(ProjectRoot::new(path, true))

+    }

+}

+

+impl Filter for IncludeRustFiles {

+    fn include_dir(&self, dir_path: &RelativePath) -> bool {

+        self.root.include_dir(dir_path)

+    }

+

+    fn include_file(&self, file_path: &RelativePath) -> bool {

+        self.root.include_file(file_path)

+    }

+}

+

+impl std::convert::From<ProjectRoot> for IncludeRustFiles {

+    fn from(v: ProjectRoot) -> IncludeRustFiles {

+        IncludeRustFiles { root: v }

+    }

+}

+

+impl std::convert::From<IncludeRustFiles> for RootEntry {

+    fn from(v: IncludeRustFiles) -> RootEntry {

+        let path = v.root.path().clone();

+        RootEntry::new(path, Box::new(v))

+    }

+}