https://github.com/bahmutov/snap-shot-compare
Picks best comparison / diff for snapshot value
https://github.com/bahmutov/snap-shot-compare
comparison diff difference object string text
Last synced: 23 days ago
JSON representation
Picks best comparison / diff for snapshot value
- Host: GitHub
- URL: https://github.com/bahmutov/snap-shot-compare
- Owner: bahmutov
- Created: 2017-08-14T21:21:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T19:25:55.000Z (about 1 year ago)
- Last Synced: 2024-10-02T14:12:02.657Z (about 1 year ago)
- Topics: comparison, diff, difference, object, string, text
- Language: JavaScript
- Size: 321 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# snap-shot-compare
> Picks best comparison / diff for snapshot value
[![NPM][npm-icon] ][npm-url]
[![Build status][ci-image] ][ci-url]
[![semantic-release][semantic-image] ][semantic-url]
[![js-standard-style][standard-image]][standard-url]
[![renovate-app badge][renovate-badge]][renovate-app]
## Why
Use this comparator function with
[snap-shot-core](https://github.com/bahmutov/snap-shot-core)
## Install
Requires [Node](https://nodejs.org/en/) version 6 or above.
```sh
npm install --save snap-shot-compare
```
## Use
Compare returns a [Folktale.Result][Folktale.Result] object.
```js
const compare = require('snap-shot-compare')
let result
// if values are equal
compare({
expected: 42,
value: 100
}).map(console.log)
// prints undefined
// if objects are different
compare({
expected: {foo: 'foo'},
value: {bar: 'bar'}
}).orElse(console.log)
// result has ANSI characters
// use "strip-ansi" to remove if desired
/*
snapshot difference
{
- foo: "foo"
+ bar: "bar"
}
*/
```
When showing the diff, `-` is for the lines removed, `+` means a line has been added.
### Other options
There are a few secondary options that might not be consistent across all
comparison modes (open a GitHub issue if an unexpected behavior is found)
```js
compare({
expected,
value,
noColor, // strips ASCII color from diff message
json // returns error result as JSON object
// with the following properties
// {message, expected, value}
})
```
Note: `json = true` option means `noColor = true` automatically.
### Uses
* [Folktale.Result][Folktale.Result]
* [variable-diff](https://github.com/taylorhakes/variable-diff) to show diff
between two objects
* [disparity](https://github.com/millermedeiros/disparity) to show diff
between multi line text
For longer text fragments, prints "expected" and "actual" values when showing the difference.
[Folktale.Result]: http://folktale.origamitower.com/api/v2.0.0/en/folktale.result.html
## Debug
To see verbose logs run with environment variable
```
DEBUG=snap-shot-compare
```
### Small print
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017
* [@bahmutov](https://twitter.com/bahmutov)
* [glebbahmutov.com](https://glebbahmutov.com)
* [blog](https://glebbahmutov.com/blog)
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/bahmutov/snap-shot-compare/issues) on Github
## MIT License
Copyright (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/snap-shot-compare.svg?downloads=true
[npm-url]: https://npmjs.org/package/snap-shot-compare
[ci-image]: https://travis-ci.org/bahmutov/snap-shot-compare.svg?branch=master
[ci-url]: https://travis-ci.org/bahmutov/snap-shot-compare
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/