📦 Installation

# npm
npm install @uiron/lint-config -D

# pnpm
pnpm add @uiron/lint-config -D

🛠️ Setup

Commitlint Setup

1. Install dependencies:

pnpm add commitlint @commitlint/cli -D

2. Create commitlint.config.cjs:

const { commitlintConfig } = require('@uiron/lint-config');

module.exports = commitlintConfig();

ESLint Setup

1. Install dependencies:

pnpm add eslint @antfu/eslint-config eslint-plugin-format -D

2. Create eslint.config.mjs:

import process from 'node:process';
import antfu from '@antfu/eslint-config';
import { eslintConfig } from '@uiron/lint-config';
const dev = process.env?.NODE_ENV;
export default antfu({
  ...eslintConfig(),
  ...{
    rule: {
      'no-console': dev === 'production' ? 'warn' : 'off',
      'no-debugger': dev === 'production' ? 'warn' : 'off',
    },
  },
});

Prettier Setup

1. Install dependencies:

pnpm add prettier -D

2. Create prettier.config.cjs:

const { prettierConfig } = require('@uiron/lint-config');

module.exports = prettierConfig();

📝 VS Code Settings

Add the following to your settings.json:

{
  "prettier.enable": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  },
  "editor.formatOnSave": true,
  "eslint.runtime": "node",
  "npm.packageManager": "pnpm",
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "vue",
    "html",
    "markdown",
    "json",
    "jsonc",
    "yaml",
    "toml",
    "xml",
    "gql",
    "graphql",
    "astro",
    "svelte",
    "css",
    "less",
    "scss",
    "pcss",
    "postcss"
  ]
}

📝 Recommend

dependencies

pnpm add  husky lint-staged -D

package.json

{
    "scripts": {
    "lint:fix": "eslint --fix --ext .js,.ts,.vue,.jsx,.tsx,.json,.md src/",
    "lint": "eslint --ext .js,.ts,.vue src/",
    "prettier": "prettier --write src",
    "beautify": "pnpm run lint:fix && \\ pnpm run prettier"
    },
     "lint-staged": {
      "*.{js,ts,vue,jsx,tsx,json,css,scss,less,mjs,md}": [
      "eslint --fix --ext .js,.ts,.vue,.jsx,.tsx,.json,.md",
      "prettier --write"
    ]
  }
}

commit-msg

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm  commitlint --config commitlint.config.cjs --edit "${1}"

pre-commit

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx  lint-staged 

📄 License

MIT LICENSE