vercel · chris-olszewski · Aug 26, 2025 · Aug 26, 2025
@@ -1,3 +1,7 @@
+//! Utilities for tracing and analyzing import dependencies in JavaScript and
+//! TypeScript files. Provides functionality to discover and track module
+//! imports across a codebase. Used for `turbo boundaries`
+
 #![deny(clippy::all)]
 mod import_finder;
 mod tracer;

@@ -1,3 +1,7 @@
+//! HTTP client for interacting with the Remote Cache API.
+//! Provides authentication, caching, and telemetry endpoints for Remote Cache
+//! operations. By default configured for Vercel API
+
 #![feature(error_generic_member_access)]
 #![feature(assert_matches)]
 #![deny(clippy::all)]

@@ -1,3 +1,9 @@
+//! Cache management for task outputs
+//! Provides local and remote caching capabilities and a "multiplexed" cache
+//! which operates over both. When both are in use local is preferred and remote
+//! writes are done asynchronously. Under the hood cache artifacts are stored a
+//! gzipped tarballs.
+
 #![feature(error_generic_member_access)]
 #![feature(assert_matches)]
 #![feature(box_patterns)]

@@ -1,4 +1,9 @@
-#![deny(clippy::all)]
+//! CI/CD vendor detection and vendor-specific behavior
+//! Detects CI vendors and provides:
+//! - Env var containing current commit SHA
+//! - Env var containing current branch
+//! - Env var containing current user
+//! - Any vendor specific behavior for producing well formatted logs
 
 mod vendor_behavior;
 mod vendors;

@@ -1,3 +1,7 @@
+//! Platform-specific directory utilities
+//! A small patch on top of `dirs_next` that makes use of turbopath and respects
+//! `VERCEL_CONFIG_DIR_PATH` as an override.
+
 use dirs_next::config_dir as dirs_config_dir;
 use thiserror::Error;
 use turbopath::{AbsoluteSystemPathBuf, PathError};

@@ -1,3 +1,5 @@
+//! Environment variable filtering for tasks and hashing for cache keys.
+
 #![deny(clippy::all)]
 
 use std::{

@@ -1,3 +1,8 @@
+//! Diagnostic utilities to preserve source for more actionable error messages
+//! Used in conjunction with `miette` to include source snippets in errors.
+//! Any parsing of files should attempt to produce value of `Spanned<T>` so if
+//! we need to reference where T came from the span is available.
+
 use std::{
     fmt::Display,
     iter,

@@ -1,3 +1,8 @@
+//! A specialized map data structure with fixed keys determined at construction.
+//! Provides thread-safe, one-time initialization of values for predefined keys.
+//! This is exclusively used so we can lazily load `turbo.json`, cache the
+//! results, and return a reference to the loaded `turbo.json`.
+
 #![deny(clippy::all)]
 
 use std::sync::OnceLock;

@@ -1,3 +1,7 @@
+//! Framework detection and configuration inference for Turborepo.
+//! Automatically identifies JavaScript frameworks and what environment
+//! variables impact it.
+
 use std::{collections::HashMap, sync::OnceLock};
 
 use serde::Deserialize;

@@ -1,10 +1,14 @@
+//! File system utilities for used by Turborepo.
+//! At the moment only used for `turbo prune` to copy over package directories.
+
 #![deny(clippy::all)]
 
 use std::{
     fs::{DirBuilder, FileType, Metadata},
     io,
 };
 
+// `fs_err` preserves paths in the error messages unlike `std::fs`
 use fs_err as fs;
 use ignore::WalkBuilder;
 use turbopath::{AbsoluteSystemPath, AnchoredSystemPathBuf};

@@ -1,3 +1,8 @@
+//! Glob pattern matching and directory walking
+//! This is a layer on top of `wax` that performs some corrections to user
+//! provided globs as well as escaping characters that `wax` considers special,
+//! but we do not support.
+
 #![feature(assert_matches)]
 #![deny(clippy::all)]
 

@@ -1,3 +1,7 @@
+//! Additional utilities to be used with `petgraph`
+//! Provides transitive closure calculation and cycle detection with cut
+//! candidates to break cycles
+
 mod walker;
 
 use std::{collections::HashSet, fmt::Display, hash::Hash};

@@ -1,3 +1,13 @@
+//! Package manager lockfile parsing, analysis, and serialization
+//!
+//! Parsing and analysis are used to track which external packages a workspace
+//! package depends on. This allows Turborepo to not perform a global
+//! invalidation on a lockfile change, but instead only the packages which
+//! depend on the changed external packages.
+//!
+//! Serialization is exclusively used by `turbo prune` and is far more error
+//! prone than deserialization and analysis.
+
 #![deny(clippy::all)]
 // the pest proc macro adds an empty doc comment.
 #![allow(clippy::empty_docs)]

@@ -1,3 +1,12 @@
+//! `@vercel/microfrontends` configuration parsing
+//! This crate is only concerned with parsing the minimal amount of information
+//! that Turborepo needs to correctly invoke a local proxy. This allows this
+//! crate to avoid being kept in lock step with `@vercel/microfrontends`.
+//!
+//! The information required for the local proxy is the default package and the
+//! package names that are a part of microfrontend and their development task
+//! names.
+
 #![feature(assert_matches)]
 #![deny(clippy::all)]
 mod configv1;

@@ -1,3 +1,7 @@
+//! Process ID lock file management used by the daemon
+//! Forked from the `pidlock` crate in order to add Windows support and the
+//! ability to query the owner of the pidlock.
+
 #![deny(clippy::all)]
 #![feature(assert_matches)]
 

@@ -1,3 +1,11 @@
+//! Repository detection and package discovery for Turborepo.
+//! Handles monorepo structure, package graph construction, and dependency
+//! analysis.
+//!
+//! Primarily in a separate crate from the rest of the logic so the
+//! `@turbo/repository` NPM package can avoid depending on the entire Turborepo
+//! binary.
+
 #![feature(assert_matches)]
 #![feature(error_generic_member_access)]
 #![allow(clippy::result_large_err)]

@@ -1,3 +1,17 @@
+//! Identifiers for Turborepo tasks
+//!
+//! Consists of `TaskName`s and `TaskId`s
+//! `TaskId`s are fully qualified tasks that include the package and the task
+//! name e.g. `turbo#build` is the `build` task for the `turbo` package.
+//!
+//! `TaskName`s are what we accept as a user input for a "task".
+//! They do not need to be fully qualified, but can be.
+//! For example `dependsOn` takes `TaskName`s which allows for
+//! `"dependsOn": ["build", "schema#gen"]` where the package's build task is run
+//! along with the `schema` package's `gen` task.
+//!
+//! All `TaskId`s are valid `TaskName`s, but not vice versa.
+
 use std::{
     borrow::{Borrow, Cow},
     fmt,

@@ -1,3 +1,6 @@
+//! Marker type for biome parsed JSON strings which are not escaped
+//! See https://github.com/biomejs/biome/issues/1596 for more information
+
 use std::{
     fmt::{self, Display},
     ops::{Deref, DerefMut},

@@ -1,3 +1,5 @@
+//! Mock server implementation for a subset of the Vercel API.
+
 #![deny(clippy::all)]
 
 use std::{collections::HashMap, fs::OpenOptions, io::Write, net::SocketAddr, sync::Arc};