summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorHirotaka Tagawa / wafuwafu13 <jaruwafu@gmail.com>2023-05-26 04:00:29 +0100
committerGitHub <noreply@github.com>2023-05-26 05:00:29 +0200
commit0a3d355ce6311df6519dbffe7394ed2682d8a633 (patch)
tree9d9a803cec2c5fd0dc6709f43115b82515c2dc32 /tools
parent2ddf85492ff5d5806e63a46286ee0e3603042c02 (diff)
chore(node_compat): fix broken link and typo (#19265)
Diffstat (limited to 'tools')
-rw-r--r--tools/node_compat/README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/tools/node_compat/README.md b/tools/node_compat/README.md
index 08fcc077b..c422a1d0e 100644
--- a/tools/node_compat/README.md
+++ b/tools/node_compat/README.md
@@ -11,7 +11,7 @@ Node.js compat testing in Deno repository.
- This script sets up the Node.js compat tests.
- `//tools/node_comapt/versions/`
- Node.js source tarballs and extracted test cases are stored here.
-- `//cli/tests/node_compat/config.json`
+- `//cli/tests/node_compat/config.jsonc`
- This json file stores the settings about which Node.js compat test to run
with Deno.
- `//cli/tests/node_compat/test`
@@ -19,21 +19,22 @@ Node.js compat testing in Deno repository.
## Steps to add new test cases from Node.js test cases
-1. Update `tests` property of `//cli/tests/node_compat/config.json`. For
+1. Update `tests` property of `//cli/tests/node_compat/config.jsonc`. For
example, if you want to add `test/paralles/test-foo.js` from Node.js test
cases, then add `test-foo.js` entry in `tests.parallel` array property in
- `config.json`
+ `config.jsonc`
1. Run `./tools/node_compat/setup.ts`
The above command copies the updated items from Node.js tarball to the Deno
source tree.
Ideally Deno should pass the Node.js compat tests without modification, but if
-you need to modify it, then add that item in `ignore` perperty of `config.json`.
-Then `setup.ts` doesn't overwrite the modified Node.js test cases anymore.
+you need to modify it, then add that item in `ignore` perperty of
+`config.jsonc`. Then `setup.ts` doesn't overwrite the modified Node.js test
+cases anymore.
If the test needs to be ignored in particular platform, then add them in
-`${platform}Ignore` property of `config.json`
+`${platform}Ignore` property of `config.jsonc`
## Run Node.js test cases