benmosher/eslint-plugin-import
Eslint Plugin Import
eslint-plugin-import is an ESLint static analysis plugin that provides a suite of rules and resolvers to validate import statements and enforce architectural constraints on how files import and export code. It functions as a module validator and resolver to ensure that import declarations point to valid files and that referenced symbols exist.
The project identifies recursive import chains to prevent circular dependencies and utilizes a configurable resolution system to map aliases and non-standard file paths. It can also distinguish between internal project files and external library dependencies through path and folder pattern matching.
The plugin covers broader code quality areas including import style enforcement for ordering and grouping, the restriction of specific module systems, and the verification of export availability to prevent runtime errors. It can further limit import sources based on folder location or prohibit specific path types.
Features
- ESLint Import Plugins - Provides an ESLint plugin that validates import names, paths, and styles using custom resolvers.
- Import Style Enforcers - Enforces consistent import ordering, grouping, and style across the codebase.
- Export Name Validators - Verifies that named imports match the actual exported symbols of the target module to prevent runtime errors.
- Existence Verifications - Provides static analysis to verify that every import statement points to a file or module physically present on the filesystem.
- JavaScript Module Validation - Checks that import paths are correct and named exports exist to prevent runtime errors in JavaScript projects.
- Module Resolvers - Resolves module paths and maps aliases to verify that import declarations are valid.
- Named Import Export Matchers - Matches named and default imports against actual exports of the target module to ensure availability.
- Custom Module System Resolvers - Provides a pluggable system of resolvers to map import paths using various module system semantics.
- Import Statement Validators - Validates that import declarations point to existing files and follow structural requirements.
- Import Style Transformations - Enforces import ordering and grouping by transforming the abstract syntax tree based on configuration.
- Path-Based Restrictions - Enforces architectural constraints by limiting which files can be imported based on folder location or prohibiting specific path types.
- Circular Dependency Detectors - Scans for recursive import loops in module graphs to identify circular dependencies.
- Module Dependency Graphs - Builds module dependency graphs to detect and prevent circular import loops.
- Module System Restrictions - Forbids the use of specific module systems like CommonJS or AMD to maintain a consistent architectural pattern.
- Module System Restrictions - Restricts the use of specific module formats like CommonJS to ensure a consistent architectural pattern.
- Static Analysis AST Parsing - Parses source code into abstract syntax trees to validate the structure of import and export declarations.
- Architecture and Style Plugins - Manages ES2015+ import/export syntax and paths.
