throw if field does not exists

Author: shortcuts

scripts/__tests__/common.test.ts

@@ -1,6 +1,7 @@
 import execa from 'execa';
 
 import { gitCommit } from '../common';
+import { getClientsConfigField } from '../config';
 
 jest.mock('execa');
 
@@ -51,3 +52,27 @@ describe('gitCommit', () => {
     );
   });
 });
+
+describe('config', () => {
+  describe('getClientsConfigField', () => {
+    it('throws if the field is not found', () => {
+      expect(() => {
+        getClientsConfigField('javascript', 'packageVersion');
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Unable to find 'packageVersion' for 'javascript'"`
+      );
+
+      expect(() => {
+        getClientsConfigField('java', 'utilsPackageVersion');
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Unable to find 'utilsPackageVersion' for 'java'"`
+      );
+    });
+
+    it('find the field if it exists', () => {
+      expect(getClientsConfigField('java', ['tests', 'extension'])).toEqual(
+        '.test.java'
+      );
+    });
+  });
+});

scripts/config.ts

@@ -1,30 +1,46 @@
 import clientsConfig from '../config/clients.config.json';
 import openapiConfig from '../config/openapitools.json';
 
-import type { Language } from './types';
+import type { Language, LanguageConfig } from './types';
+
+export function getClientsConfigField(
+  language: Language,
+  pathToField: string[] | string
+): any {
+  const config: LanguageConfig = clientsConfig[language];
+  const path = Array.isArray(pathToField) ? pathToField : [pathToField];
+
+  return path.reduce((current, key) => {
+    if (!current || !current[key]) {
+      throw new Error(`Unable to find '${pathToField}' for '${language}'`);
+    }
+
+    return current[key];
+  }, config);
+}
 
 export function getLanguageFolder(language: Language): string {
-  return clientsConfig[language].folder;
+  return getClientsConfigField(language, 'folder');
 }
 
 export function getLanguageApiFolder(language: Language): string {
-  return clientsConfig[language].apiFolder;
+  return getClientsConfigField(language, 'apiFolder');
 }
 
 export function getLanguageModelFolder(language: Language): string {
-  return clientsConfig[language].modelFolder;
+  return getClientsConfigField(language, 'modelFolder');
 }
 
 export function getTestExtension(language: Language): string {
-  return clientsConfig[language].tests.extension;
+  return getClientsConfigField(language, ['tests', 'extension']);
 }
 
 export function getTestOutputFolder(language: Language): string {
-  return clientsConfig[language].tests.outputFolder;
+  return getClientsConfigField(language, ['tests', 'outputFolder']);
 }
 
 export function getCustomGenerator(language: Language): string {
-  return clientsConfig[language].customGenerator;
+  return getClientsConfigField(language, 'customGenerator');
 }
 
 /**
@@ -35,20 +51,8 @@ export function getPackageVersionDefault(language: Language): string {
     return openapiConfig['generator-cli'].generators['javascript-search']
       .additionalProperties.packageVersion;
   }
-  return clientsConfig[language].packageVersion;
-}
-
-/**
- * Returns the value of the `utilsPackageVersion`.
- *
- * Currently supported languages other than `javascript` does not have a utils package.
- */
-export function getUtilsPackageVersionDefault(language: Language): string {
-  if (language !== 'javascript') {
-    return '';
-  }
 
-  return clientsConfig[language].utilsPackageVersion;
+  return getClientsConfigField(language, 'packageVersion');
 }
 
 export function getGitHubUrl(

scripts/release/process-release.ts

@@ -21,10 +21,10 @@ import {
   LANGUAGES,
 } from '../common';
 import {
+  getClientsConfigField,
   getGitHubUrl,
   getLanguageFolder,
   getPackageVersionDefault,
-  getUtilsPackageVersionDefault,
 } from '../config';
 import type { Language } from '../types';
 
@@ -141,11 +141,20 @@ async function updateVersionForJavascript(
   );
 
   // Sets the new version of the utils package
-  const nextUtilsPackageVersion =
-    semver.inc(
-      getUtilsPackageVersionDefault('javascript'),
-      jsVersion.releaseType
-    ) || '';
+  const utilsPackageVersion = getClientsConfigField(
+    'javascript',
+    'utilsPackageVersion'
+  );
+  const nextUtilsPackageVersion = semver.inc(
+    utilsPackageVersion,
+    jsVersion.releaseType
+  );
+
+  if (!nextUtilsPackageVersion) {
+    throw new Error(
+      `Failed to bump version ${utilsPackageVersion} by ${jsVersion.releaseType}.`
+    );
+  }
 
   clientsConfig.javascript.utilsPackageVersion = nextUtilsPackageVersion;
   await fsp.writeFile(

scripts/types.ts

@@ -1,5 +1,24 @@
 import type config from '../config/clients.config.json';
 
+/**
+ * Config.
+ */
+export type ClientsConfig = Record<Language, LanguageConfig>;
+
+export type LanguageConfig = {
+  folder: string;
+  gitRepoId: string;
+  modelFolder: string;
+  apiFolder: string;
+  customGenerator: string;
+  packageVersion?: string;
+  utilsPackageVersion?: string;
+  tests: {
+    extension: string;
+    outputFolder: string;
+  };
+};
+
 export type Generator = Record<string, any> & {
   language: Language;
   client: string;