Add support for comments in jsonc

Igorkowalski94 · Jul 25, 2024 · ad7b124 · ad7b124
1 parent 8af61e0
commit ad7b124
Show file tree

Hide file tree

Showing 7 changed files with 1,263 additions and 125 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+    "presets": ["@babel/preset-env"]
+}
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+    presets: ["@babel/preset-env"],
+};
diff --git a/jest.config.ts b/jest.config.ts
@@ -10,6 +10,7 @@ const jestConfig: JestConfigWithTsJest = {
                 isolatedModules: true,
             },
         ],
+        "^.+\\.[jt]sx?$": "babel-jest",
     },
     cacheDirectory: "<rootDir>/jestCache",
     collectCoverage: false,
@@ -21,6 +22,7 @@ const jestConfig: JestConfigWithTsJest = {
             branches: 100,
         },
     },
+    transformIgnorePatterns: ["/node_modules/(?!strip-json-comments).+\\.js$"],
 };
 
 export default jestConfig;
diff --git a/package.json b/package.json
@@ -52,9 +52,12 @@
     "dependencies": {
         "@typescript-eslint/utils": "^7.13.0",
         "js-yaml": "^4.1.0",
-        "micromatch": "^4.0.7"
+        "micromatch": "^4.0.7",
+        "strip-json-comments": "^5.0.1"
     },
     "devDependencies": {
+        "@babel/core": "^7.24.9",
+        "@babel/preset-env": "^7.24.8",
         "@types/eslint": "^8.56.10",
         "@types/jest": "^29.5.12",
         "@types/js-yaml": "^4.0.9",

diff --git a/src/helpers/readConfigFile.test.ts b/src/helpers/readConfigFile.test.ts
@@ -15,9 +15,9 @@ jest.mock("js-yaml", () => ({
 describe("readConfigFile", () => {
     it("should return config from yaml", () => {
         (readFileSync as jest.Mock).mockReturnValue('{"name":"yaml"}');
-        expect(readConfigFile("folderStructure.yaml")).toEqual(
-            '{"name":"yaml"}',
-        );
+        expect(readConfigFile("folderStructure.yaml")).toEqual({
+            name: "yaml",
+        });
     });
 
     it("should return undefined when yaml config path is incorrect", () => {
@@ -32,9 +32,9 @@ describe("readConfigFile", () => {
         (load as jest.Mock).mockReturnValue(null);
         (readFileSync as jest.Mock).mockReturnValue('{"name":"json"}');
 
-        expect(readConfigFile("folderStructure.json")).toEqual(
-            '{"name":"json"}',
-        );
+        expect(readConfigFile("folderStructure.json")).toEqual({
+            name: "json",
+        });
     });
 
     it("should return undefined when json config path is incorrect", () => {

diff --git a/src/helpers/readConfigFile.ts b/src/helpers/readConfigFile.ts
@@ -1,6 +1,7 @@
 import { readFileSync } from "fs";
 
 import { load } from "js-yaml";
+import stripJsonComments from "strip-json-comments";
 
 export const readConfigFile = <T>(configPath: string): T | undefined => {
     let config;
@@ -10,7 +11,7 @@ export const readConfigFile = <T>(configPath: string): T | undefined => {
 
         if (!config)
             config = JSON.parse(
-                JSON.stringify(readFileSync(configPath, "utf-8")),
+                stripJsonComments(readFileSync(configPath, "utf-8")),
             );
     } catch (error) {
         return;