insta review fails with a hidden snapshot directory (starting with '.')

[ngryman]

What happened?

Hi,

I'm using a custom directory for my snapshot located at the root of my project at $CARGO_MANIFEST_DIR/.snapshots. When running my tests, snapshots are generated correctly. However, cargo insta review fails to locate them.

Changing the directory to a non-hidden one; removing the . prefix; works fine.

Theory

After quickly scanning the source I think it may come from these lines:

insta/cargo-insta/src/cargo.rs

Lines 257 to 258 in ab93e8d

	.hidden(false)
	.standard_filters(!no_ignore)

From the WalkDir documentation, it seems that the standard_filters re-enables the hidden option. So it might be the case that it's overriding the previous hidden(false) option in the context of reviewing snapshots.

As a side note, my .snapshots directory is not git ignored so my issue must come from the hidden option, and not the git_ignore one enabled by standard_filters.

Reproduction steps

1. Set a hidden directory as the snapshot directory with with_settings!.
2. Run your test.
3. Check that snapshots are generated properly.
4. Run cargo insta review.
5. The following message appears: done: no snapshots to review.

Insta Version

No response

rustc Version

No response

What did you expect?

I expect cargo insta review to properly locate the snapshot directory.

[mitsuhiko]

This is intentional behavior. You need to pass --no-ignore to cargo insta review. I will consider changing this however.

EDIT: It doesn't look like it was intentional to turn on hidden folders at all. The current logic skips it in the filter even when no_ignore is passed.

[mitsuhiko]

With the next version you will be able to pass --include-hidden to have insta walk into hidden folders.

[ngryman]

@mitsuhiko Thanks for the quick reply & fix!

[ngryman]

Hi @mitsuhiko,

I just updated to 1.24.0 and my issue is resolved but not as expected.

tl;dr --include-ignored works but --include-hidden has no effect.

---

I have the same use case as before, which is:

1. I want my snapshot directories to be .snapshots.
2. I don't ignore .snapshots in any of the files listed in WalkBuilder's standard filters.

Current behavior

1️⃣ When I run cargo-insta with --include-hidden, I get the following:

2️⃣ When I run cargo-insta with --include-ignored, it works.

Expected behavior

In my use case, I would expect 1️⃣ to have the same behavior than 2️⃣.

The error message in 1️⃣ should not appear as it advises me to use the flag I did use.