feat: run prettier on migratedJSON

lib/workers/repository/config-migration/branch/__fixtures__/migrated-data-formatted.json

@@ -0,0 +1,4 @@
+{
+  "filename": "renovate.json",
+  "content": "{\n  \"extends\": [\n    \":separateMajorReleases\",\n    \":prImmediately\",\n    \":renovatePrefix\",\n    \":semanticPrefixFixDepsChoreOthers\",\n    \":updateNotScheduled\",\n    \":automergeDisabled\",\n    \":maintainLockFilesDisabled\",\n    \":autodetectPinVersions\",\n    \"group:monorepos\"\n  ],\n  \"onboarding\": false,\n  \"rangeStrategy\": \"replace\",\n  \"semanticCommits\": \"enabled\",\n  \"timezone\": \"US/Central\",\n  \"baseBranches\": [\"main\"]\n}\n"
+}

lib/workers/repository/config-migration/branch/migrated-data.spec.ts

@@ -4,10 +4,12 @@ import { mockedFunction } from '../../../../../test/util';
 
 import { migrateConfig } from '../../../../config/migration';
 import { readLocalFile } from '../../../../util/fs';
+import { getFileList } from '../../../../util/git';
 import { detectRepoFileConfig } from '../../init/merge';
-import { MigratedDataFactory } from './migrated-data';
+import { MigratedDataFactory, applyPrettierFormatting } from './migrated-data';
 
 jest.mock('../../../../config/migration');
+jest.mock('../../../../util/git');
 jest.mock('../../../../util/fs');
 jest.mock('../../init/merge');
 jest.mock('detect-indent');
@@ -17,6 +19,9 @@ const rawNonMigratedJson5 = Fixtures.get('./renovate.json5');
 const migratedData = Fixtures.getJson('./migrated-data.json');
 const migratedDataJson5 = Fixtures.getJson('./migrated-data.json5');
 const migratedConfigObj = Fixtures.getJson('./migrated.json');
+const formattedMigratedData = Fixtures.getJson(
+  './migrated-data-formatted.json'
+);
 
 describe('workers/repository/config-migration/branch/migrated-data', () => {
   describe('MigratedDataFactory.getAsync', () => {
@@ -35,6 +40,7 @@ describe('workers/repository/config-migration/branch/migrated-data', () => {
         isMigrated: true,
         migratedConfig: migratedConfigObj,
       });
+      mockedFunction(getFileList).mockResolvedValue([]);
     });
 
     it('Calls getAsync a first when migration not needed', async () => {
@@ -110,5 +116,38 @@ describe('workers/repository/config-migration/branch/migrated-data', () => {
       MigratedDataFactory.reset();
       await expect(MigratedDataFactory.getAsync()).resolves.toBeNull();
     });
+
+    it('format and migrate a JSON config file', async () => {
+      mockedFunction(detectRepoFileConfig).mockResolvedValueOnce({
+        configFileName: 'renovate.json',
+      });
+      mockedFunction(readLocalFile).mockResolvedValueOnce(rawNonMigrated);
+      mockedFunction(getFileList).mockResolvedValue(['.prettierrc']);
+      MigratedDataFactory.reset();
+      await expect(MigratedDataFactory.getAsync()).resolves.toEqual(
+        formattedMigratedData
+      );
+    });
+
+    it('should not stop run for invalid package.json', async () => {
+      mockedFunction(detectRepoFileConfig).mockResolvedValueOnce({
+        configFileName: 'renovate.json',
+      });
+      mockedFunction(readLocalFile).mockResolvedValueOnce(rawNonMigrated);
+      mockedFunction(readLocalFile).mockResolvedValue('abci');
+      MigratedDataFactory.reset();
+      await expect(MigratedDataFactory.getAsync()).resolves.toEqual(
+        migratedData
+      );
+    });
+
+    it('return original content if its invalid', async () => {
+      await expect(
+        applyPrettierFormatting(`{"name":"Rahul"`, 'json', {
+          indent: '  ',
+          amount: 2,
+        })
+      ).resolves.toBe(`{"name":"Rahul"`);
+    });
   });
 });

lib/workers/repository/config-migration/branch/migrated-data.ts

@@ -1,14 +1,62 @@
 import detectIndent from 'detect-indent';
 import JSON5 from 'json5';
+import prettier from 'prettier';
 import { migrateConfig } from '../../../../config/migration';
 import { logger } from '../../../../logger';
 import { readLocalFile } from '../../../../util/fs';
+import { getFileList } from '../../../../util/git';
 import { detectRepoFileConfig } from '../../init/merge';
 
 export interface MigratedData {
   content: string;
   filename: string;
 }
+interface Indent {
+  amount: number;
+  indent: string;
+  type?: string;
+}
+export async function applyPrettierFormatting(
+  content: string,
+  parser: string,
+  indent: Indent
+): Promise<string> {
+  const prettierConfigFilenames = [
+    '.prettierrc',
+    '.prettierrc.json',
+    '.prettierrc.yml',
+    '.prettierrc.yaml',
+    '.prettierrc.json5',
+    '.prettierrc.js',
+    '.prettierrc.cjs',
+    'prettier.config.js',
+    'prettier.config.cjs',
+    '.prettierrc.toml',
+  ];
+  let prettierExists = (await getFileList()).some((file) =>
+    prettierConfigFilenames.includes(file)
+  );
+  if (!prettierExists) {
+    try {
+      const packageJsonContent = await readLocalFile('package.json', 'utf8');
+      prettierExists ||=
+        packageJsonContent && JSON.parse(packageJsonContent).prettier;
+    } catch {
+      logger.warn('Invalid JSON found in package.json');
+    }
+  }
+
+  if (!prettierExists) {
+    return content;
+  }
+  const options = {
+    parser: parser,
+    tabWidth: indent.amount,
+    useTabs: indent.type === 'tab',
+  };
+
+  return prettier.format(content, options);
+}
 
 export class MigratedDataFactory {
   // singleton
@@ -52,15 +100,28 @@ export class MigratedDataFactory {
 
       // indent defaults to 2 spaces
       // TODO #7154
-      const indent = detectIndent(raw!).indent ?? '  ';
+      const indent = detectIndent(raw!);
       let content: string;
 
       if (filename.endsWith('.json5')) {
-        content = JSON5.stringify(migratedConfig, undefined, indent);
+        content = JSON5.stringify(
+          migratedConfig,
+          undefined,
+          indent.indent ?? '  '
+        );
       } else {
-        content = JSON.stringify(migratedConfig, undefined, indent);
+        content = JSON.stringify(
+          migratedConfig,
+          undefined,
+          indent.indent ?? '  '
+        );
       }
 
+      content = await applyPrettierFormatting(
+        content,
+        filename.endsWith('.json5') ? 'json5' : 'json',
+        indent
+      );
       if (!content.endsWith('\n')) {
         content += '\n';
       }

package.json

@@ -197,6 +197,7 @@
     "p-map": "4.0.0",
     "p-queue": "6.6.2",
     "parse-link-header": "2.0.0",
+    "prettier": "2.7.1",
     "redis": "4.1.1",
     "remark": "13.0.0",
     "remark-github": "10.1.0",
@@ -291,7 +292,6 @@
     "mockdate": "3.0.5",
     "nock": "13.2.8",
     "npm-run-all": "4.1.5",
-    "prettier": "2.7.1",
     "pretty-quick": "3.1.3",
     "rimraf": "3.0.2",
     "semantic-release": "19.0.3",