2.2.0 • Published 2 years ago

@infotition/eslint-config v2.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

��

<p>
	<a href="http://infotition.de">
		<img src="./.github/assets/infotition_logo.png" width=600px alt="infotition logo" />
	</a>
</p>
<h1>Infotition ESLint Config</h1>
<p>This is the official eslint config which is used by the infotition team.</p>

Table of Contents

Installation

  1. Setup a basic typescript project:

    Install typescript and basic node types:

    yarn init
    yarn add -D @tsconfig/node16 @types/node typescript

    Create a tsconfig.json file at project root with the following content:

    {
      "extends": "@tsconfig/node16/tsconfig.json",
      "exclude": ["node_modules"]
    }
  1. Install the infotition eslint config package:

    yarn add -D @infotition/eslint-config
  2. Create a Prettier config as described here.

  3. Create a .eslintrc.js file at project root with the following content:

    For a plain node project:

    module.exports = {
      extends: ['@infotition/eslint-config'],
      env: {
        node: true,
      },
    };

    or for a Next.js project:

    module.exports = {
      extends: ['@infotition/eslint-config/next'],
    };

Development

If you want to develop in this repository, clone it and change the directory of your terminal to the downloaded repository.

$ git clone https://github.com/Infotition/eslint-config-infotition.git
$ cd eslint-config-infotition

Now you can install all development and production dependencies.

$ yarn install

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. For other related questions/support please use the official Infotition Discord server.

Contribution

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

License

This repo is covered under the MIT License, see the LICENSE file for more information.