refactor: prefer fs.readJSON over readFile.then(JSON.parse) (#7186)

* refactor: prefer fs.readJSON over readFile.then(JSON.parse)

* refactor: use promises

__tests__/validate-package-json.test.ts

@@ -27,12 +27,8 @@ type PackageJsonFile = {
 
 async function getPackagesJsonFiles(): Promise<PackageJsonFile[]> {
   const files = await Globby('packages/*/package.json');
-
   return Promise.all(
-    files.map(async (file) => ({
-      file,
-      content: JSON.parse(await fs.readFile(file, 'utf8')),
-    })),
+    files.map((file) => fs.readJSON(file).then((content) => ({file, content}))),
   );
 }
 

admin/scripts/generateExamples.mjs

@@ -37,8 +37,8 @@ async function generateTemplateExample(template) {
     );
 
     // read the content of the package.json
-    const templatePackageJson = JSON.parse(
-      await fs.readFile(`examples/${template}/package.json`, 'utf8'),
+    const templatePackageJson = await fs.readJSON(
+      `examples/${template}/package.json`,
     );
 
     // attach the dev script which would be used in code sandbox by default

packages/create-docusaurus/src/index.ts

@@ -103,8 +103,7 @@ function isValidGitRepoUrl(gitRepoUrl: string) {
 }
 
 async function updatePkg(pkgPath: string, obj: {[key: string]: unknown}) {
-  const content = await fs.readFile(pkgPath, 'utf-8');
-  const pkg = JSON.parse(content);
+  const pkg = await fs.readJSON(pkgPath);
   const newPkg = Object.assign(pkg, obj);
 
   await fs.outputFile(pkgPath, `${JSON.stringify(newPkg, null, 2)}\n`);

packages/docusaurus-migrate/src/index.ts

@@ -443,8 +443,8 @@ async function migrateBlogFiles(context: MigrationContext) {
 async function handleVersioning(context: MigrationContext) {
   const {siteDir, newDir} = context;
   if (await fs.pathExists(path.join(siteDir, 'versions.json'))) {
-    const loadedVersions: string[] = JSON.parse(
-      await fs.readFile(path.join(siteDir, 'versions.json'), 'utf-8'),
+    const loadedVersions: string[] = await fs.readJSON(
+      path.join(siteDir, 'versions.json'),
     );
     await fs.copyFile(
       path.join(siteDir, 'versions.json'),
@@ -542,7 +542,7 @@ async function migrateVersionedSidebar(
         `version-${version}-sidebars.json`,
       );
       try {
-        sidebarEntries = JSON.parse(await fs.readFile(sidebarPath, 'utf-8'));
+        sidebarEntries = await fs.readJSON(sidebarPath);
       } catch {
         sidebars.push({version, entries: sidebars[i - 1]!.entries});
         return;

packages/docusaurus-theme-translations/locales/__tests__/locales.test.ts

@@ -17,20 +17,22 @@ jest.setTimeout(15000);
 describe('theme translations', () => {
   it('has base messages files contain EXACTLY all the translations extracted from the theme. Please run "yarn workspace @docusaurus/theme-translations update" to keep base messages files up-to-date', async () => {
     const baseMessagesDirPath = path.join(__dirname, '../base');
-    const baseMessages = Object.fromEntries(
-      await Promise.all(
-        (
-          await fs.readdir(baseMessagesDirPath)
-        ).map(async (baseMessagesFile) =>
-          Object.entries(
-            (await fs.readJSON(
-              path.join(baseMessagesDirPath, baseMessagesFile),
-              'utf-8',
-            )) as {[key: string]: string},
+    const baseMessages = await fs
+      .readdir(baseMessagesDirPath)
+      .then((files) =>
+        Promise.all(
+          files.map(
+            (baseMessagesFile): Promise<{[key: string]: string}> =>
+              fs.readJSON(path.join(baseMessagesDirPath, baseMessagesFile)),
           ),
         ),
-      ).then((translations) =>
-        translations.flat().filter(([key]) => !key.endsWith('___DESCRIPTION')),
+      )
+      .then((translations) =>
+        Object.fromEntries(
+          translations
+            .map(Object.entries)
+            .flat()
+            .filter(([key]) => !key.endsWith('___DESCRIPTION')),
         ),
       );
     const codeMessages = _.mapValues(

packages/docusaurus-theme-translations/src/index.ts

@@ -50,8 +50,7 @@ export async function readDefaultCodeTranslationMessages({
     const filePath = path.resolve(dirPath, localeToTry, `${name}.json`);
 
     if (await fs.pathExists(filePath)) {
-      const fileContent = await fs.readFile(filePath, 'utf8');
-      return JSON.parse(fileContent);
+      return fs.readJSON(filePath);
     }
   }
 

packages/docusaurus-theme-translations/update.mjs

@@ -55,7 +55,7 @@ async function readMessagesFile(filePath) {
     logger.info`File path=${filePath} not found. Creating new translation base file.`;
     await fs.outputFile(filePath, '{}\n');
   }
-  return JSON.parse((await fs.readFile(filePath)).toString());
+  return fs.readJSON(filePath);
 }
 
 /**

packages/docusaurus/src/client/serverEntry.tsx

@@ -111,9 +111,7 @@ async function doRender(locals: Locals & {path: string}) {
 
   const {generatedFilesDir} = locals;
   const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
-  const manifest: Manifest = JSON.parse(
-    await fs.readFile(manifestPath, 'utf8'),
-  );
+  const manifest: Manifest = await fs.readJSON(manifestPath);
 
   // Get all required assets for this particular page based on client
   // manifest information.

packages/docusaurus/src/server/translations/translations.ts

@@ -58,7 +58,7 @@ async function readTranslationFileContent(
 ): Promise<TranslationFileContent | undefined> {
   if (await fs.pathExists(filePath)) {
     try {
-      const content = JSON.parse(await fs.readFile(filePath, 'utf8'));
+      const content = await fs.readJSON(filePath);
       ensureTranslationFileContent(content);
       return content;
     } catch (err) {