also support comments in json file

jestjs · Feb 7, 2022 · 739ec0d · 739ec0d
1 parent 9d7a27b
commit 739ec0d
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-config]` Support comments in JSON config file ([#12316](https://github.com/facebook/jest/pull/12316))
 - `[pretty-format]` Expose `ConvertAnsi` plugin ([#12308](https://github.com/facebook/jest/pull/12308))
 
 ### Fixes

diff --git a/e2e/multiple-configs/jest.config.json b/e2e/multiple-configs/jest.config.json
@@ -1,3 +1,4 @@
 {
+  // this is a comment in a JSON file
   "displayName": "Config from json file"
 }
diff --git a/packages/jest-config/package.json b/packages/jest-config/package.json
@@ -47,7 +47,8 @@
     "micromatch": "^4.0.4",
     "parse-json": "^5.2.0",
     "pretty-format": "^27.5.0",
-    "slash": "^3.0.0"
+    "slash": "^3.0.0",
+    "strip-json-comments": "^3.1.1"
   },
   "devDependencies": {
     "@types/glob": "^7.1.1",

diff --git a/packages/jest-config/src/readConfigFileAndSetRootDir.ts b/packages/jest-config/src/readConfigFileAndSetRootDir.ts
@@ -8,6 +8,7 @@
 import * as path from 'path';
 import * as fs from 'graceful-fs';
 import parseJson = require('parse-json');
+import stripJsonComments = require('strip-json-comments');
 import type {Service} from 'ts-node';
 import type {Config} from '@jest/types';
 import {interopRequireDefault, requireOrImportModule} from 'jest-util';
@@ -34,7 +35,7 @@ export default async function readConfigFileAndSetRootDir(
       configObject = await loadTSConfigFile(configPath);
     } else if (isJSON) {
       const fileContent = fs.readFileSync(configPath, 'utf8');
-      configObject = parseJson(fileContent, configPath);
+      configObject = parseJson(stripJsonComments(fileContent), configPath);
     } else {
       configObject = await requireOrImportModule<any>(configPath);
     }

diff --git a/yarn.lock b/yarn.lock
@@ -12624,6 +12624,7 @@ __metadata:
     semver: ^7.3.5
     slash: ^3.0.0
     strip-ansi: ^6.0.0
+    strip-json-comments: ^3.1.1
     ts-node: ^9.0.0
     typescript: ^4.0.3
   peerDependencies: