简介
eslint-config-maptalks 是 Maptalks 公司开发的一个 npm 包，提供了 Maptalks 前端团队内部使用的 eslint 配置规则，以及配合编辑器插件格式化代码的规则。
使用该包，可以保证代码风格的一致性，减少代码 bug 的发生概率。
安装
你可以通过 npm 在你的项目中进行安装：
npm install eslint-config-maptalks --save-dev
同时，我们默认你已经在项目中安装了 eslint，如果没有，请通过下面命令进行安装：
npm install eslint --save-dev
配置
在项目中配置 eslint，首先需要在项目根目录下添加 .eslintrc.js 文件：
module.exports = {
extends: [
'eslint-config-maptalks',
],
};之后，在你的项目的 package.json 文件中加入 eslint 的检测命令：
{
"scripts": {
"lint": "eslint 'src/**/*.{js,jsx}'"
}
}这样你就可以通过在终端中执行 npm run lint 来检测你的项目中，所有 js 和 jsx 文件是否符合规则了。
使用
我们提供了 eslint-config-maptalks 的基本规则以及特定的项目规则，你可以通过继承它们来使 eslint 的检测在项目中更加合理。
JavaScript 项目
如果你的项目使用的是纯 JavaScript 语言，你可以在你的项目根目录下的 .eslintrc.js 文件中加入以下配置来使 eslint 检测你的 JavaScript 代码：
module.exports = {
extends: [
'eslint-config-maptalks',
'eslint-config-maptalks/javascript',
],
};React 项目
如果你的项目使用的是 React 框架，你可以在你的项目根目录下的 .eslintrc.js 文件中加入以下配置来使 eslint 检测你的 React 代码：
module.exports = {
extends: [
'eslint-config-maptalks',
'eslint-config-maptalks/javascript',
'eslint-config-maptalks/react',
],
};Vue 项目
如果你的项目使用的是 Vue 框架，你可以在你的项目根目录下的 .eslintrc.js 文件中加入以下配置来使 eslint 检测你的 Vue 代码：
module.exports = {
extends: [
'eslint-config-maptalks',
'eslint-config-maptalks/javascript',
'eslint-config-maptalks/vue',
],
};TypeScript 项目
如果你的项目使用的是 TypeScript 语言，你可以在你的项目根目录下的 .eslintrc.js 文件中加入以下配置来使 eslint 检测你的 TypeScript 代码：
-- -------------------- ---- -------
-------------- - -
-------- -
-------------------------
------------------------------------
------------------------------------
--
-------------- -
------- ----------------------------
--
--结语
通过使用 eslint-config-maptalks，可以让我们的团队内部开发时遵循相同的 eslint 规则，代码风格更加一致，减少代码出错的情况出现。
同时，eslint-config-maptalks 也提供了一些特定项目的 eslint 规则，通过这些规则，我们可以更加合理地追求项目的代码质量。
示例代码：GitHub 仓库
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f685d876099112f39633444