README.md

AurityLab Code Styles

A collection of ESLint configs for JavaScript, TypeScript and Vue. This configs mostly use Standard, but with some custom flavour on top.

As each config requires different plugins and parsers they are listed as optionalDependencies.

Available configs

• JavaScript
• TypeScript
• Vue (with JavaScript and TypeScript)

JavaScript

This config currently fully inherits from eslint-config-stanard.

Install

$ yarn add -D @auritylab/eslint-config eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard

ESLint config

{
  "extends": [
    "@auritylab/eslint-config/rules/javascript"
  ]
}

TypeScript

This config currently fully inherits from eslint-config-standard-with-typescript.

Install

$ yarn add -D @auritylab/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard

ESLint config

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "extends": [
    "@auritylab/eslint-config/rules/typescript"
  ]
}

Vue

This config inherits from eslint-plugin-vue/recommended with some flavour on top. This config can be used in conjunction with JavaScript or TypeScript.

Install

$ yarn add -D @auritylab/eslint-config eslint-plugin-vue

ESLint config

{
  "parser": "vue-eslint-parser",
  "extends": [
    "@auritylab/eslint-config/rules/vue"
  ]
}

ESLint config with TypeScript

This requires the TypeScript config to be installed!

{
  "parser": "vue-eslint-parser",
  "parserOptions": {
    "parser": "@typescript-eslint/parser"
  },
  "extends": [
    "@auritylab/eslint-config/rules/vue",
    "@auritylab/eslint-config/rules/typescript"
  ]
}