Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Commit c24836b

Browse files
committed
chore: README tweak
1 parent 0e1b3bc commit c24836b

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
[![Version](https://img.shields.io/npm/v/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-airbnb-typescript?activeTab=versions) [![Downloads](https://img.shields.io/npm/dt/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-airbnb-typescript) [![Last commit](https://img.shields.io/github/last-commit/iamturns/eslint-config-airbnb-typescript.svg?style=flat-square)](https://github.com/iamturns/eslint-config-airbnb-typescript/graphs/commit-activity) [![Build](https://img.shields.io/circleci/project/github/iamturns/eslint-config-airbnb-typescript/master.svg?style=flat-square)](https://circleci.com/gh/iamturns/eslint-config-airbnb-typescript) [![License](https://img.shields.io/github/license/iamturns/eslint-config-airbnb-typescript.svg?style=flat-square)](https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/CONTRIBUTING.md) [![Code of conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square)](https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/CODE_OF_CONDUCT.md)
44

5-
> Airbnb's ESLint config with TypeScript support
6-
7-
Works with both JS and TS files.
5+
Airbnb's ESLint config with TypeScript support
86

97
## Setup
108

@@ -80,6 +78,10 @@ You can also get results in realtime inside most IDEs via a plugin.
8078

8179
## FAQ
8280

81+
### Does this work with JavaScript files too?
82+
83+
Yep! This config is a drop-in replacement for `eslint-config-airbnb`, decorating it with TypeScript support.
84+
8385
### I get this error when running ESLint: "The file must be included in at least one of the projects provided"
8486

8587
This means you are attempting to lint a file that `tsconfig.json` doesn't include.
@@ -108,11 +110,7 @@ This is a known problem. Some suggestions exist in this [GitHub issue](https://g
108110

109111
### I wish this config would support [...]
110112

111-
The goal of `eslint-config-airbnb-typescript` is to simply decorate `eslint-config-airbnb` with TypeScript support. All rules and settings are identical. It's a drop-in replacement for `eslint-config-airbnb`, including linting for JavaScript files.
112-
113-
It's not a single config to cater for all TypeScript linting requirements.
114-
115-
For additional functionality, alter your ESLint config file. For example:
113+
The goal of `eslint-config-airbnb-typescript` is to simply decorate `eslint-config-airbnb` with TypeScript support. It's not a single config to cater for all TypeScript linting requirements. For additional functionality, alter your ESLint config file. For example:
116114

117115
```js
118116
module.exports = {

0 commit comments

Comments
 (0)