watchexec/lib/src/project.rs

232 lines
6.4 KiB
Rust
Raw Normal View History

2021-10-09 07:45:32 +02:00
//! Detect project type and origin.
use std::{
2021-10-10 12:35:11 +02:00
collections::{HashMap, HashSet},
fs::FileType,
path::{Path, PathBuf},
};
2021-10-09 07:45:32 +02:00
2021-10-10 12:35:11 +02:00
use futures::StreamExt;
use tokio::fs::read_dir;
use tokio_stream::wrappers::ReadDirStream;
2021-10-10 06:55:50 +02:00
2021-10-10 12:35:11 +02:00
/// Project types recognised by watchexec.
///
/// There are two kinds of projects: VCS and software suite. The latter is more characterised by
/// what package manager or build system is in use. The enum is marked non-exhaustive as more types
/// can get added in the future.
///
/// Do not rely on the ordering or value (e.g. with transmute) of the variants.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ProjectType {
Bazaar,
Darcs,
Fossil,
Git,
Mercurial,
Pijul,
Bundler,
C,
Cargo,
Docker,
Elixir,
Gradle,
JavaScript,
Leiningen,
Maven,
Perl,
PHP,
Pip,
RubyGem,
V,
}
/// Traverses the parents of the given path and returns _all_ that are project origins.
///
/// This checks for the presence of a wide range of files and directories that are likely to be
/// present and indicative of the root or origin path of a project. It's entirely possible to have
/// multiple such origins show up: for example, a member of a Cargo workspace will list both the
/// member project and the workspace root as origins.
2021-10-10 06:55:50 +02:00
pub async fn origins(path: impl AsRef<Path>) -> Vec<PathBuf> {
let mut origins = Vec::new();
2021-10-10 12:35:11 +02:00
fn check_list(list: DirList) -> bool {
if list.is_empty() {
return false;
}
IntoIterator::into_iter([
list.has_dir("_darcs"),
list.has_dir(".bzr"),
list.has_dir(".fossil-settings"),
list.has_dir(".git"),
list.has_dir(".github"),
list.has_dir(".hg"),
list.has_file(".asf.yaml"),
list.has_file(".bzrignore"),
list.has_file(".codecov.yml"),
list.has_file(".ctags"),
list.has_file(".editorconfig"),
list.has_file(".gitattributes"),
list.has_file(".gitmodules"),
list.has_file(".hgignore"),
list.has_file(".hgtags"),
list.has_file(".perltidyrc"),
list.has_file(".travis.yml"),
list.has_file("appveyor.yml"),
list.has_file("build.gradle"),
list.has_file("build.properties"),
list.has_file("build.xml"),
list.has_file("Cargo.toml"),
list.has_file("Cargo.lock"),
list.has_file("cgmanifest.json"),
list.has_file("CMakeLists.txt"),
list.has_file("composer.json"),
list.has_file("COPYING"),
list.has_file("docker-compose.yml"),
list.has_file("Dockerfile"),
list.has_file("Gemfile"),
list.has_file("LICENSE.txt"),
list.has_file("LICENSE"),
list.has_file("Makefile.am"),
list.has_file("Makefile.pl"),
list.has_file("Makefile.PL"),
list.has_file("Makefile"),
list.has_file("mix.exs"),
list.has_file("moonshine-dependencies.xml"),
list.has_file("package.json"),
list.has_file("pom.xml"),
list.has_file("project.clj"),
list.has_file("README.md"),
list.has_file("README"),
list.has_file("requirements.txt"),
list.has_file("v.mod"),
])
.any(|f| f)
2021-10-10 06:55:50 +02:00
}
let mut current = path.as_ref();
2021-10-10 12:35:11 +02:00
if check_list(DirList::obtain(current).await) {
2021-10-10 06:55:50 +02:00
origins.push(current.to_owned());
}
while let Some(parent) = current.parent() {
current = parent;
2021-10-10 12:35:11 +02:00
if check_list(DirList::obtain(current).await) {
2021-10-10 06:55:50 +02:00
origins.push(current.to_owned());
continue;
}
}
origins
2021-10-09 07:45:32 +02:00
}
/// Returns all project types detected at this given origin.
///
/// This should be called with a result of [`origins()`], or a project origin if already known; it
2021-10-09 07:45:32 +02:00
/// will not find the origin itself.
2021-10-10 12:35:27 +02:00
///
/// The returned list may be empty.
///
/// Note that this only detects project types listed in the [`ProjectType`] enum, and may not detect
/// anything for some paths returned by [`origins()`].
pub async fn types(path: impl AsRef<Path>) -> HashSet<ProjectType> {
let list = DirList::obtain(path.as_ref()).await;
IntoIterator::into_iter([
list.if_has_dir("_darcs", ProjectType::Darcs),
list.if_has_dir(".bzr", ProjectType::Bazaar),
list.if_has_dir(".fossil-settings", ProjectType::Fossil),
list.if_has_dir(".git", ProjectType::Git),
list.if_has_dir(".hg", ProjectType::Mercurial),
list.if_has_file(".bzrignore", ProjectType::Bazaar),
list.if_has_file(".ctags", ProjectType::C),
list.if_has_file(".gitattributes", ProjectType::Git),
list.if_has_file(".gitmodules", ProjectType::Git),
list.if_has_file(".hgignore", ProjectType::Mercurial),
list.if_has_file(".hgtags", ProjectType::Mercurial),
list.if_has_file(".perltidyrc", ProjectType::Perl),
list.if_has_file("build.gradle", ProjectType::Gradle),
list.if_has_file("Cargo.toml", ProjectType::Cargo),
list.if_has_file("cgmanifest.json", ProjectType::JavaScript),
list.if_has_file("composer.json", ProjectType::PHP),
list.if_has_file("Dockerfile", ProjectType::Docker),
list.if_has_file("Gemfile", ProjectType::Bundler),
list.if_has_file("Makefile.PL", ProjectType::Perl),
list.if_has_file("mix.exs", ProjectType::Elixir),
list.if_has_file("package.json", ProjectType::JavaScript),
list.if_has_file("pom.xml", ProjectType::Maven),
list.if_has_file("project.clj", ProjectType::Leiningen),
list.if_has_file("requirements.txt", ProjectType::Pip),
list.if_has_file("v.mod", ProjectType::V),
])
.flatten()
.collect()
2021-10-09 07:45:32 +02:00
}
2021-10-10 12:35:11 +02:00
#[derive(Debug, Default)]
struct DirList(HashMap<PathBuf, FileType>);
impl DirList {
async fn obtain(path: &Path) -> Self {
if let Ok(s) = read_dir(path).await {
Self(
ReadDirStream::new(s)
.filter_map(|entry| async move {
match entry {
Err(_) => None,
Ok(entry) => {
if let (Ok(path), Ok(file_type)) =
(entry.path().strip_prefix(path), entry.file_type().await)
{
Some((path.to_owned(), file_type))
} else {
None
}
}
}
})
.collect::<HashMap<_, _>>()
.await,
)
} else {
Self::default()
}
}
2021-10-09 07:45:32 +02:00
2021-10-10 12:35:11 +02:00
#[inline]
fn is_empty(&self) -> bool {
self.0.is_empty()
2021-10-10 12:35:27 +02:00
}
2021-10-10 06:55:50 +02:00
2021-10-10 12:35:27 +02:00
#[inline]
2021-10-10 12:35:11 +02:00
fn has_file(&self, name: impl AsRef<Path>) -> bool {
let name = name.as_ref();
self.0.get(name).map(|x| x.is_file()).unwrap_or(false)
2021-10-10 12:35:27 +02:00
}
2021-10-10 06:55:50 +02:00
2021-10-10 12:35:27 +02:00
#[inline]
2021-10-10 12:35:11 +02:00
fn has_dir(&self, name: impl AsRef<Path>) -> bool {
let name = name.as_ref();
self.0.get(name).map(|x| x.is_dir()).unwrap_or(false)
2021-10-10 06:55:50 +02:00
}
2021-10-10 12:35:11 +02:00
#[inline]
fn if_has_file(&self, name: impl AsRef<Path>, project: ProjectType) -> Option<ProjectType> {
if self.has_file(name) {
Some(project)
} else {
None
2021-10-10 12:35:27 +02:00
}
2021-10-10 12:35:11 +02:00
}
2021-10-10 06:55:50 +02:00
2021-10-10 12:35:27 +02:00
#[inline]
2021-10-10 12:35:11 +02:00
fn if_has_dir(&self, name: impl AsRef<Path>, project: ProjectType) -> Option<ProjectType> {
if self.has_dir(name) {
Some(project)
} else {
None
2021-10-10 12:35:27 +02:00
}
2021-10-10 06:55:50 +02:00
}
}