@ignit/style-guide

Shareable style guide with ESLint, Prettier, Stylelint, and CSpell configurations.

Installation

npm install -D @ignit/style-guide eslint prettier stylelint cspell

ESLint

Create eslint.config.js:

import { customDefineConfig, core, typescript } from '@ignit/style-guide/eslint'

export default customDefineConfig({
    configs: [core(), typescript()],
    ignores: ['dist', 'build'],
})

Available Configs

• core() - Essential rules for all JavaScript/TypeScript projects
• typescript() - TypeScript parser and rules
• react() - React framework rules
• next() - Next.js framework
• vue() - Vue.js framework
• node() - Node.js specific rules
• jest() - Jest testing framework
• vitest() - Vitest testing framework
• playwright() - Playwright e2e testing
• tanstackQuery() - TanStack Query
• turbo() - Turborepo

Customizing Configs

Each factory function accepts a config parameter to extend or override settings:

import { customDefineConfig, core, typescript } from '@ignit/style-guide/eslint'

export default customDefineConfig({
    configs: [
        core(),
        typescript({
            rules: {
                '@typescript-eslint/no-unused-vars': 'warn',
            },
        }),
    ],
    ignores: ['dist'],
})

Prettier

Create prettier.config.ts:

import type { Config } from 'prettier'

import { core } from '@ignit/style-guide/prettier'

const config: Config = {
    ...core,
}

export default config

Stylelint

Create stylelint.config.js:

import { core } from '@ignit/style-guide/stylelint'

/** @type {import("stylelint").Config} */
const config = {
    ...core,
}

export default config

CSpell

Create cspell.config.js:

import { core } from '@ignit/style-guide/cspell'

/** @type {import("cspell").FileSettings} */
const config = {
    ...core,
    ignorePaths: [...core.ignorePaths],
    ignoreWords: [],
}

export default config

Scripts

Add to your package.json:

{
    "scripts": {
        "lint": "npm run lint:eslint && npm run lint:prettier && npm run lint:stylelint && npm run lint:cspell",
        "lint:eslint": "eslint",
        "lint:prettier": "prettier --check .",
        "lint:stylelint": "stylelint ./**/*.css --cache",
        "lint:cspell": "cspell --no-progress --no-summary --unique '**'",
        "lint:fix": "npm run lint:eslint -- --fix && npm run lint:prettier -- --write && npm run lint:stylelint -- --fix"
    }
}

License

MIT