@pocketprep/config

Shared configuration for ESLint, Stylelint, TypeScript, EditorConfig, and VS Code.

Install

Add the package:

npm i -DE @pocketprep/config

Copy VS Code settings and .editorconfig into the project:

cp -r node_modules/@pocketprep/config/.vscode node_modules/@pocketprep/config/.editorconfig .

ESLint

Use defineConfig() (for Node projects) and defineConfigWithVueTs() (for Vue projects) in combination with extends.

Node

// eslint.config.ts
import { defineConfig } from 'eslint/config'
import base from '@pocketprep/config/eslint/base'

export default defineConfig({
    extends: [ base ],
    // repo-specific overrides
})

Vue

// eslint.config.ts
import { defineConfigWithVueTs } from '@vue/eslint-config-typescript'
import vue from '@pocketprep/config/eslint/vue'

export default defineConfigWithVueTs(
    {
        files: [ '**/*.{ts,vue}' ],
        extends: [ vue ],
        // repo-specific overrides
    }
)

Stylelint

// stylelint.config.mjs
export default {
    extends: [ '@pocketprep/config/stylelint/config' ],
    rules: {
        // repo-specific overrides
    },
}

TypeScript

Pick one of these two presets (Node vs. Vue):

Node

// tsconfig.json
{
    "extends": "@pocketprep/config/tsconfig/node",
    // repo-specific overrides
}

Vue

// tsconfig.json
{
    "extends": "@pocketprep/config/tsconfig/vue",
    // repo-specific overrides
}