1.0.0-alpha.2 • Published 11 months ago

@coinstore/eslint-config v1.0.0-alpha.2

Weekly downloads
-
License
MIT
Repository
-
Last release
11 months ago

Eslint-config

Coinstore's Eslint config.

Installation

npm install @coinstore/eslint-config -D

Usage

介绍

ES-modules

包含的文件:"/*.js", "/.cjs","**/.mjs"(所有的 .js / .cjs / .mjs 文件)

全局变量

禁止的全局变量:

  • __dirname
  • __filename

在 Node 中有两个常见的变量:__dirname___filename,但是仅仅是在 CommonJS 规范中才能使用,ES modules 中是无法使用的。

rules 按照顺序依次为:

  • Eslint 推荐的 rules
  • __filename / __dirname / require / module / exports 等 CommonJS 中用到的全局变量,而在ES modules中不存在的全局变量,进行限制
  • 通过 PrettierConfigRules 禁止 Eslint 中的样式 rules

TypeScript

包含的文件:"/*.ts", "/_.tsx"(所有的 .ts / .tsx 文件)

使用

需要传入两个参数:

  • project - 项目的根目录
  • tsconfigRootDir - TypeScript 配置文件的相对路径(相对项目的根目录)

languageOptions

  • sourceType - module
  • ecmaVersion - latest

rules 按照顺序依次为:

React

包含的文件:"/*.ts", "/_.tsx"(所有的 .ts / .tsx 文件)

Storybook

Jest

包含的文件:/__tests__//*.test.jts?(x)