feat: add support for custom snapshot names, close #555

[noahnu]

Description

Based on #561.

Related Issues

• Closes Give custom name to image snapshot file #555

[codecov]

Codecov Report

Merging #563 (f657109) into master (21cfed8) will decrease coverage by 0.26%.
The diff coverage is 100.00%.

❗ Current head f657109 differs from pull request most recent head b56c8c5. Consider uploading reports for the commit b56c8c5 to get more accurate results

@@            Coverage Diff             @@
##           master     #563      +/-   ##
==========================================
- Coverage   99.91%   99.64%   -0.27%     
==========================================
  Files          19       19              
  Lines        1130     1142      +12     
==========================================
+ Hits         1129     1138       +9     
- Misses          1        4       +3     

[iamogbz]

Nice! This looks similar to stuff I had to do here https://github.com/tophat/syrupy/pull/526/files, can rebase after this gets merged in

[noahnu]

What's left on this PR: we need to address #561 (comment)

[noahnu]

For context: had to wrap the custom name in square brackets to prevent the "cannot relate snapshot name" warning. Reason this works is because

syrupy/src/syrupy/location.py

Line 67 in 818d405

for n in name.split("."):

stops reading the name at the first non-valid python id character, which would be [ in this case. Being able to relate snapshots is critical for discovering unused snapshots.

In the next major version of syrupy, I'd propose including the index in the snapshot itself, separate from the snapshot name so we can better differentiate the two.

[noahnu]

@all-contributors add bendidi for code

[allcontributors]

@noahnu

I've put up a pull request to add @Bendidi! 🎉

[tophat-opensource-bot]

🎉 This PR is included in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