palantir/tslintArchived
Tslint
TSLint is an extensible static analysis tool that checks TypeScript source files against a configurable set of lint rules. It scans code by walking the parsed TypeScript abstract syntax tree, applying rule objects to detect readability, maintainability, and functionality errors. The tool supports rule severity configuration, inline suppression through comment directives, and automatic attachment of fix objects for correcting violations.
The project provides a framework for developing custom lint rules and formatters, allowing teams to enforce project-specific coding conventions beyond the built-in rule set. It includes configuration preset extension through module resolution, enabling teams to share and inherit lint configurations across projects. TSLint integrates with editors, build systems, and CI pipelines, surfacing results inline during development or as part of automated builds.
The tool covers a broad range of code quality checks, including common mistake detection, consistent code style and formatting enforcement, and TypeScript-specific rule enforcement for type annotations, overloads, and namespace usage. It also supports JavaScript file linting with a separate rule set. Output formatting options include human-readable text, JSON, JUnit XML, Checkstyle XML, PMD XML, MSBuild format, TAP stream, and Azure DevOps logging commands, with the ability to write results to files or standard output.
Features
- TypeScript Static Analysis - An extensible static analysis tool that checks TypeScript files for readability, maintainability, and functionality errors.
- Custom Lint Rule Plugins - Provides a plugin API for developing custom lint rules and formatters beyond the built-in set.
- Linting Configurations - Ships a configuration system that defines, extends, and shares lint rule configurations via preset inheritance.
- Lint Rule AST Walkers - Walks the parsed TypeScript AST to detect rule violations by visiting nodes and applying pattern-matching logic.
- TypeScript and JavaScript Linting - Applies a separate set of rules to JavaScript and JSX files, optionally mirroring the TypeScript rule configuration.
- Static Analysis Rule Engines - Scans source code by matching each file against a set of configurable rule objects that inspect the AST for violations.
- General Lint Rule Engines - Evaluates TypeScript files against built-in and custom rules with severity levels, inline suppression, and automatic fixes.
- Static Code Analyzers - Scans TypeScript source code against configurable rules to catch errors and enforce coding standards.
- Static Logic Error Detection - Scans TypeScript source files against a configurable set of rules to detect readability, maintainability, and functionality issues.
- Code Formatting and Style - Applies rules for naming conventions, comment formats, import ordering, and other stylistic choices.
- Automated Lint Fixes - Automatically corrects formatting and style violations detected during linting without manual intervention.
- Fix Object Attachments - Attaches a replacement fix object to each detected failure, enabling automatic correction of violations during linting.
- Per-Rule Configurations - Reads user-supplied parameters inside custom rules to make behavior configurable per project.
- CI/CD Integrations - Surfaces lint results inside editors, build pipelines, and CI systems through multiple output formats.
- Formatting Enforcement - Checks whitespace, indentation, line length, and punctuation rules to maintain a uniform visual layout in source files.
- Custom Lint Rule Definitions - Loads user-defined or third-party lint rules from specified directories to extend available checks.
- Base Configuration Extension - Inherits rule settings from built-in or custom configuration files using module resolution.
- Configuration Inheritance - Resolves lint settings by merging a base configuration with overrides from user-defined files using module resolution.
- Lint Result Formatters - Transforms lint results into multiple output formats by dispatching to separate formatter modules.
- Auto-Fix Formatters - Applies automatic corrections to formatting and style violations detected during linting.
- Common Bug Detection - Detects frequent mistakes such as unused promises, eval usage, and duplicate variable declarations.
- Maintainability Rules - Applies rules on complexity, deprecation warnings, import organization, and variable mutability to keep codebases manageable.
- Automatic Lint Fixes - Ships automatic correction of formatting and style violations detected during linting.
- Lint Rule Presets - Applies bundled lint rule presets and composes rules from multiple plugins.
- Lint Rule Toggles - Suppresses lint rules for specific lines or blocks using comment flags in source files.
- TypeScript-Specific Rule Enforcement - Enforces TypeScript-specific rules for type annotations, overloads, and namespace usage.
- Rule Suppression Comments - Parses comment flags in source files to enable or disable specific rules for individual lines or code sections.
- Lint Rule Severity Levels - Assigns each lint rule a severity of error, warning, or off with a global default.
- Build Tools - Extensible linter for code quality.
