1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# Contributing
Thanks for contributing!
## Before you contribute
This package is a fork of [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal). This library has added handling for React.
Before contributing, _please make sure the issue relates directly to this library and not fast-deep-equal_.
We encourage pull requests concerning:
* React features not handled in this library
* Integrating updates from `fast-deep-equal` － This, unfortunately, now requires more manual work. Use the comment blocks in `index.js`
to figure out what to paste and where.
* Integrating tests from `fast-deep-equal` － This usually entails upgrading the `git`-based dependencies of `fast-deep-equal-git` and
`npm`-published package of `fast-deep-equal` in `package.json:devDependencies`.
* Bugs in this library
* New tests for React
* Documentation
Pull requests that should be for [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal):
* Equality of non-react comparisons
* Performance of non-react comparisons
* Tests for non-react comparisons
## Development
Install the project using `yarn` (which we've standardized on for development):
```sh
$ yarn install
```
**TL; DR:** － Everything you normally need to run is aggregated into:
```sh
$ yarn run test
$ yarn run benchmark
```
(We use `builder` to parallelize things, so tasks may output in different
orders)
### Testing
We write one set of tests located in:
- `tests/node/**.spec.js`
that run in two very different scenarios:
#### Node
The tests are natively run in `node` (hence why they are located in `tests/node`
to begin with) without any transpilation or "build". You can run them with:
```sh
# Single run
$ yarn run test-node
# Persistent watch
$ yarn run test-node --watch
```
#### Browsers
The same tests are then imported and built with `webpack` to a test bundle that
can be run in arbitrary browsers. So far in CI, we execute the tests in headless
Chrome on Linux in Travis and IE11 in Appveyor.
To run the browser tests on your machine (note: you must already have the
browser you're running installed):
```sh
# Default: headless chrome
$ yarn run test-browser
# Example: real Chrome + Firefox + Safari
$ yarn run test-browser --browsers Chrome,Firefox,Safari
# IE11 (on Windows)
$ yarn run test-browser-ie
```
### Types
We validate our TypeScript `index.d.ts` with two steps:
```sh
# Runs the TypeScript compiler over our types
$ yarn run test-ts-defs
# Runs our types through a sample TypeScript file
$ yarn run test-ts-usage
```
### Style
```sh
$ yarn run eslint
```
### Size
You can check how we do with minification + compression with:
```sh
# Show minified output
$ yarn -s compress
# Display minified + gzip'ed size in bytes.
$ yarn size-min-gz
```
**Note**: If the min+gz size increases, please note it in the README. If it is a significant increase,
please flag to your reviewers and have a discussion about whether or not the size addition is justified.
## Before submitting a PR...
... please make sure that you have done the following:
1. Confirm that all checks are passing:
```sh
$ yarn run test
$ yarn run benchmark
```
2. Confirm we don't have any significant performance regressions (check out `master` for a baseline comparison on _your_ machine).
3. Confirm you aren't impacting our bundle size.
If you _do_ affect the bundle size, please update the bundle badge in the Readme by
* Following the steps outlined in [size](#size):
`yarn -s compress && yarn size-min-gz`
* Grabbing that output and replacing the current size in the bundle_img: (`https://img.shields.io/badge/minzipped%20size-<NEW_SIZE>%20B-flatgreen.svg`)
For example, if the new size is `650`, the new bundle_img will be `https://img.shields.io/badge/minzipped%20size-650%20B-flatgreen.svg`
## Releasing a new version to NPM
_Only for project administrators_
```sh
# (1) Run tests, lint, build published dir, update package.json
$ npm version [patch|minor|major|<version>]
# (2) If all is well, publish the new version to the npm registry
$ npm publish
# (3) Then, update github with the associated tag
$ git push && git push --tags
```
|
