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

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

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

Last synced: about 1 month ago
JSON representation

ESLint shareable config for JavaScript projects

• Host: GitHub
• URL: https://github.com/tclindner/eslint-config-tc
• Owner: tclindner
• License: mit
• Created: 2016-07-17T16:58:56.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-08-10T02:34:16.000Z (about 1 month ago)
• Last Synced: 2024-08-10T03:31:48.504Z (about 1 month ago)
• Topics: eslint, javascript, linting, naming-conventions, style-guide, style-linter, styleguide
• Language: JavaScript
• Homepage:
• Size: 2.71 MB
• Stars: 4
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-tc

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

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

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

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

[![Dependency Status](https://david-dm.org/tclindner/eslint-config-tc.svg?style=flat-square)](https://david-dm.org/tclindner/eslint-config-tc)

[![devDependency Status](https://david-dm.org/tclindner/eslint-config-tc/dev-status.svg?style=flat-square)](https://david-dm.org/tclindner/eslint-config-tc#info=devDependencies)

## What is eslint-config-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-tc

```

> eslint, eslint-plugin-import, eslint-plugin-jest, eslint-plugin-prettier, eslint-plugin-unicorn, and prettier are peer dependencies and must be installed.

## Usage

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

```json

{

  "extends": "eslint-config-tc"

}

```

If you need to override a rule, your `.eslintrc.json` file should look like the example below. All shared rules will be used, but `eqeqeq` will be turned off.

```json

{

  "extends": "eslint-config-tc",

  "rules": {

    "eqeqeq": "off"

  }

}

```

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Release History

Please see [CHANGELOG.md](CHANGELOG.md).

## License

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