https://github.com/tclindner/eslint-config-typescript-tc

ESLint shareable config for TypeScript projects
https://github.com/tclindner/eslint-config-typescript-tc

eslint javascript linting naming-conventions style-guide style-linter styleguide typescript

Last synced: 12 days ago
JSON representation

ESLint shareable config for TypeScript projects

• Host: GitHub
• URL: https://github.com/tclindner/eslint-config-typescript-tc
• Owner: tclindner
• License: mit
• Created: 2020-09-05T14:54:53.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T01:54:48.000Z (6 months ago)
• Last Synced: 2024-05-18T02:37:14.848Z (6 months ago)
• Topics: eslint, javascript, linting, naming-conventions, style-guide, style-linter, styleguide, typescript
• Language: JavaScript
• Homepage:
• Size: 2.55 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-typescript-tc

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for TypeScript projects

[![license](https://img.shields.io/github/license/tclindner/eslint-config-typescript-tc.svg?maxAge=2592000&style=flat-square)](https://github.com/tclindner/eslint-config-typescript-tc/blob/main/LICENSE)

[![npm](https://img.shields.io/npm/v/eslint-config-typescript-tc.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/eslint-config-typescript-tc)

![ci](https://github.com/tclindner/eslint-config-typescript-tc/workflows/ci/badge.svg?branch=main)

## What is eslint-config-typescript-tc?

Shared configuration for ESLint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file!

# How do I install it?

First thing first, let's make sure you have the necessary pre-requisites.

### System Dependencies

#### Node

* [Node.js](https://nodejs.org/) - v16.0.0+

* [npm](http://npmjs.com) - v8.0.0+

### Command

```bash

npx install-peerdeps --dev eslint-config-typescript-tc

```

> @typescript-eslint/parser and eslint-config-prettier are peer dependencies and must be installed.

**This module works best when paired with [`eslint-config-tc`](https://github.com/tclindner/eslint-config-tc). Please follow its install instructions.**

## Usage

Add the following to your `.eslintrc.js` file:

```js

module.exports = {

  extends: ['eslint-config-tc', 'eslint-config-typescript-tc'],

  parserOptions: {

    project: './tsconfig.json',

    tsconfigRootDir: __dirname,

  },

};

```

If you need to override a rule, your `.eslintrc.js` file should look like the example below. All shared rules will be used, but `@typescript-eslint/array-type` will be turned off.

```js

module.exports = {

  	extends: ['eslint-config-tc', 'eslint-config-typescript-tc'],

  	parserOptions: {

    	project: './tsconfig.json',

   	 	tsconfigRootDir: __dirname,

  	},

	"rules": {

		"@typescript-eslint/array-type": "off"

	}

};

```

## Related

- [eslint-config-tc](https://github.com/tclindner/eslint-config-tc) - ESLint shareable config for JavaScript projects

## Contributing

Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

## Change Log

Please see the [CHANGELOG.md](CHANGELOG.md) for more information.

## License

Copyright (c) 2020-2023 Thomas Lindner. Licensed under the MIT license.