Giter Club home page Giter Club logo

eslint-config's Introduction

@coderwyd/eslint-config

release status npm downloads

Feature

  • ๐Ÿ› ๏ธ Auto fix for formatting
  • โœจ Support Vue, React, Svelte.
  • ๐ŸŽฏ Designed to work with TypeScript, Vue out-of-box
  • ๐Ÿ† Reasonable defaults, best practices, only one-line of config
  • ๐ŸŽจ Use ESlint to format HTML, CSS, LESS, SCSS, YAML, TOML, Markdown, JSON, JSONC.

Usage

Install

pnpm i -D eslint @coderwyd/eslint-config

Create config file

With "type": "module" in package.json (recommended):

// eslint.config.js
import { defineConfig } from '@coderwyd/eslint-config'

export default defineConfig()

With CJS:

// eslint.config.js
const { defineConfig } = require('@coderwyd/eslint-config')

module.exports = defineConfig()

Add script for package.json

For example:

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

VS Code support (auto fix)

Add the following settings to your .vscode/settings.json:

{
  // Enable the ESlint flat config support
  "eslint.experimental.useFlatConfig": true,

  // Disable the default formatter, use eslint instead
  "prettier.enable": false,
  "editor.formatOnSave": false,

  // Auto fix
  "editor.codeActionsOnSave": {
    "source.fixAll": "explicit",
    "source.organizeImports": "never"
  },

  // Silent the stylistic rules in you IDE, but still auto fix them
  "eslint.rules.customizations": [
    { "rule": "style/*", "severity": "off" },
    { "rule": "format/*", "severity": "off" },
    { "rule": "*-indent", "severity": "off" },
    { "rule": "*-spacing", "severity": "off" },
    { "rule": "*-spaces", "severity": "off" },
    { "rule": "*-order", "severity": "off" },
    { "rule": "*-dangle", "severity": "off" },
    { "rule": "*-newline", "severity": "off" },
    { "rule": "*quotes", "severity": "off" },
    { "rule": "*semi", "severity": "off" }
  ],

  // Enable eslint for all supported languages
  "eslint.validate": [
    "html",
    "css",
    "less",
    "scss",
    "json",
    "jsonc",
    "yaml",
    "yml",
    "markdown",
    "toml"
  ]
}

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

npm i -D lint-staged simple-git-hooks

Options

interface Options

interface OptionsConfig extends OptionsComponentExts {
  /**
   * The current working directory
   *
   * @default process.cwd()
   */
  cwd?: string

  /**
   * Enable gitignore support.
   *
   * Passing an object to configure the options.
   *
   * @see https://github.com/antfu/eslint-config-flat-gitignore
   * @default true
   */
  gitignore?: boolean | FlatGitignoreOptions

  /**
   * Core rules. Can't be disabled.
   */
  javascript?: OptionsOverrides

  /**
   * Enable TypeScript support.
   *
   * Passing an object to enable TypeScript Language Server support.
   *
   * @default auto-detect based on the dependencies
   */
  typescript?: boolean | OptionsTypescript

  /**
   * Enable JSX related rules.
   *
   * Currently only stylistic rules are included.
   *
   * @default true
   */
  jsx?: boolean

  /**
   * Enable test support.
   *
   * @default true
   */
  test?: boolean | OptionsOverrides

  /**
   * Enable Vue support.
   *
   * @default auto-detect based on the dependencies
   */
  vue?: boolean | OptionsVue

  /**
   * Enable JSONC support.
   *
   * @default true
   */
  jsonc?: boolean | OptionsOverrides

  /**
   * Enable react rules.
   *
   * Requires installing:
   * - `@eslint-react/eslint-plugin`
   * - `eslint-plugin-react-hooks`
   * - `eslint-plugin-react-refresh`
   *
   * @default false
   */
  react?: boolean | OptionsOverrides

  /**
   * Enable svelte rules.
   *
   * Requires installing:
   * - `eslint-plugin-svelte`
   *
   * @default false
   */
  svelte?: boolean | OptionsOverrides

  /**
   * Enable tainwindcss rules.
   *
   * @default auto-detect based on the dependencies
   */
  tailwindcss?: boolean | OptionsOverrides

  /**
   * Enable unocss rules.
   *
   * Requires installing:
   * - `@unocss/eslint-plugin`
   *
   * @default false
   */
  unocss?: boolean | OptionsUnoCSS

