chiefmikey/mikey-pro

Lint and format style guide

Mikey Pro

Style Guide

Lint and Format Code (the way Mikey likes it)

A curated compilation of packages, plugins, style guides, custom configurations
and modified rules for consistently writing top shelf code

Compatibility

Languages	Frameworks
JavaScript TypeScript HTML CSS SCSS LESS Markdown YAML JSON JSONC JSON5	React Svelte Vue Jest Cypress

Requirements

Install extensions: ESLint | Prettier | Stylelint

Additional support: ShellCheck

Usage

Install

npm i -D mikey-pro

Configuration

Add bundled configs to package.json

{
  "prettier": "@mikey-pro/prettier-config",
  "eslintConfig": {
    "extends": "@mikey-pro/eslint-config"
  },
  "stylelint": {
    "extends": "@mikey-pro/stylelint-config"
  }
}

Frameworks

Each framework configuration extends the base @mikey-pro/eslint-config

React

npm i -D mikey-pro @mikey-pro/eslint-config-react

{
  "eslintConfig": {
    "extends": "@mikey-pro/eslint-config-react"
  }
}

Svelte

npm i -D mikey-pro @mikey-pro/eslint-config-svelte

{
  "eslintConfig": {
    "extends": "@mikey-pro/eslint-config-svelte"
  }
}

Svelte Extension

Vue

npm i -D mikey-pro @mikey-pro/eslint-config-vue

{
  "eslintConfig": {
    "extends": "@mikey-pro/eslint-config-vue"
  }
}

Vue Extension