Skip to content

Commit 3c4fc51

Browse files
committed
updates readme
1 parent 845706c commit 3c4fc51

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/vs/editor/test/node/diffing/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@
33
Every folder in `fixtures` represents a test.
44
The file that starts with `1.` is diffed against the file that starts with `2.`. Use `tst` instead of `ts` to avoid compiler/linter errors for typescript diff files.
55

6-
* When you delete `*.actual.diff.json`, they are regenerated.
7-
* Make sure to delete `*.expected.diff.json`, as they make the tests fail.
6+
* Missing `*.expected.diff.json` are created automatically (as well as an `*.invalid.diff.json` file).
7+
* If the actual diff does not equal the expected diff, the expected file is updated automatically. The previous value of the expected file is written to `*.invalid.diff.json`.
8+
* The test will fail if there are any `*.invalid.diff.json` files. This makes sure that the test keeps failing even if it is run a second time.
9+
10+
When changing the diffing algorithm, run the fixture tests, review the diff of the `*.expected.diff.json` files and delete all `*.invalid.diff.json` files.

0 commit comments

Comments
 (0)