@amedia/eslint-config-typescript

@amedia/eslint-config-typescript

Common ESLint/Prettier configuration for TypeScript Extends (https://www.npmjs.com/package/eslint-config-airbnb-typescript)[Airbnb's typescript configuration].

Install

To test this package :

Install the package with (change the version to the version in package.json)

NPM

With npm 5+

This is a cool tool that installs all dependencies you need in peerDependencies to get going.

npx install-peerdeps --dev @amedia/eslint-config-typescript

OR

If you want a prefer manual approach then install the correct versions of each peerDependency package, which are listed by the command:

npm info "@amedia/eslint-config-typescript" peerDependencies
npm install --save-dev @amedia/eslint-config-typescript

yarn

yarn add  @amedia/eslint-config-typescript -D

Install the correct versions of each peerDependency package, which are listed by the command:

npm info "@amedia/eslint-config-typescript" peerDependencies

Usage

There are a few ways to include the eslint config in your project.

Make sure you dont have any other settings for eslint or prettier already in your editor workspace or global.

Restart your editor if you dont see it working immediately (known issue for VS Code)

Select one of the options below:

Using package.json:

{
  "eslintConfig": {
    "extends": "@amedia/eslint-config-typescript"
  }
}

Using .eslintrc:

{
  "extends": "@amedia/eslint-config-typescript"
}

or .eslintrc.js:

module.exports = {
  extends: '@amedia/eslint-config-typescript',
};

You also need to set ut .prettierrc and tsconfig.json.

Prettier

This is how you use or extend the @amedia/eslint-config-base prettier config in your app. Select on of the following:

Add a line to the package.json file.

{
  "prettier": "@amedia/eslint-config-base/prettier.config"
}

Creating a file named .prettierrc.

"@amedia/eslint-config-base/prettier.config"

Or create a file named prettier.config.js Again, remove other prettier config files locally in your project or editor.

module.exports = require('@amedia/eslint-config-base/prettier.config');

TSConfig

Create a file tsconfig.json and add the following and add:

{
  "extends": "@amedia/eslint-config-typescript/tsconfig.json",
  "compilerOptions": {
    "outDir": "./build/",
    "rootDir": "./src",
    "typeRoots": ["./node_modules/@types"]
  },
  "exclude": ["node_modules", "src/test"],
  "include": ["src/**/*"]
}