facebook/jscodeshift
Jscodeshift
jscodeshift is a JavaScript AST transformation toolkit and codemod engine designed for large-scale code refactoring and structural migrations. It provides a set of utilities to parse source code into abstract syntax trees, programmatically modify those trees, and convert them back into source text.
The tool distinguishes itself by preserving original source formatting and stylistic properties during the transformation process. It utilizes a builder for generating structurally valid AST nodes and integrates interchangeable parsing engines to support different language standards and experimental syntax.
The toolkit covers broad capabilities for AST management, including node construction, location, and modification. It includes a CLI for automation tasks such as batch file processing, glob-based file resolution, and transformation validation through the use of test suites and fixtures.
Features
- AST Transformation Tools - Provides a comprehensive toolkit for parsing and transforming source code using Abstract Syntax Trees.
- AST Structure Modification - Implements code changes by replacing, inserting, removing, or renaming nodes within the source tree.
- AST to Source Conversion - Converts a modified abstract syntax tree back into formatted source code for project integration.
- Codemod Migration Tools - Automates large-scale code refactoring and library migrations across an entire project using transformation scripts.
- Automated Code Refactoring - Automatically applies structural changes to source code to perform large-scale refactoring.
- Code Refactoring Tools - Modifies source code by manipulating its structural tree while preserving original formatting and stylistic properties.
- Code Transformation Tools - Provides a runtime for executing transformation scripts against files or standard input for structural refactoring.
- Stylistic Property Preservation - Maintains the original formatting and stylistic properties of source code during the tree transformation process.
- API Migrations - Automates repetitive structural changes across many files to move projects to new API or library versions.
- Format-Preserving Printing - Preserves original source formatting and stylistic properties when converting the AST back to text.
- Abstract Syntax Tree Tools - Includes a safe builder for programmatically generating and modifying AST nodes to ensure structurally valid source code.
- Interchangeable Parser Integrations - Integrates interchangeable parsing engines to support various JavaScript standards and experimental syntax features.
- AST Node Predicate Filtering - Isolates specific code elements for transformation using boolean predicates applied during tree traversal.
- AST Node Generation - Provides safe builder methods to programmatically generate abstract syntax tree nodes.
- AST Node Collection Filtering - Isolates specific elements for transformation by sifting through sets of nodes using predicates and type checks.
- AST Node Location - Searches for nodes based on type, name, or relationship to identify specific elements and their enclosing scopes.
- Parser Configurations - Allows specifying different parsing engines to support various JavaScript language standards and experimental syntax.
- File Processing Utilities - Executes transformation scripts over large batches of target files and generates processing summaries.
- Development Automation - Provides a framework for creating custom scripts to automate repetitive coding tasks and complex search-and-replace operations.
- Visitor Patterns - Employs the visitor pattern to walk the code hierarchy and trigger handlers on specific node types.
- Safe AST Node Builders - Provides safe builder methods to programmatically generate structurally valid abstract syntax tree nodes.
- Transformation Rule Testing - Verifies transformation accuracy by comparing input fixtures against expected output files in a test suite.
- Packages - Listed in the “Packages” section of the Awesome Ava awesome list.
