Skip to content

pengzhanbo/configs

Repository files navigation

@pengzhanbo/configs

一个给自己用的 eslint 、 stylelint 、 prettier 配置库。

用于个人开发的项目中。

eslint 预设配置

Breaking Changes

  • v1.0.0 开始, 完全迁移至 ESLint Flat config, 即只支持 eslint.config.js 配置文件。
  • 抛弃了过去的所有配置进行重写。从 1.0.0 开始,fork 自 @antfu/eslint-config, 并在其基础上进行了重写,通过 preset 的方式来实现对通用场景、不同库/框架(vue/react/solid-js/svelte等)的支持。 与之不同的是,@antfu/eslint-config 内置了包括 vue/react以及通用配置,通过 cli 和依赖检查来启用对 vue/react 的支持;而本仓库则是根据项目场景,直接安装对应的包。

stylelint 预设配置

  • css
  • scss

Usage

Javascript / Typescript 项目

适用于 通用的 JavaScript/TypeScript 项目。

Install

pnpm add -D eslint @pengzhanbo/eslint-config

Config

eslint.config.js

import eslintConfig from '@pengzhanbo/eslint-config'

export default eslintConfig()

Vue项目

适用于 Vue 项目。

Install

pnpm add -D eslint @pengzhanbo/eslint-config-vue

Config

.eslint.config.js

import eslintConfig from '@pengzhanbo/eslint-config-vue'

export default eslintConfig()

React项目

适用于 React 项目。

Install

pnpm add -D eslint @pengzhanbo/eslint-config-react

Config

eslint.config.js

import eslintConfig from '@pengzhanbo/eslint-config-react'

export default eslintConfig()

Solid-js 项目

适用于 大多数的 Solid 项目。

Install

pnpm add -D eslint @pengzhanbo/eslint-config-solid

Config

eslint.config.js

import eslintConfig from '@pengzhanbo/eslint-config-solid'

export default eslintConfig()

Prettier

‼️ Deprecated。从 v1.0.0 开始,移除了 eslint-config-prettier ,即安装了 eslint 相关的配置依赖, 则不需要再使用 prettier 了。

除非是不想使用 eslint ,只想使用 prettier

Install

pnpm add -D eslint @pengzhanbo/prettier-config

Config

package.json

{
  "prettier": "@pengzhanbo/prettier-config"
}

stylelint

适用于 css / scss 场景,且适配了 TailwindCSS 的自定义 at-rule。

Install

pnpm add -D eslint @pengzhanbo/stylelint-config

In .stylelintrc.json

{
  "extends": "@pengzhanbo/stylelint-config"
}

Thanks

About

Config preset for eslint, prettier, stylelint

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages