23

Is it possible to exclude/ignore a file when using Husky/lint-staged hooks?

Looking through the docs atm but not having any luck finding anything on this.

Was hoping there was something like an 

/*ignore*/

tag that I could add.

To make lint-staged ignore certain files that were causing formatting issues.

Any thought on this greatly appreciated :)

uidevthing
  • 1,781
  • 2
  • 12
  • 24

6 Answers6

26

Ended up adding 

.prettierignore

file.

Not ideal but seems to do the job ok.

uidevthing
  • 1,781
  • 2
  • 12
  • 24
  • I believe thats actually the ideal solution. Lint-staged removed the configuration to ignore files and their docs mention using .prettierignore as the solution. Source:https://github.com/okonet/lint-staged#configuration – Arthur Costa Feb 02 '22 at 00:30
  • 1
    I do not use the `prettier` package, thus adding such file is not ideal. – vsync Dec 18 '22 at 21:59
  • 2
    In my case it was .eslintignore file – Dror Bar Apr 02 '23 at 11:23
17

I finally found out how to do this (at least as of lint-staged v11.1.2)

In package.json:

"lint-staged": {
  "!(path/to/excluded/dir/**/*)*.ts": [
    "eslint --fix",
    "prettier --write"
  ]
}

Note the globstar pattern is within the negation pattern and not outside it. This ensures that subdirectories are also excluded.

Fredric Waadeland
  • 436
  • 7
  • 6
11

While configuring lint-staged in package.json or If you're using any other IDE, in order to ignore/exclude files by lint-Staged and husky hooks, you can add an "ignore" key in the lint-staged object to make it ignore whatever packages or files you want to ignore. Use the following extensible syntax:

{
  "lint-staged": {
    "linters": {
      "src/**/*.js": ["formatter --write", "git add"],
    },
    "ignore": ["node_modules", "dist", "package-lock.json"]  }
}

Just add the target pattern to 'linters' object and all the ignored files which you might be adding previously to .prettierignore to "ignore" key of lint-Staged object. And there you go!

Ayesha Iftikhar
  • 1,028
  • 2
  • 11
  • 27
6

If anyone still looking, take a look at this https://github.com/okonet/lint-staged#filtering-files It has good examples.

Filtering files

Linter commands work on a subset of all staged files, defined by a glob pattern. `lint-staged´ uses micromatch for matching files with the following rules:

  • If the glob pattern contains no slashes (/), micromatch's matchBase option will enabled, so globs match a file's basename regardless of directory:
    • "*.js" will match all JS files, like /test.js and /foo/bar/test.js
    • "!(*test).js". will match all JS files, except those ending in test.js, so foo.js but not foo.test.js
  • If the glob pattern does contain a slash (/), it will match for paths as well:
    • "./*.js" will match all JS files in the git repo root, so /test.js but not /foo/bar/test.js
    • "foo/**/\*.js" will match all JS files inside the/foodirectory, so/foo/bar/test.jsbut not/test.js
Aamir Afridi
  • 6,364
  • 3
  • 42
  • 42
  • I played/fighted a little bit with it. I use : "lint-staged": { "projects/**!(*node_nodules)!(*dist)/*(package-lock).{js,ts,json,css,scss,html}": ["prettier --write"]}. Micromatch supports a nice array syntax, but it cannot be used with lint-staged. – Olivvv Feb 06 '20 at 11:06
  • Did you tried this https://github.com/okonet/lint-staged#example-use-your-own-globs ? – Aamir Afridi Feb 06 '20 at 15:47
  • 1
    no, I wanted to have it all in package.json. I ended up getting the result I need (modifying further the above code). I find the result not so nice to read, it feels a bit like regexes. I perceive the old syntax as more explit and more accessible to someone reading a package.json for the first time. – Olivvv Feb 07 '20 at 09:06
  • 4
    my final syntax (for the lazy ppl who prefer to copy and modify stuff) : "projects/!(node_modules|dist)/**/*.{js,ts,json,css,scss,html}" – Olivvv Feb 07 '20 at 09:07
4

So I've been trying to find an answer for this for an entire day and looking at all the forums suggested that they use minimatch for glob check which might have been correct for older versions but they use micromatch for new version and to solve this issue we can use their pattern to exclude certain directories So in your .lintstagedrc you can add the following pattern to avoid certain folders

{
  "*.{json,md,html,scss}": ["prettier --write", "git add"],
  ["**/!(folder1|folder2)/*.ts"]: ["tslint --project tsconfig.json -c tslint.commit.json --fix", "prettier --write", "git add"]
}

So the glob here is an actual array and make sure not to pass this array within a string else it won't recognize the patterns also do not include **/*.ts the reason being lint-staged automatically converts this into a matchBase comparision if it finds / in the pattern so including this will also match against your folder1|folder2 files.

saNiks
  • 744
  • 5
  • 15
0

can fix in three ways:

  • .lintstagedrc.js
  • .prettierignore
  • lint-staged.config.js

more info : https://github.com/okonet/lint-staged/issues/797

Nicky
  • 67
  • 5