Use json5 for studies storage (#1227)

Replace `JSON.parse/stringify` with `JSON5.parser/stringify`, also
remove prefix `PLATFORM_` from platforms.

.prettierrc.js

@@ -19,5 +19,13 @@ module.exports = {
         parser: 'json-stringify',
       },
     },
+    {
+      files: '*.json5',
+      options: {
+        // Sync with JSON5.stringify logic.
+        plugins: ['prettier-plugin-multiline-arrays'],
+        trailingComma: 'all',
+      },
+    },
   ],
 };

package.json

@@ -36,6 +36,7 @@
     "jest": "29.7.0",
     "lint-staged": "15.2.10",
     "prettier": "3.3.3",
+    "prettier-plugin-multiline-arrays": "3.0.6",
     "prettier-plugin-organize-imports": "3.2.4",
     "protobufjs": "7.4.0",
     "protobufjs-cli": "1.1.3",
@@ -54,6 +55,7 @@
   "moduleResolution": "node",
   "dependencies": {
     "@protobuf-ts/runtime": "2.9.4",
+    "json5": "2.2.3",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-router": "6.27.0",

src/seed_tools/commands/create.test.ts

@@ -15,6 +15,7 @@ describe('create command', () => {
   const testDataDir = wsPath('//src/test/data');
 
   let tempDir: string;
+  let logMock: jest.SpyInstance;
   let exitMock: jest.SpyInstance;
   let errorMock: jest.SpyInstance;
 
@@ -23,11 +24,13 @@ describe('create command', () => {
     exitMock = jest.spyOn(process, 'exit').mockImplementation((code) => {
       throw new Error(`process.exit(${code})`);
     });
+    logMock = jest.spyOn(console, 'log').mockImplementation();
     errorMock = jest.spyOn(console, 'error').mockImplementation();
   });
 
   afterEach(async () => {
     await fs.rm(tempDir, { recursive: true, force: true });
+    logMock.mockRestore();
     exitMock.mockRestore();
     errorMock.mockRestore();
   });

src/seed_tools/commands/lint.test.ts

@@ -16,18 +16,21 @@ describe('lint command', () => {
 
   let tempDir: string;
   let exitMock: jest.SpyInstance;
+  let logMock: jest.SpyInstance;
   let errorMock: jest.SpyInstance;
 
   beforeEach(async () => {
     tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'create_seed-'));
     exitMock = jest.spyOn(process, 'exit').mockImplementation((code) => {
       throw new Error(`process.exit(${code})`);
     });
+    logMock = jest.spyOn(console, 'log').mockImplementation();
     errorMock = jest.spyOn(console, 'error').mockImplementation();
   });
 
   afterEach(async () => {
     await fs.rm(tempDir, { recursive: true, force: true });
+    logMock.mockRestore();
     exitMock.mockRestore();
     errorMock.mockRestore();
   });
@@ -86,8 +89,8 @@ describe('lint command', () => {
         // copy the unformatted studies to a temp dir
         await fs.mkdir(tempStudiesDir);
         await fs.copyFile(
-          path.join(studiesDir, 'TestStudy.json'),
-          path.join(tempStudiesDir, 'TestStudy.json'),
+          path.join(studiesDir, 'TestStudy.json5'),
+          path.join(tempStudiesDir, 'TestStudy.json5'),
         );
 
         // lint should fail.

src/seed_tools/commands/split_seed_json.ts

@@ -48,7 +48,7 @@ async function main(seedPath: string, outputDir: string) {
   for (const study of studies) {
     const studyName = study[0];
     const studyArray = study[1];
-    const studyFile = `${outputDir}/${studyName}.json`;
+    const studyFile = `${outputDir}/${studyName}.json5`;
     await study_json_utils.writeStudyFile(studyArray, studyFile);
   }
 }