readme.md

@t99/eslint-config

A repository for keeping track of all of my ESLint configuration files.

Find @t99/eslint-config on NPM.

Table of Contents

• Installation
• License

Installation

Install from NPM with

$ npm install --save-dev @t99/eslint-config

Then, add it to your local ESLint config:

For JS/CJS Configs (.eslintrc.js/.eslintrc.cjs):

module.exports = {
    extends: [
        "@t99"
    ]
}

For JSON Configs (.eslintrc.json):

{
    "extends": [
        "@t99"
    ]
}

For YAML/YML Configs (.eslintrc.yaml/.eslintrc.yml):

extends:
    @t99

TypeScript Installation

Additionally, for TypeScript projects, you will need to configure the path to your project's tsconfig.json. Extending this package will take care of all other necessary setup for usage with TypeScript.

For JS/CJS Configs (.eslintrc.js/.eslintrc.cjs):

module.exports = {
    extends: [
        "@t99"
    ],
    parserOptions: {
        project: "path/to/tsconfig.json"
    }
}

For JSON Configs (.eslintrc.json):

{
    "extends": [
        "@t99"
    ],
    "parserOptions": {
        "project": "path/to/tsconfig.json"
    }
}

For YAML/YML Configs (.eslintrc.yaml/.eslintrc.yml):

extends:
    @t99
parserOptions:
    project: "path/to/tsconfig.json"

Building Your Own Shareable ESLint Config Repo/Package

Check out the official ESLint guide on doing so here.

License

@t99/eslint-config is made available under the GNU General Public License v3.

Copyright (C) 2022 Trevor Sears