Web 1146 shared helpers

src/analyse/adapt-dependencies/adapt-dependencies.ts

@@ -9,18 +9,18 @@ import type { Module, PackageAfterDetermineVersion } from '../../types';
 import { logger } from '../../helpers/logger';
 
 import { getReleasablePackages } from '../../helpers/get-releasable-packages';
+import { missingEnvAttrError } from '../../helpers/validation-errors';
 
+const topic = '[analyse] adapt dependencies';
 const { error, log } = logger('[analyse] adapt dependencies');
 
 export const adaptDependencies: Module = (env) => {
   if (!env.packages) {
-    const errorMessage = 'missing "packages" on env object.';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
   log('analyse affected packages');
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
   const releasablePackages = getReleasablePackages(clone(clonePackages));
 
   log(`${Object.keys(releasablePackages).length} packages will be released`);

src/analyse/add-dependencies.ts

@@ -8,19 +8,19 @@ import {
 } from '../types';
 
 import { logger } from '../helpers/logger';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] add dependencies');
+const topic = '[analyse] add dependencies';
+const { log } = logger(topic);
 
 export const addDependencies: Module = (env) => {
   log("Populating packages' dependencies");
 
   if (!env.packages) {
-    const errorMessage = '"packages" attribute not found on env config object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
-  const envPackages = clone(env.packages);
+  const envPackages = clone(env.packages!);
 
   const packagesNames = Object.keys(envPackages);
 

src/analyse/add-messages-to-packages.ts

@@ -3,25 +3,24 @@ import { clone } from 'ramda';
 import type { Module } from '../types';
 
 import { logger } from '../helpers/logger';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] add messages to packages');
+const topic = '[analyse] add messages to packages';
+const { error, log } = logger(topic);
 
 export const addMessagesToPackages: Module = (env) => {
   if (!env.commitMessages) {
-    const errorMessage = 'missing "commitMessages" on env object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('commitMessages', topic);
   }
+
   if (!env.packages) {
-    const errorMessage = 'missing "packages" on env object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
   log('Register messages to packages');
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
 
-  env.commitMessages.forEach((commitMessage) => {
+  env.commitMessages!.forEach((commitMessage) => {
     commitMessage.affectedPackages?.forEach((affectedPackage) => {
       if (!clonePackages[affectedPackage]) {
         const errorMessage = `"${affectedPackage}" is not a valid (registered) package`;

src/analyse/add-package-names-to-messages/add-package-names-to-messages.ts

@@ -6,20 +6,20 @@ import type { Module } from '../../types';
 import { logger } from '../../helpers/logger';
 
 import { findPackageName } from './find-package-name';
+import { missingEnvAttrError } from '../../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] add package names to messages');
+const topic = '[analyse] add package names to messages';
+const { log } = logger(topic);
 
 export const addPackageNamesToMessages: Module = (env) => {
   if (!env.commitMessages) {
-    const errorMessage = 'missing "commitMessages" on env object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('commitMessages', topic);
   }
 
   log('Analyse affected packages per commit');
   const userAffectedPackages = new Set<string>();
 
-  const cloneCommitMessages = clone(env.commitMessages);
+  const cloneCommitMessages = clone(env.commitMessages!);
 
   cloneCommitMessages.forEach((commitMessage) => {
     const affectedPackages = new Set<string>();

src/analyse/add-package-names-to-messages/spec/add-package-names-to-messages.spec.ts

@@ -42,7 +42,7 @@ describe('addPackageNamesToMessages Module', () => {
   });
 
   it('throws an exception if env config object has no "commitMessages"', () => {
-    const expectedErrorMessage = 'missing "commitMessages" on env object';
+    const expectedErrorMessage = 'missing "commitMessages" on env object.';
     expect(() => addPackageNamesToMessages(envWithConfig)).toThrow(
       expectedErrorMessage
     );

src/analyse/create-dependency-tree.ts

@@ -4,17 +4,17 @@ import { yellow } from 'chalk';
 import { Module } from '../types';
 
 import { logger } from '../helpers/logger';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] create dependency tree');
+const topic = '[analyse] create dependency tree';
+const { log } = logger('[analyse] create dependency tree');
 
 export const createDependencyTree: Module = (env) => {
   if (!env.packages) {
-    const errorMessage = 'no packages found on env config object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
-  const packagesClone = clone(env.packages);
+  const packagesClone = clone(env.packages!);
   const counter = {
     default: 0,
     devDependencies: 0,

src/analyse/create-package-json-content/create-package-json-content.ts

@@ -10,19 +10,19 @@ import type {
 import { logger } from '../../helpers/logger';
 
 import { getPackageJson } from './get-package-json';
+import { missingEnvAttrError } from '../../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] create package json content');
+const topic = '[analyse] create package json content';
+const { log } = logger(topic);
 
 export const createPackageJsonContent: Module = (env) => {
   if (!env.packages) {
-    const errorMessage = 'missing "packages" on env object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
   log('analyse packageJson Content');
 
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
 
   Object.keys(clonePackages).forEach((packageName) => {
     log(`generating git & npm package.json files for "${white(packageName)}"`);

src/analyse/create-package-json-content/spec/create-package-json-content.spec.ts

@@ -66,7 +66,7 @@ describe('createPackageJsonContent Module', () => {
   });
 
   it('throws an error when "packages" is missing on Env config object', () => {
-    const expectedErrorMessage = 'missing "packages" on env object';
+    const expectedErrorMessage = 'missing "packages" on env object.';
     expect(() => createPackageJsonContent(envWithConfig)).toThrow(
       expectedErrorMessage
     );

src/analyse/determine-direct-increment.ts

@@ -4,8 +4,10 @@ import { green, red, yellow, white } from 'chalk';
 import type { Package, Message, Module } from '../types';
 
 import { logger } from '../helpers/logger';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] determine direct increment');
+const topic = '[analyse] determine direct increment';
+const { log } = logger(topic);
 
 const mapLevelToIncrementLevel: Record<
   Message['level'],
@@ -28,21 +30,18 @@ const mapLevelToColour: Record<
 
 export const determineDirectIncrement: Module = (env) => {
   if (!env.commitMessages) {
-    const errorMessage = '"commitMessage" not present on env config object.';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('commitMessages', topic);
   }
+
   if (!env.packages) {
-    const errorMessage = '"packages" not present on env config object.';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
   const packagesToRelease: Record<string, Message['level']> = {};
 
   log('analyse registered commitMessages');
-  env.commitMessages.forEach((commitMessage) => {
+  env.commitMessages!.forEach((commitMessage) => {
     commitMessage.affectedPackages?.forEach((affectedPackageName) => {
       const affectedPackage = clonePackages[affectedPackageName];
 

src/analyse/determine-version.ts

@@ -5,6 +5,7 @@ import { green, red, yellow, white } from 'chalk';
 import { logger } from '../helpers/logger';
 
 import type { Module, PackageAfterDetermineVersion } from '../types';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
 const mapLevelToColour: Record<
   PackageAfterDetermineVersion['determinedIncrementLevel'],
@@ -19,18 +20,17 @@ const mapLevelToColour: Record<
   2: ['major', red],
 };
 
-const { error, log } = logger('[analyse] determine Version');
+const topic = '[analyse] determine Version';
+const { error, log } = logger(topic);
 
 export const determineVersion: Module = (env) => {
   if (!env.packages) {
-    const errorMessage = 'missing "packages" on env object.';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
 
   log('analyse packages');
 
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
 
   const incrementLevels: semver.ReleaseType[] = ['patch', 'minor', 'major'];
 

src/analyse/prepare-changelogs.ts

@@ -20,17 +20,16 @@ import type {
 import { logger } from '../helpers/logger';
 
 import { getReleasablePackages } from '../helpers/get-releasable-packages';
+import { missingEnvAttrError } from '../helpers/validation-errors';
 
-const { error, log } = logger('[analyse] prepare changelogs');
+const topic = '[analyse] prepare changelogs';
+const { error, log } = logger(topic);
 
 export const prepareChangelogs: Module = (env) => {
   if (!env.packages) {
-    const errorMessage = '"packages" attribute not found on env config object';
-    error(errorMessage);
-    throw new Error(errorMessage);
+    missingEnvAttrError('packages', topic);
   }
-
-  const clonePackages = clone(env.packages);
+  const clonePackages = clone(env.packages!);
   const releasablePackages = getReleasablePackages(clonePackages);
 
   const changelogDate = `${getWeekNumber(new Date()).join('-')}`;

src/analyse/spec/add-dependencies.spec.ts

@@ -55,8 +55,7 @@ describe('addDependencies Module', () => {
   });
 
   it("Throws an exception if 'env.packages' is empty", () => {
-    const expectedErrorMessage =
-      '"packages" attribute not found on env config object';
+    const expectedErrorMessage = 'missing "packages" on env object.';
 
     expect(() => addDependencies(envWithConfig)).toThrow(expectedErrorMessage);
 

src/analyse/spec/add-messages-to-packages.spec.ts

@@ -70,7 +70,7 @@ describe('addMessagesToPackages module', () => {
   });
 
   it('throws an error when "commitMessages" is missing on Env config object', () => {
-    const expectedErrorMessage = 'missing "commitMessages" on env object';
+    const expectedErrorMessage = 'missing "commitMessages" on env object.';
     expect(() => addMessagesToPackages(envWithoutCommitMessages)).toThrow(
       expectedErrorMessage
     );
@@ -79,7 +79,7 @@ describe('addMessagesToPackages module', () => {
   });
 
   it('throws an error when "packages" is missing on Env config object', () => {
-    const expectedErrorMessage = 'missing "packages" on env object';
+    const expectedErrorMessage = 'missing "packages" on env object.';
     expect(() => addMessagesToPackages(envWithoutPackages)).toThrow(
       expectedErrorMessage
     );

src/analyse/spec/create-dependency-tree.spec.ts

@@ -46,7 +46,7 @@ describe('[analyse] createDependencyTree module', () => {
   });
 
   it('throws an exception when "env.packages" is not defined', () => {
-    const expectedError = 'no packages found on env config object';
+    const expectedError = 'missing "packages" on env object.';
     expect(() => createDependencyTree(envWithConfig)).toThrow(expectedError);
     expect(mockError).toHaveBeenCalledTimes(1);
     expect(mockError).toHaveBeenCalledWith(expectedError);

src/analyse/spec/determine-direct-increment.spec.ts

@@ -18,15 +18,10 @@ jest.doMock('chalk', () => ({
 }));
 
 // mock logger
-const mockError = jest.fn();
 const mockLog = jest.fn();
-const mockLogger = jest.fn(() => ({
-  error: mockError,
-  log: mockLog,
-}));
-jest.doMock('../../helpers/logger', () => ({
-  logger: mockLogger,
-}));
+const mockError = jest.fn();
+const mockLogger = jest.fn(() => ({ log: mockLog, error: mockError }));
+jest.doMock('../../helpers/logger', () => ({ logger: mockLogger }));
 
 // mock Packages
 const mockPackageBuilder = (id: number): Package => ({
@@ -79,7 +74,7 @@ describe('determineDirectIncrement Module', () => {
   });
 
   it('throws an error if "commitMessage" is not present on env Config Object', () => {
-    const expectedError = '"commitMessage" not present on env config object.';
+    const expectedError = 'missing "commitMessages" on env object.';
     const mockEnv: Env = { ...envWithConfig };
 
     expect(() => determineDirectIncrement(mockEnv)).toThrow(expectedError);
@@ -89,7 +84,7 @@ describe('determineDirectIncrement Module', () => {
   });
 
   it('throws an error if "packages" is not present on env Config Object', () => {
-    const expectedError = '"packages" not present on env config object.';
+    const expectedError = 'missing "packages" on env object.';
     const mockEnv: Env = { ...envWithConfig, commitMessages: [] };
 
     expect(() => determineDirectIncrement(mockEnv)).toThrow(expectedError);

src/analyse/spec/prepare-changelogs.spec.ts

@@ -128,8 +128,7 @@ describe('prepareChangelogs Module', () => {
   });
 
   it('throws an error when "packages" is missing on Env config object', () => {
-    const expectedErrorMessage =
-      '"packages" attribute not found on env config object';
+    const expectedErrorMessage = 'missing "packages" on env object.';
     expect(() => prepareChangelogs(envWithConfig)).toThrow(
       expectedErrorMessage
     );

src/change/spec/write-main-changelog.spec.ts

@@ -69,8 +69,7 @@ describe('writeMainChangelog Module', () => {
   });
 
   it('throws an error when "changelogPath" is missing on Env config object', () => {
-    const expectedErrorMessage =
-      '"changelogPath" attribute not found on env config object';
+    const expectedErrorMessage = 'missing "changelogPath" on env object.';
 
     const invalidEnvConfig = clone(envWithConfig);
     invalidEnvConfig.config!.changelogPath = '';

src/change/spec/write-package-changelogs.spec.ts

@@ -12,7 +12,12 @@ import type {
 // mock logger
 const mockLog = jest.fn();
 const mockError = jest.fn();
-const mockLogger = jest.fn(() => ({ log: mockLog, error: mockError }));
+const mockThrowMissingAttrError = jest.fn();
+const mockLogger = jest.fn(() => ({
+  log: mockLog,
+  error: mockError,
+  throwMissingAttrError: mockThrowMissingAttrError,
+}));
 jest.doMock('../../helpers/logger', () => ({ logger: mockLogger }));
 
 jest.mock('fs');
@@ -64,9 +69,8 @@ describe('writePackageChangelogs Module', () => {
     jest.clearAllMocks();
   });
 
-  it('throws an error when "packages" is missing on Env config object', () => {
-    const expectedErrorMessage =
-      '"packages" attribute not found on env config object';
+  it.only('throws an error when "packages" is missing on Env config object', () => {
+    const expectedErrorMessage = 'missing "packages" on env object.';
 
     expect(() => writePackageChangelogs(envWithConfig)).toThrow(
       expectedErrorMessage