bbatsov/projectile
Projectile
Projectile is an Emacs project management library and workflow toolkit designed for discovering project roots, indexing files, and navigating source code. It functions as a project file indexer and project-wide search tool, utilizing version control markers to identify project boundaries and track uncommitted changes.
The system distinguishes itself through a pluggable architecture for indexing backends and search interfaces. It supports asynchronous indexing to prevent interface freezing and utilizes persistent caching to accelerate file lookups. Navigation is further enhanced by the ability to toggle between related files based on naming conventions and the capacity to search for files across multiple project roots in a combined view.
The toolkit covers a broad surface of project administration, including the execution of project-specific build and test commands, integration with CMake presets, and the management of project-specific terminal sessions. It also provides utilities for global text replacement, symbol reference location, and integration with external completion frameworks and file explorers.
Features
- Project Management Libraries - Serves as a comprehensive library for project root discovery, file indexing, and source code navigation within Emacs.
- Project Root Discovery - Identifies project boundaries by scanning for version control indicators or specific configuration files in the directory hierarchy.
- Project Descriptor Caches - Caches high-level project structure and file lists to avoid redundant filesystem scans across sessions.
- Search Backend Abstractions - Provides pluggable interfaces that abstract global text search and replacement across different search tool implementations.
- Project File Search - Implements a searchable interface to quickly locate and open files within a project directory.
- Project Search Tools - Provides high-performance global text search and replacement operations across all files in a recognized project.
- Project Type Definitions - Registers new project types by specifying unique marker files and compilation conventions.
- Project Workflow Tools - Offers a toolkit for defining and executing project-specific build commands, test runs, and shell integrations.
- Version Control Integrations - Utilizes version control markers to identify project boundaries and track uncommitted changes.
- Project File Indexing - Implements a system for scanning directory structures and caching file lists to enable rapid file lookup.
- Indexing Backends - Uses a registration system to switch between native Lisp, shell commands, or version control tools for file discovery.
- Related File Cyclers - Provides utilities to toggle between associated files, such as source and test pairs, based on naming patterns.
- File Lookup Caches - Stores indexed file lists in memory or on disk to accelerate subsequent lookups and navigation.
- Asynchronous Project Scans - Performs project indexing in the background to maintain editor responsiveness during large filesystem scans.
- Code Reference Locators - Finds all occurrences and references of specific symbols across the entire project codebase.
- Project Command Dispatchers - Triggers common project actions and custom methods through a central interactive dispatch menu.
- Project Task Execution - Executes build tools and named command sequences within the current project context.
- Root-Relative Command Execution - Executes configuration, compilation, and test commands relative to the discovered project root.
- Remote Navigation Optimizations - Accelerates file discovery and indexing over remote connections using optimized shell commands.
- Project Context Switchers - Transitions the active session to different projects and manages the associated set of buffers.
- Indexing Exclusions - Allows excluding specific files or extensions from the project index using defined patterns.
- Asynchronous Project File Streams - Implements mechanisms for incrementally streaming project file lists to asynchronous interfaces during discovery.
- Directory-Local Command Configurations - Allows project-specific build and test commands to be defined within directory-local configuration files.
- Source-to-Test Mappings - Switches between source and test files by applying naming conventions and extension transformations to filenames.
- Project Action Menus - Centralizes project commands and lifecycle tasks through a single interactive dispatch menu.
- Bulk Text Replacers - Executes global query-replace operations on text patterns across all files in a project.
