Skip to content

Commit

Permalink
docs: add FAQ entry about running ESLint on transpiled code (#6155)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Dec 7, 2022
1 parent d91a5fc commit dbc8671
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/linting/Troubleshooting.md
Expand Up @@ -107,6 +107,13 @@ This is to be expected - ESLint rules do not check file extensions on purpose, a

If you have some pure JavaScript code that you do not want to apply certain lint rules to, then you can use [ESLint's `overrides` configuration](https://eslint.org/docs/user-guide/configuring#configuration-based-on-glob-patterns) to turn off certain rules, or even change the parser based on glob patterns.

## Should I run ESLint on transpiled output JavaScript files?

No.

Source TypeScript files have all the content of output JavaScript files, plus type annotations.
There's no benefit to also linting output JavaScript files.

## TypeScript should be installed locally

Make sure that you have installed TypeScript locally i.e. by using `npm install typescript`, not `npm install -g typescript`,
Expand Down

0 comments on commit dbc8671

Please sign in to comment.