Merge pull request #1509 from Xanewok/configurable-blacklist

Make crate blacklist user-configurable

Author: Xanewok

Cargo.lock

@@ -21,8 +21,7 @@ test = false
 path = "rls/src/main.rs"
 
 [dependencies]
-rls-analysis = "0.17.0"
-rls-blacklist = "0.1.3"
+rls-analysis = "0.18.0"
 rls-data = "0.19"
 # FIXME: Release rls-rustc 0.6.0 to crates.io
 rls-rustc = { version = "0.6.0", path = "rls-rustc" }

Cargo.toml

@@ -115,8 +115,10 @@ Currently we accept the following options:
 * `all_targets` (`bool`, defaults to `true`) checks the project as if you were
   running `cargo check --all-targets`. I.e., check all targets and integration
   tests too
-* `use_crate_blacklist` (`bool`, defaults to `true`) if disabled, also indexes
-  data from the [blacklisted](https://github.com/nrc/rls-blacklist/blob/master/src/lib.rs) crates
+* `crate_blacklist` (`[String]`, defaults to [this list](https://github.com/rust-dev-tools/rls-blacklist/blob/master/src/lib.rs))
+  allows to specify which crates should be skipped by the RLS.
+  By default skips libraries that are of considerable size but which the user
+  often may not be directly interested in, thus reducing the build latency.
 * `build_on_save` (`bool`, defaults to `false`) toggles whether the RLS should
   perform continuous analysis or only after a file is saved
 * `features` (`[String]`, defaults to empty) list of Cargo features to enable

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "rls-analysis"
-version = "0.17.0"
+version = "0.18.0"
 edition = "2018"
 authors = ["Nick Cameron <[email protected]>"]
 description = "Library for processing rustc's save-analysis data for the RLS"

rls-analysis/Cargo.toml

@@ -42,7 +42,8 @@ fn main() {
         std::process::exit(1);
     }
     let loader = Loader::new(PathBuf::from(env::args().nth(1).unwrap()));
-    let crates = rls_analysis::read_analysis_from_files(&loader, Default::default(), &[]);
+    let crates =
+        rls_analysis::read_analysis_from_files(&loader, Default::default(), &[] as &[&str]);
 
     for krate in &crates {
         println!("Crate {:?} data version {:?}", krate.id, krate.analysis.version);

rls-analysis/examples/print-crate-id.rs

@@ -25,6 +25,7 @@ pub use raw::{name_space_for_def_kind, read_analysis_from_files, Crate, CrateId,
 pub use symbol_query::SymbolQuery;
 
 use std::collections::HashMap;
+use std::fmt::Debug;
 use std::path::{Path, PathBuf};
 use std::sync::Mutex;
 use std::time::{Instant, SystemTime};
@@ -85,8 +86,6 @@ impl Id {
 /// Used to indicate a missing index in the Id.
 pub const NULL: Id = Id(u64::MAX);
 
-type Blacklist<'a> = &'a [&'static str];
-
 macro_rules! clone_field {
     ($field: ident) => {
         |x| x.$field.clone()
@@ -126,7 +125,7 @@ impl<L: AnalysisLoader> AnalysisHost<L> {
         analysis: Vec<data::Analysis>,
         path_prefix: &Path,
         base_dir: &Path,
-        blacklist: Blacklist<'_>,
+        blacklist: &[impl AsRef<str> + Debug],
     ) -> AResult<()> {
         self.reload_with_blacklist(path_prefix, base_dir, blacklist)?;
 
@@ -143,14 +142,14 @@ impl<L: AnalysisLoader> AnalysisHost<L> {
     }
 
     pub fn reload(&self, path_prefix: &Path, base_dir: &Path) -> AResult<()> {
-        self.reload_with_blacklist(path_prefix, base_dir, &[])
+        self.reload_with_blacklist(path_prefix, base_dir, &[] as &[&str])
     }
 
     pub fn reload_with_blacklist(
         &self,
         path_prefix: &Path,
         base_dir: &Path,
-        blacklist: Blacklist<'_>,
+        blacklist: &[impl AsRef<str> + Debug],
     ) -> AResult<()> {
         trace!("reload_with_blacklist {:?} {:?} {:?}", path_prefix, base_dir, blacklist);
         let empty = self.analysis.lock()?.is_none();
@@ -173,14 +172,14 @@ impl<L: AnalysisLoader> AnalysisHost<L> {
 
     /// Reloads the entire project's analysis data.
     pub fn hard_reload(&self, path_prefix: &Path, base_dir: &Path) -> AResult<()> {
-        self.hard_reload_with_blacklist(path_prefix, base_dir, &[])
+        self.hard_reload_with_blacklist(path_prefix, base_dir, &[] as &[&str])
     }
 
     pub fn hard_reload_with_blacklist(
         &self,
         path_prefix: &Path,
         base_dir: &Path,
-        blacklist: Blacklist<'_>,
+        blacklist: &[impl AsRef<str> + Debug],
     ) -> AResult<()> {
         trace!("hard_reload {:?} {:?}", path_prefix, base_dir);
         // We're going to create a dummy AnalysisHost that we will fill with data,
@@ -542,7 +541,7 @@ impl<L: AnalysisLoader> AnalysisHost<L> {
 
 impl ::std::fmt::Display for Id {
     fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
-        self.0.fmt(f)
+        ::std::fmt::Display::fmt(&self.0, f)
     }
 }
 

rls-analysis/src/lib.rs

@@ -6,13 +6,14 @@ pub use data::{
 };
 
 use std::collections::HashMap;
+use std::fmt::Debug;
 use std::fs::File;
 use std::io::{self, Read};
 use std::path::{Path, PathBuf};
 use std::time::{Instant, SystemTime};
 
 use crate::listings::{DirectoryListing, ListingKind};
-use crate::{AnalysisLoader, Blacklist};
+use crate::AnalysisLoader;
 
 #[derive(Debug)]
 pub struct Crate {
@@ -45,7 +46,7 @@ impl Crate {
 pub fn read_analysis_from_files<L: AnalysisLoader>(
     loader: &L,
     crate_timestamps: HashMap<PathBuf, SystemTime>,
-    crate_blacklist: Blacklist<'_>,
+    crate_blacklist: &[impl AsRef<str> + Debug],
 ) -> Vec<Crate> {
     let mut result = vec![];
 
@@ -92,8 +93,8 @@ pub fn read_analysis_from_files<L: AnalysisLoader>(
     result
 }
 
-fn ignore_data(file_name: &str, crate_blacklist: Blacklist<'_>) -> bool {
-    crate_blacklist.iter().any(|name| file_name.starts_with(&format!("lib{}-", name)))
+fn ignore_data(file_name: &str, crate_blacklist: &[impl AsRef<str>]) -> bool {
+    crate_blacklist.iter().any(|name| file_name.starts_with(&format!("lib{}-", name.as_ref())))
 }
 
 fn read_file_contents(path: &Path) -> io::Result<String> {