feat(config): add support for JSONC configuration files and update tests

Author: Erwan-loot

lib/config/app-strings.ts

@@ -1,12 +1,16 @@
 export const configFileNames = [
   'renovate.json',
   'renovate.json5',
+  'renovate.jsonc',
   '.github/renovate.json',
   '.github/renovate.json5',
+  '.github/renovate.jsonc',
   '.gitlab/renovate.json',
   '.gitlab/renovate.json5',
+  '.gitlab/renovate.jsonc',
   '.renovaterc',
   '.renovaterc.json',
   '.renovaterc.json5',
+  '.renovaterc.jsonc',
   'package.json',
 ];

lib/config/parse.spec.ts

@@ -56,4 +56,37 @@ describe('config/parse', () => {
       });
     });
   });
+
+  describe('jsonc', () => {
+    it('parses', () => {
+      expect(parseFileConfig('config.jsonc', '{}')).toEqual({
+        success: true,
+        parsedContents: {},
+      });
+    });
+
+    it('parses with comments', () => {
+      const jsoncContent = `{
+        // This is a comment
+        "extends": ["config:base"],
+        "enabled": true // Another comment
+      }`;
+      expect(parseFileConfig('config.jsonc', jsoncContent)).toEqual({
+        success: true,
+        parsedContents: {
+          extends: ['config:base'],
+          enabled: true,
+        },
+      });
+    });
+
+    it('returns error', () => {
+      expect(parseFileConfig('config.jsonc', '{')).toEqual({
+        success: false,
+        validationError: 'Invalid JSONC (parsing failed)',
+        validationMessage:
+          'JSONC.parse error: `Invalid JSONC`',
+      });
+    });
+  });
 });

lib/config/parse.ts

@@ -28,6 +28,22 @@ export function parseFileConfig(
         validationMessage,
       };
     }
+  } else if (fileType === '.jsonc') {
+    try {
+      return { success: true, parsedContents: parseJson(fileContents, fileName) };
+    } catch (err) {
+      logger.debug({ fileName, fileContents }, 'Error parsing JSONC file');
+      const validationError = 'Invalid JSONC (parsing failed)';
+      const validationMessage = `JSONC.parse error: \`${err.message.replaceAll(
+        '`',
+        "'",
+      )}\``;
+      return {
+        success: false,
+        validationError,
+        validationMessage,
+      };
+    }
   } else {
     let allowDuplicateKeys = true;
     let jsonValidationError = jsonValidator.validate(

lib/workers/global/config/parse/file.ts

@@ -21,6 +21,7 @@ export async function getParsedContent(file: string): Promise<RenovateConfig> {
     case '.yml':
       return parseSingleYaml(await readSystemFile(file, 'utf8'));
     case '.json5':
+    case '.jsonc':
     case '.json':
       return parseJson(
         await readSystemFile(file, 'utf8'),

lib/workers/repository/init/merge.spec.ts

@@ -199,6 +199,19 @@ describe('workers/repository/init/merge', () => {
       });
     });
 
+    it('finds and parse renovate.jsonc', async () => {
+      const configFileRaw = `{
+        // this is jsonc format with comments
+        "extends": ["config:base"]
+      }`;
+      scm.getFileList.mockResolvedValue(['package.json', 'renovate.jsonc']);
+      fs.readLocalFile.mockResolvedValue(configFileRaw);
+      expect(await detectRepoFileConfig()).toEqual({
+        configFileName: 'renovate.jsonc',
+        configFileParsed: { extends: ['config:base'] },
+      });
+    });
+
     it('finds .github/renovate.json', async () => {
       scm.getFileList.mockResolvedValue([
         'package.json',
@@ -223,6 +236,36 @@ describe('workers/repository/init/merge', () => {
       });
     });
 
+    it('finds .github/renovate.jsonc', async () => {
+      scm.getFileList.mockResolvedValue([
+        'package.json',
+        '.github/renovate.jsonc',
+      ]);
+      fs.readLocalFile.mockResolvedValue(`{
+        // JSONC config with comments
+        "extends": ["config:base"]
+      }`);
+      expect(await detectRepoFileConfig()).toEqual({
+        configFileName: '.github/renovate.jsonc',
+        configFileParsed: { extends: ['config:base'] },
+      });
+    });
+
+    it('finds .gitlab/renovate.jsonc', async () => {
+      scm.getFileList.mockResolvedValue([
+        'package.json',
+        '.gitlab/renovate.jsonc',
+      ]);
+      fs.readLocalFile.mockResolvedValue(`{
+        // JSONC config with comments  
+        "enabled": true
+      }`);
+      expect(await detectRepoFileConfig()).toEqual({
+        configFileName: '.gitlab/renovate.jsonc',
+        configFileParsed: { enabled: true },
+      });
+    });
+
     it('finds .renovaterc.json', async () => {
       scm.getFileList.mockResolvedValue(['package.json', '.renovaterc.json']);
       fs.readLocalFile.mockResolvedValue('{}');