From af6bb4511de7119a337672b2fcb89fa3d4d74643 Mon Sep 17 00:00:00 2001 From: Andrew Dryga Date: Wed, 25 Nov 2020 05:05:23 +0200 Subject: [PATCH] Explain that skip_files should be valid elixir regexes Closes #235 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a84ccc7b..0d000aa4 100644 --- a/README.md +++ b/README.md @@ -350,6 +350,8 @@ If you want to exclude/ignore files from the coverage calculation add the `skip_ } ``` +Path should contain a string that can be compiled to Elixir regex, you can test them running `Regex.compile("your_path")` in your `iex` shell. + Note that this doesn't work directly in an umbrella project. If you need to exclude files within an app, you should create a separate `coveralls.json` at the root of the app's folder and add a `skip_files` key to _that_ file. Paths should be relative to that file, not the umbrella project. #### Terminal Report Output