How to ignore a particular directory or file for tslint?

Question

The IDE being used is WebStorm 11.0.3, the tslint is configured and works, but, it hangs because it tries to parse large *.d.ts library files.

Is there a way to ignore a particular file or directory?

score 239 · Accepted Answer · edited Jul 22 '19 at 01:59

Update for tslint v5.8.0

As mentioned by Saugat Acharya, you can now update tslint.json CLI Options:

{
  "extends": "tslint:latest",
  "linterOptions": {
      "exclude": [
          "bin",
          "lib/*generated.js"
      ]
  }
}

More information in this pull request.

This feature has been introduced with tslint 3.6

tslint \"src/**/*.ts\" -e \"**/__test__/**\"

You can now add --exclude (or -e) see PR here.

CLI

usage: tslint [options] file ...

Options:

-c, --config          configuration file
--force               return status code 0 even if there are lint errors
-h, --help            display detailed help
-i, --init            generate a tslint.json config file in the current working directory
-o, --out             output file
-r, --rules-dir       rules directory
-s, --formatters-dir  formatters directory
-e, --exclude         exclude globs from path expansion
-t, --format          output format (prose, json, verbose, pmd, msbuild, checkstyle)  [default: "prose"]
--test                test that tslint produces the correct output for the specified directory
-v, --version         current version

you are looking at using

-e, --exclude         exclude globs from path expansion

Small correction to the update: it should be `linterOptions` and not `cliOptions` — JeB, Nov 13 '17 at 07:27
It's also worth to mention that the glob patterns inside the exclude directory shall be relative to the `tslint.json` — JeB, Nov 13 '17 at 07:55

DeadlyChambers · Answer 2 · 2020-10-24T03:47:12.643

91

Currently using Visual Studio Code and the command to disable tslint is

/* tslint:disable */

Something to note. The disable above disables ALL tslint rules on that page. If you want to disable a specific rule you can specify one/multiple rules.

/* tslint:disable comment-format */
/* tslint:disable:rule1 rule2 rule3 etc.. */

Or enable a rule

/* tslint:enable comment-format */

More in depth on TSLint rule flags

edited Oct 24 '20 at 03:47

answered Sep 27 '17 at 13:28

DeadlyChambers

5,217
4
44
61

3

from all of the answers, this is the only one that worked. thanks! – Oz Lodriguez Apr 21 '19 at 18:07
For example, `/* tslint:disable:TS2322 */` did not work. Are you sure that you can ignore rules with your second code block? – Bullsized Nov 28 '22 at 14:27
You might need // instald of /* */ that link has some in depth rule, rules – DeadlyChambers Dec 07 '22 at 00:01

arkhwise · Answer 3 · 2017-11-01T07:49:15.147

27

In addition to Michael's answer, consider a second way: adding linterOptions.exclude to tslint.json

For example, you may have tslint.json with following lines:

{
  "linterOptions": {
    "exclude": [
      "someDirectory/*.d.ts"
    ]
  }
}

edited Nov 01 '17 at 07:49

answered Oct 31 '17 at 11:44

arkhwise

873
9
13

Saugat · Answer 4 · 2019-04-14T11:42:29.570

19

Starting from tslint v5.8.0 you can set an exclude property under your linterOptions key in your tslint.json file:

{
  "extends": "tslint:latest",
  "linterOptions": {
      "exclude": [
          "bin",
          "**/__test__",
          "lib/*generated.js"
      ]
  }
}

More information on this here.

edited Apr 14 '19 at 11:42

answered Oct 31 '17 at 16:08

Saugat

1,309
14
22

2

This should be marked as the correct (and updated Nov-2017) answer. – Andres Elizondo Nov 03 '17 at 09:09
The correct way to do this is to replace `cliOptions` with `linterOptions`. – Saugat Apr 08 '19 at 14:56

score 15 · Answer 5 · answered Aug 28 '19 at 21:28

15

I had to use the **/* syntax to exclude the files in a folder:

    "linterOptions": {
        "exclude": [
          "src/auto-generated/**/*",
          "src/app/auto-generated/**/*"
        ]
    },

answered Aug 28 '19 at 21:28

techguy2000

4,861
6
32
48

score 10 · Answer 6 · answered Nov 29 '19 at 14:57

As an addition

To disable all rules for the next line // tslint:disable-next-line

To disable specific rules for the next line: // tslint:disable-next-line:rule1 rule2...

To disable all rules for the current line: someCode(); // tslint:disable-line

To disable specific rules for the current line: someCode(); // tslint:disable-line:rule1

score 9 · Answer 7 · answered Jan 03 '16 at 18:11

9

There are others who encountered the problem. Unfortunately, there is only an open issue for excluding files: https://github.com/palantir/tslint/issues/73

So I'm afraid the answer is no.

answered Jan 03 '16 at 18:11

MartyIX

27,828
29
136
207

score 6 · Answer 8 · answered Oct 18 '18 at 15:29

6

linterOptions is currently only handled by the CLI. If you're not using CLI then depending on the code base you're using you'll need to set the ignore somewhere else. webpack, tsconfig, etc

answered Oct 18 '18 at 15:29

Kris

61
1
2

score 4 · Answer 9 · answered Sep 24 '19 at 14:25

4

Can confirm that on version tslint 5.11.0 it works by modifying lint script in package.json by defining exclude argument:

"lint": "ng lint --exclude src/models/** --exclude package.json"

Cheers!!

answered Sep 24 '19 at 14:25

Sanid Sa

264
3
9

1

Were you referring to some other answer, or did you simply wanted to provide an alternative answer to the question? – Dharman Sep 24 '19 at 15:08

score 4 · Answer 10 · edited Oct 12 '22 at 15:58

4

add the section in your code example

"linterOptions": {
  "exclude": [
    "node_modules/**/*.",
    "db/**/*.",
    "integrations/**/*."
  ]
},

edited Oct 12 '22 at 15:58

sezanzeb

816
8
20

answered Nov 12 '20 at 05:14

Mohammed Al-Reai

2,344
14
18

How to ignore a particular directory or file for tslint?

10 Answers10

Linked