Eslint-config-alsacreations NPM

Ce repo contient le paquet npm correspondant à la configuration ESLint de l'agence Alsacréations.

Ce qui est inclus

🤝 Configurations communes à plusieurs technologies

Règles communes à JavaScript et Vue/Nuxt

⚙️ Configuration JavaScript

Utilisation des règles ESLint de base (sans plugin)

💪 Configuration TypeScript

Utilisation du plugin @typescript-eslint.
Utilisation du parser @typescript-eslint/parser.

😎 Configuration Vue 3

Utilisation du plugin eslint-plugin-vue
Utilisation du parser vue-eslint-parser (ne rentre pas en conflit avec TypeScript)

💚 Configuration Nuxt

Utilisation du plugin @nuxtjs/eslint-plugin

🚀 Configuration Prettier avec option pour Astro

Utilisation du plugin prettier-plugin-astro

Installation automatique

# npm, yarn, pnpm
# Si besoin au préalable pnpm init (pour disposer d'un fichier package.json)
npx eslint-config-alsacreations@latest init

Installation manuelle

Base

# npm, yarn, pnpm
npm i --save-dev eslint-config-alsacreations @rushstack/eslint-patch eslint

Avec TS (optionnel)

# npm, yarn, pnpm
npm i --save-dev typescript

Avec Prettier (optionnel)

# npm, yarn, pnpm
npm i --save-dev prettier eslint-config-prettier

# npm, yarn, pnpm
npm i --save-dev eslint-config-alsacreations @rushstack/eslint-patch eslint-plugin-vue eslint

Avec TS (optionnel)

# npm, yarn, pnpm
npm i --save-dev @vue/eslint-config-typescript typescript

Avec Prettier (optionnel)

# npm, yarn, pnpm
npm i --save-dev prettier @vue/eslint-config-prettier

# npm, yarn, pnpm
npm i --save-dev eslint-config-alsacreations @rushstack/eslint-patch @nuxtjs/eslint-config eslint

Avec TS (optionnel)

# npm, yarn, pnpm
npm i --save-dev @nuxtjs/eslint-config-typescript && npm uninstall @nuxtjs/eslint-config

Avec Prettier (optionnel)

# npm, yarn, pnpm
npm i --save-dev prettier @vue/eslint-config-prettier

Configuration

Puis ajouter un fichier de configuration à la racine .eslintrc.js ou équivalent.

require('@rushstack/eslint-patch/modern-module-resolution')

/* eslint-env node */
module.exports = {
  root: true,
  extends: [
    'eslint:recommended',

    'alsacreations/javascript',

    // /!\ Ne choisir que l'un ou l'autre
    'alsacreations/nuxt', // Nuxt tout seul
    'alsacreations/vue', // Vue tout seul

    // /!\ Ne choisir que l'un ou l'autre
    'alsacreations/solid', // Solid tout seul
    'alsacreations/solid-typescript', // Solid + TS

    // /!\ Ne choisir que l'un ou l'autre
    // /!\ Ne pas choisir 'alsacreations/nuxt' ni 'alsacreations/vue'
    'alsacreations/nuxt-typescript', // Nuxt + TS
    'alsacreations/vue-typescript', // Vue + TS

    // /!\ Ne pas choisir si 'alsacreations/nuxt-typescript' ou 'alsacreations/vue-typescript' sont utilisés
    'alsacreations/typescript', // TS tout seul

    // /!\ Ne choisir que l'un ou l'autre
    'alsacreations/prettier', // Prettier tout seul
    'alsacreations/prettier-vue', // Vue + Prettier
  ],
  parserOptions: {
    ecmaVersion: 'latest',
  },
}