eslint、prettier、stylelint 和 tslint 都是用于维护代码质量和一致性的开发工具,但它们的侧重点不同。eslint 主要用于检查 JavaScript 和 TypeScript 代码中的逻辑错误和风格问题。prettier 专注于代码格式化,确保所有代码看起来都一样。stylelint 专门用于检查 CSS 预处理器和样式表中的错误。tslint 曾经是 TypeScript 的专用检查工具,但现已废弃,官方建议迁移至 eslint。
在构建现代前端应用时,保持代码质量和风格一致至关重要。eslint、prettier、stylelint 和 tslint 是生态中最常见的四个工具,但它们解决的问题不同。理解它们的区别能帮你搭建高效的工程化体系。
eslint 专注于 JavaScript 和 TypeScript 的代码质量。
var。// eslint: .eslintrc.js 配置示例
module.exports = {
parser: '@typescript-eslint/parser',
rules: {
'no-unused-vars': 'error',
'eqeqeq': 'warn'
}
};
prettier 专注于代码格式的统一。
// prettier: .prettierrc 配置示例
{
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"printWidth": 80
}
stylelint 专注于样式表的质量。
// stylelint: .stylelintrc.json 配置示例
{
"rules": {
"color-no-invalid-hex": true,
"selector-class-pattern": "^[a-z][a-zA-Z0-9]*$"
}
}
tslint 曾经是 TypeScript 的专用检查器。
eslint 类似,但已不再推荐使用。// tslint: tslint.json 配置示例 (已废弃)
{
"rules": {
"no-unused-variable": true,
"semicolon": [true, "always"]
}
}
在现代工程实践中,这些工具通常一起使用,而不是二选一。
eslint + prettier 是标准组合。
eslint 负责保证代码不出错。prettier 负责保证代码好看。eslint-config-prettier 关闭 eslint 中所有与格式相关的规则,避免冲突。// eslint: 关闭与 prettier 冲突的规则
module.exports = {
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'prettier' // 必须放在最后,以覆盖格式规则
]
};
stylelint 独立运行或集成到构建流程。
prettier 共存,prettier 格式化 CSS 结构,stylelint 检查 CSS 质量。# 命令行运行示例
npx eslint src/
npx prettier --write src/
npx stylelint "src/**/*.css"
tslint 不再适用于新项目。
eslint。tslint 会导致技术债务。# 迁移命令示例
# 不再安装 tslint
# 改为安装 eslint 及相关插件
npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
如果你正在维护旧项目,应制定计划迁移到 eslint。typescript-eslint 项目提供了完整的规则映射,可以帮助自动化这一过程。
| 特性 | eslint | prettier | stylelint | tslint |
|---|---|---|---|---|
| 主要用途 | 代码质量与逻辑检查 | 代码格式化 | 样式表检查 | TypeScript 检查 (已废弃) |
| 支持语言 | JS, TS, JSX, Vue 等 | JS, TS, CSS, JSON 等 | CSS, SCSS, Less | TypeScript 仅 |
| 配置复杂度 | 高 (可高度定制) | 低 ( opinionated ) | 中 (规则丰富) | 中 (已停止更新) |
| 维护状态 | ✅ 活跃维护 | ✅ 活跃维护 | ✅ 活跃维护 | ❌ 已废弃 |
| 推荐场景 | 所有 JS/TS 项目 | 所有项目 | 含 CSS 的项目 | 无 (请迁移) |
对于新项目:
eslint 配合 @typescript-eslint。prettier 用于格式化。stylelint 如果项目包含 CSS 模块。tslint,不要安装。对于旧项目:
tslint,计划迁移到 eslint。tslint-to-eslint-config 工具辅助转换配置。配置整合:
// package.json 脚本示例
{
"scripts": {
"lint": "eslint . --ext .ts,.tsx",
"format": "prettier --write .",
"lint:css": "stylelint \"src/**/*.css\""
}
}
这四个工具并非竞争关系,而是互补关系。eslint 和 stylelint 负责质量门禁,prettier 负责消除风格争论。tslint 已成为历史,应尽快从技术栈中移除。合理组合使用这些工具,能显著提升团队开发效率和代码可维护性 — 这是现代前端工程化的基石。
选择 eslint 作为 JavaScript 和 TypeScript 项目的主要代码检查工具。它拥有最丰富的插件生态,能够发现潜在的逻辑错误、未使用的变量以及复杂度过高的代码。对于新项目,建议配合 @typescript-eslint 插件使用,以获得最佳的 TypeScript 支持。
选择 prettier 来处理所有代码的格式化工作。它 opinionated 的设计理念意味着你不需要争论缩进是 2 格还是 4 格,只需提交代码即可。它与 eslint 互补,前者管逻辑质量,后者管代码长相。
选择 stylelint 来管理 CSS、SCSS 或 Less 样式文件。它能防止写错属性名、强制颜色格式统一以及避免特定选择器的使用。对于大型项目或设计系统,它是保持样式一致性的必要工具。
不要在新项目中选择 tslint。该工具已正式废弃,维护团队明确建议所有用户迁移到 eslint。继续使用 tslint 会导致无法获得最新的 TypeScript 特性支持,且未来可能面临兼容性问题。
Website | Configure ESLint | Rules | Contribute to ESLint | Report Bugs | Code of Conduct | X | Discord | Mastodon | Bluesky
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. In many ways, it is similar to JSLint and JSHint with a few exceptions:
To use ESLint, you must have Node.js (^20.19.0, ^22.13.0, or >=24) installed and built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)
If you use ESLint's TypeScript type definitions, TypeScript 5.3 or later is required.
You can install and configure ESLint using this command:
npm init @eslint/config@latest
After that, you can run ESLint on any file or directory like this:
npx eslint yourfile.js
To use ESLint with pnpm, we recommend setting up a .npmrc file with at least the following settings:
auto-install-peers=true
node-linker=hoisted
This ensures that pnpm installs dependencies in a way that is more compatible with npm and is less likely to produce errors.
You can configure rules in your eslint.config.js files as in this example:
import { defineConfig } from "eslint/config";
export default defineConfig([
{
files: ["**/*.js", "**/*.cjs", "**/*.mjs"],
rules: {
"prefer-const": "warn",
"no-constant-binary-expression": "error",
},
},
]);
The names "prefer-const" and "no-constant-binary-expression" are the names of rules in ESLint. The first value is the error level of the rule and can be one of these values:
"off" or 0 - turn the rule off"warn" or 1 - turn the rule on as a warning (doesn't affect exit code)"error" or 2 - turn the rule on as an error (exit code will be 1)The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the configuration docs).
The ESLint team provides ongoing support for the current version and six months of limited support for the previous version. Limited support includes critical bug fixes, security issues, and compatibility issues only.
ESLint offers commercial support for both current and previous versions through our partners, Tidelift and HeroDevs.
See Version Support for more details.
ESLint adheres to the OpenJS Foundation Code of Conduct.
Before filing an issue, please be sure to read the guidelines for what you're reporting:
Yes, ESLint natively supports parsing JSX syntax (this must be enabled in configuration). Please note that supporting JSX syntax is not the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend using eslint-plugin-react if you are using React and want React semantics.
No, ESLint and Prettier have different jobs: ESLint is a linter (looking for problematic patterns) and Prettier is a code formatter. Using both tools is common, refer to Prettier's documentation to learn how to configure them to work well with each other.
ESLint has full support for ECMAScript 3, 5, and every year from 2015 up until the most recent stage 4 specification (the default). You can set your desired ECMAScript syntax and other settings (like global variables) through configuration.
ESLint's parser only officially supports the latest final ECMAScript standard. We will make changes to core rules in order to avoid crashes on stage 3 ECMAScript syntax proposals (as long as they are implemented using the correct experimental ESTree syntax). We may make changes to core rules to better work with language extensions (such as JSX, Flow, and TypeScript) on a case-by-case basis.
In other cases (including if rules need to warn on more or fewer cases due to new syntax, rather than just not crashing), we recommend you use other parsers and/or rule plugins. If you are using Babel, you can use @babel/eslint-parser and @babel/eslint-plugin to use any option available in Babel.
Once a language feature has been adopted into the ECMAScript standard (stage 4 according to the TC39 process), we will accept issues and pull requests related to the new feature, subject to our contributing guidelines. Until then, please use the appropriate parser and plugin(s) for your experimental feature.
ESLint updates the supported Node.js versions with each major release of ESLint. At that time, ESLint's supported Node.js versions are updated to be:
ESLint is also expected to work with Node.js versions released after the Node.js Current release.
Refer to the Quick Start Guide for the officially supported Node.js versions for a given ESLint release.
Open a discussion or stop by our Discord server.
Lock files like package-lock.json are helpful for deployed applications. They ensure that dependencies are consistent between environments and across deployments.
Packages like eslint that get published to the npm registry do not include lock files. npm install eslint as a user will respect version constraints in ESLint's package.json. ESLint and its dependencies will be included in the user's lock file if one exists, but ESLint's own lock file would not be used.
We intentionally don't lock dependency versions so that we have the latest compatible dependency versions in development and CI that our users get when installing ESLint in a project.
The Twilio blog has a deeper dive to learn more.
We have scheduled releases every two weeks on Friday or Saturday. You can follow a release issue for updates about the scheduling of any particular release.
ESLint takes security seriously. We work hard to ensure that ESLint is safe for everyone and that security issues are addressed quickly and responsibly. Read the full security policy.
ESLint follows semantic versioning. However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint:
eslint:recommended is updated and will result in strictly fewer linting errors (e.g., rule removals).eslint:recommended is updated and may result in new linting errors (e.g., rule additions, most rule option updates).According to our policy, any minor update may report more linting errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (~) in package.json e.g. "eslint": "~3.1.0" to guarantee the results of your builds.
Since ESLint is a CommonJS package, there are restrictions on which ESM-only packages can be used as dependencies.
Packages that are controlled by the ESLint team and have no external dependencies can be safely loaded synchronously using require(esm) and therefore used in any contexts.
For external packages, we don't use require(esm) because a package could add a top-level await and thus break ESLint. We can use an external ESM-only package only in case it is needed only in asynchronous code, in which case it can be loaded using dynamic import().
These policies don't apply to packages intended for our own usage only, such as eslint-config-eslint.
MIT License
Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
These folks keep the project moving and are resources for help.
The people who manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained.
![]() Nicholas C. Zakas |
![]() Francesco Trotta |
![]() Milos Djermanovic |
The people who review and implement new features.
![]() 唯然 |
![]() Nitin Kumar |
The people who review and fix bugs and help triage issues.
![]() fnx |
![]() Josh Goldberg ✨ |
![]() Sweta Tanwar |
![]() Tanuj Kanti |
![]() lumir |
Pixel998 |
Team members who focus specifically on eslint.org
![]() Amaresh S M |
![]() Harish |
![]() Percy Ma |
The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. Become a Sponsor to get your logo on our READMEs and website.