  /**
   * Enable stylistic rules.
   *
   * @see https://eslint.style/
   * @default true
   */
  stylistic?: boolean | (StylisticConfig & OptionsOverrides)

  /**
   * Enable regexp rules.
   *
   * @see https://ota-meshi.github.io/eslint-plugin-regexp/
   * @default true
   */
  regexp?: boolean | (OptionsRegExp & OptionsOverrides)

  /**
   * Use external formatters to format files.
   *
   * @default
   * {
   *  "html": true,
   *  "css": true,
   *  "graphql": false,
   *  "markdown": false
   *  "yaml": false
   *  "toml": false
   * }
   *
   * When set to `true`, it will enable all formatters.
   */
  formatter?: boolean | OptionsFormatters

  /**
   * Control to disable some rules in editors.
   * @default auto-detect based on the process.env
   */
  isInEditor?: boolean

  /**
   * Automatically rename plugins in the config.
   *
   * @default true
   */
  autoRenamePlugins?: boolean
}

Thanks

This project is based on @antfu/eslint-config

License

MIT License ยฉ 2023-PRESENT Donny Wang

eslint-config's People

Contributors

coderwyd avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar

eslint-config's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (:automergeEarlyMondays). Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): lock file maintenance

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

  • chore(deps): update all non-major dependencies (@types/node, eslint-plugin-jest, eslint-plugin-jsdoc, eslint-plugin-n, eslint-plugin-yml, pnpm)
  • fix(deps): update typescript-eslint monorepo to ^6.7.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser, @typescript-eslint/rule-tester, @typescript-eslint/utils)

Detected dependencies

github-actions
.github/workflows/release.yml
  • actions/checkout v4
  • actions/setup-node v3
npm
package.json
  • bumpp ^9.2.0
  • eslint ^8.49.0
  • rimraf ^5.0.1
  • taze ^0.11.2
  • typescript ^5.2.2
  • pnpm 8.7.4
packages/eslint-config-basic/package.json
  • eslint-define-config ^1.23.0
  • eslint-plugin-eslint-comments ^3.2.0
  • eslint-plugin-html ^7.1.0
  • eslint-plugin-import 2.28.1
  • eslint-plugin-jsdoc ^46.8.0
  • eslint-plugin-jsonc ^2.9.0
  • eslint-plugin-markdown ^3.0.1
  • eslint-plugin-n ^16.0.2
  • eslint-plugin-no-only-tests ^3.1.0
  • eslint-plugin-promise ^6.1.1
  • eslint-plugin-unicorn ^48.0.1
  • eslint-plugin-unused-imports ^3.0.0
  • eslint-plugin-yml ^1.8.0
  • jsonc-eslint-parser ^2.3.0
  • yaml-eslint-parser ^1.2.2
  • eslint ^8.49.0
  • eslint >=7.4.0
packages/eslint-config-react/package.json
  • eslint-define-config ^1.23.0
  • eslint-plugin-react ^7.33.2
  • eslint-plugin-react-hooks ^4.6.0
  • eslint ^8.49.0
  • react ^18.2.0
  • typescript ^5.2.2
  • eslint >=7.4.0
packages/eslint-config-ts/package.json
  • @typescript-eslint/eslint-plugin ^6.6.0
  • @typescript-eslint/parser ^6.6.0
  • eslint-define-config ^1.23.0
  • eslint-plugin-jest ^27.2.3
  • typescript ^5.2.2
  • eslint ^8.49.0
  • eslint >=7.4.0
  • typescript >=3.9
packages/eslint-config-vue/package.json
  • eslint-define-config ^1.23.0
  • eslint-plugin-vue ^9.17.0
  • local-pkg ^0.4.3
  • eslint ^8.49.0
  • eslint >=7.4.0
packages/eslint-config/package.json
  • eslint ^8.49.0
  • eslint >=7.4.0
packages/eslint-plugin-coderwyd/package.json
  • @typescript-eslint/utils ^6.6.0
  • @types/node ^20.6.0
  • @typescript-eslint/rule-tester ^6.6.0
  • unbuild ^2.0.0
  • vitest ^0.34.4

  • Check this box to trigger a request for Renovate to run again on this repository

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.