npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-config-ykplus

v1.0.1

Published

ESLint Shareable Config for YkPlus FE Guidelines

Downloads

3

Readme

eslint-config-ykplus

本包是《移卡前端规范》配套的 ESLint 可共享配置,提供了多套配置文件以支持 JavaScript、Vue 等多种项目类型。

使用

JavaScript 项目 - eslint-config-ykplus

针对未使用 Vue 的原生 JavaScript 项目,使用 ESLint 原生规则和 eslint-plugin-import 规则,使用 @babel/eslint-parser 作为 parser,是本包的默认配置。

依赖

安装

npm i -D eslint-config-ykplus @babel/core @babel/eslint-parser eslint-plugin-import

配置

{
  "extends": ["eslint-config-ykplus"]
}

JavaScript + Vue 项目 - eslint-config-ykplus/vue

针对 JS Vue 的项目,继承了默认配置,并启用了 eslint-plugin-vue 插件的规则,使用 vue-eslint-parser 作为 parser。

依赖

安装

npm i -D eslint-config-ykplus @babel/core @babel/eslint-parser eslint-plugin-import vue-eslint-parser eslint-plugin-vue

配置

{
  "extends": ["eslint-config-ykplus/vue"]
}

JavaScript + React 项目 - eslint-config-ykplus/react

针对 JS React 项目,继承了默认配置,并启用了 eslint-plugin-reacteslint-plugin-react-hooks 的规则。

依赖

安装

npm i -D eslint-config-ykplus @babel/core @babel/eslint-parser @babel/preset-react eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks

配置

{
  "extends": ["eslint-config-ykplus/react"]
}

Node.js 项目 - eslint-config-ykplus/node

针对 Node.js 项目,继承了默认配置和 egg-config-egg 的 node 规则,规则由 ESLint 原生规则和 eslint-plugin-node 提供。

依赖

安装

npm i -D eslint-config-ykplus @babel/core @babel/eslint-parser eslint-plugin-import eslint-config-egg

配置

{
  "extends": ["eslint-config-ykplus/node"]
}

TypeScript 项目 - eslint-config-ykplus/typescript

针对未使用 React 或 Vue 的 TypeScript 项目,继承了默认配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

依赖

安装

npm i -D eslint-config-ykplus @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript

配置

{
  "extends": ["eslint-config-ykplus/typescript"]
}

需保证项目已安装 typescript 依赖,另外如果项目的 TS 配置文件不是 ./tsconfig.json,则需要设置 .eslintrc 中的 parserOptions.project 字段 ,例如:

{
  "extends": "eslint-config-ykplus/typescript",
  "parserOptions": {
    "project": "./tsconfig.eslint.json"
  }
}

TypeScript + Vue 项目 - eslint-config-ykplus/typescript/vue

针对 TS Vue 项目,继承了 JS Vue 的配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

依赖

安装

npm i -D eslint-config-ykplus @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript vue-eslint-parser eslint-plugin-vue

配置

{
  "extends": ["eslint-config-ykplus/typescript/vue"]
}

TypeScript + React 项目 - eslint-config-ykplus/typescript/react

针对 TS React 项目,继承了 JS React 的配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

依赖

安装

npm i -D eslint-config-ykplus @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript eslint-plugin-react eslint-plugin-react-hooks

配置

{
  "extends": ["eslint-config-ykplus/typescript/react"]
}

TypeScript + Node.js 项目 - eslint-config-ykplus/typescript/node

针对未使用 React 和 Vue 的 TypeScript(Node) 项目,继承了 JS Node.js 配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

依赖

安装

npm i -D eslint-config-ykplus @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript eslint-config-egg

配置

{
  "extends": ["eslint-config-ykplus/typescript/node"]
}

配合 Prettier 使用

如果你的项目使用 Prettier 进行代码格式化,本包的一些规则可能会跟 Prettier 格式化结果有冲突。为了避免冲突,你需要手动安装 eslint-config-prettiereslint-plugin-prettier

安装

npm install --save-dev eslint-config-prettier eslint-plugin-prettier

配置

并修改 .eslintrcextends 配置,增加 prettier,如下(以 Vue 项目为例):

{
  "extends": ["eslint-config-ykplus/vue", "prettier"]
}

了解更多请阅读 Prettier - Integrating with Linters

了解更多

  • 如果你对 ESLint 还不熟悉,可以阅读官网的 Getting Started 快速入门。
  • 了解如何为 IDE 配置 ESLint,可以参考官网的 Integrations
  • 了解如何在继承本包的基础上对项目 ESLint 进行个性化配置,可参考官网的 Configuring ESLint。下面简介下 ESLint 配置中的几个常用字段:
    • extends: 继承一组规则集。"extends": "eslint-config-ykplus", 表示继承本包定义的规则配置。
    • rules: 配置规则,这里定义的规则会覆盖 extends 的规则。如果觉得本包开启的某条规则过于严格,你可以暂时在这里将其关闭。
    • parser: 设置 ESLint 的解析器。ESLint 使用 espree 作为默认的解析器,可以通过这个参数指定其他的解析器。比如指定为 @babel/eslint-parser,以解析 Babel 支持但 ESLint 默认解析器不支持的语法(本包不同配置文件使用的解析器可在简介表格中的「依赖 parser」一列查看)。
    • globals: 指定代码中可能用到的全局变量,以免全局变量被 no-undef 规则报错。
    • env: 指定代码的运行环境,每个环境预定义了一组对应的全局变量,本包已开启的环境有 browser、node、jquery、es6 及几个测试框架的环境。
  • 了解常用的 ESLint 命令,如 --fix--ext,可参考官网的 Command Line Interface

其他

  • rules/base 里面的规则是对齐 这里