Giter Club home page Giter Club logo

eslint-config's Introduction

@cany748/eslint-config

ESLint config for JavaScript, TypeScript, Vue 2/3.

Based on Anthony Fu configs.

Usage

Install

pnpm add -D @cany748/eslint-config
# Or yarn add -D / npm install -D / bun add -D

Config

// eslint.config.ts
{
  import { factoryConfig } from "@cany748/eslint-config";

  export default factoryConfig({
    // Type of the project. 'lib' for libraries, the default is 'app'
    type: "lib",

    // TypeScript, Vue and UnoCSS are autodetected, you can also explicitly enable them:
    typescript: true,
    vue: true,
    unocss: true,

    // to enable type-aware rules use
    typescript: { tsconfigPath: "./tsconfig.json", filesTypeAware: ["**/*.{ts,tsx,vue}"] },
  });
}
// `.prettierrc` or `prettier` on `package.json`
{
  "printWidth": 140
}

Add script for package.json

For example:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Lint Staged

If you want to apply lint and auto-fix before every commit, you can add the following to your package.json:

{
  "simple-git-hooks": {
    "pre-commit": "pnpm lint-staged"
  },
  "lint-staged": {
    "*": "eslint --fix"
  }
}

and then

pnpm add -D lint-staged simple-git-hooks

View what rules are enabled

Go to your project root that contains eslint.config.* and run:

npx @eslint/config-inspector

eslint-config's People

Contributors

cany748 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.