From 1b618e2f680a4cda5825f9ac9970382a51c4b077 Mon Sep 17 00:00:00 2001 From: York Yao Date: Wed, 9 Sep 2020 06:48:44 +0800 Subject: [PATCH] docs: improve docs for config in package.json --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 134f5fe..60c00c3 100644 --- a/README.md +++ b/README.md @@ -81,19 +81,19 @@ This tool will ignore the files, eg: `--ignore-files "demo1/*.ts" --ignore-files ## config in package.json -```json +```json5 "typeCoverage": { - "atLeast": 99, // same as --at-least - "is": 99 // same as --is - "cache": true // same as --cache - "debug": true // same as --debug - "detail": true // same as --detail - "ignoreCatch": true // same as --ignore-catch - "ignoreFiles": ["demo1/*.ts", "demo2/foo.ts"] // same as --ignore-files "demo1/*.ts" --ignore-files "demo2/foo.ts" - "project": "tsconfig.json" // same as --project tsconfig.json or -p tsconfig.json - "strict": true // same as --strict - "suppressError": true // same as --suppressError - "update": true // same as --update + "atLeast": 99, // same as --at-least (Added in `v1.4`) + "is": 99, // same as --is (Added in `v2.6`) + "cache": true, // same as --cache (Added in `v2.11`) + "debug": true, // same as --debug (Added in `v2.11`) + "detail": true, // same as --detail (Added in `v2.11`) + "ignoreCatch": true, // same as --ignore-catch (Added in `v2.11`) + "ignoreFiles": ["demo1/*.ts", "demo2/foo.ts"], // same as --ignore-files "demo1/*.ts" --ignore-files "demo2/foo.ts" (Added in `v2.11`) + "project": "tsconfig.json", // same as --project tsconfig.json or -p tsconfig.json (Added in `v2.11`) + "strict": true, // same as --strict (Added in `v2.11`) + "suppressError": true, // same as --suppressError (Added in `v2.11`) + "update": true // same as --update (Added in `v2.11`) }, ```