DocsToolsPrettier & eslint

đź‘Ś How to - @kitql/eslint-config

đź’ˇ

KitQL itself is not a library, it’s “nothing” but a collection of standalone libraries.

To have eslint & prettier in your project, you need 20 dep, files, … and it’s a pain to maintain in each project.

Here the idea is to reduce as much as possible the config on your end. (Of course, you can still tune things)

Installation

npm i -D @kitql/eslint-config

eslint config

eslint.config.js
import kitql from '@kitql/eslint-config'
 
/** @type { import("eslint").Linter.Config } */
export default [
  ...kitql,
  {
    name: 'app:rules',
    rules: {
      // Some custom things?
    }
  }
]

You can check your config running this tool

npx @eslint/config-inspector

prettier config

.prettierrc.cjs
const config = require('@kitql/eslint-config/.prettierrc.cjs')
 
module.exports = {
  ...config
  // Some custom things?
}

ignore things with

.prettierignore
.DS_Store
node_modules
/build
/.svelte-kit
/package
.env
.env.*
!.env.example
 
# Ignore files for PNPM, NPM and YARN
package.json
pnpm-lock.yaml
package-lock.json
yarn.lock
 
# Ignore files that are project specific
/db
/src/lib/ROUTES.ts

Add this to your package.json

package.json
scripts: {
  "//// ---- BEST PRACTICES ---- ////": "",
  "format": "kitql-lint -f",
  "lint": "kitql-lint",
}
HelpersVite - Kit Routes