chore: 🤖 migrate to esm (#177)

BREAKING CHANGE: 🧨 The lib is now ESM

Author: kekel87

__tests__/buildTranslationFiles.spec.ts

@@ -1,16 +1,27 @@
 import fs from 'fs-extra';
-import {jest} from '@jest/globals';
+import { jest } from '@jest/globals';
 
-import { buildTranslationFiles } from '../src/keys-builder';
-import { getCurrentTranslation } from '../src/keys-builder/utils/get-current-translation';
 import { resetScopes } from '../src/keys-builder/utils/scope.utils';
 import { messages } from '../src/messages';
 import { Config, FileFormats, Translation } from '../src/types';
-import { resolveProjectBasePath } from '../src/utils/resolve-project-base-path';
-
-jest.mock('../src/utils/resolve-project-base-path');
+import {
+  spyOnConsole,
+  spyOnProcess,
+  mockResolveProjectBasePath,
+} from './utils';
 
 const sourceRoot = '__tests__';
+mockResolveProjectBasePath(sourceRoot);
+
+/**
+ * With ESM modules, you need to mock the modules beforehand (with jest.unstable_mockModule) and import them ashynchronously afterwards.
+ * This thing is still in WIP at Jest, so keep an eye on it.
+ * @see https://jestjs.io/docs/ecmascript-modules#module-mocking-in-esm
+ */
+const { buildTranslationFiles } = await import('../src/keys-builder');
+const { getCurrentTranslation } = await import(
+  '../src/keys-builder/utils/get-current-translation'
+);
 
 const defaultValue = 'missing';
 
@@ -30,10 +41,7 @@ function generateKeys({
   return keys;
 }
 
-function gConfig(
-  type: TranslationCategory,
-  config: Partial<Config> = {}
-) {
+function gConfig(type: TranslationCategory, config: Partial<Config> = {}) {
   return {
     input: [`${type}`],
     output: `${type}/i18n`,
@@ -86,8 +94,8 @@ function assertPartialTranslation({
 
 function loadTranslationFile(
   type: TranslationCategory,
-  path: string,
-  fileFormat: FileFormats
+  path: string | undefined,
+  fileFormat: FileFormats,
 ) {
   return getCurrentTranslation({
     path: `./${sourceRoot}/${type}/i18n/${path || ''}en.${fileFormat}`,
@@ -107,9 +115,8 @@ describe.each(formats)('buildTranslationFiles in %s', (fileFormat) => {
   }
 
   beforeAll(() => {
-    (resolveProjectBasePath as any).mockImplementation(() => {
-      return { projectBasePath: sourceRoot };
-    });
+    spyOnConsole('warn');
+    spyOnProcess('exit');
   });
 
   // Reset to ensure the scopes are not being shared among the tests.
@@ -157,7 +164,7 @@ describe.each(formats)('buildTranslationFiles in %s', (fileFormat) => {
         ['Processing archive...', 'Restore Options'].forEach(
           (nonNumericKey) => {
             expected[nonNumericKey] = defaultValue;
-          }
+          },
         );
         createTranslations(config);
         assertTranslation({ type, expected, fileFormat });
@@ -370,7 +377,7 @@ describe.each(formats)('buildTranslationFiles in %s', (fileFormat) => {
         ['Processing archive...', 'Restore Options'].forEach(
           (nonNumericKey) => {
             expected[nonNumericKey] = defaultValue;
-          }
+          },
         );
         createTranslations(config);
         assertTranslation({ type, expected, fileFormat });

__tests__/read/nested-scope.ts

@@ -1,4 +1 @@
-export const v = {
-  provide: TRANSLOCO_SCOPE,
-  useValue: ['nested/scope', 'todos-page'],
-};
+export const v = { provide: TRANSLOCO_SCOPE, useValue: 'todos-page' };

__tests__/resolveConfig.spec.ts

@@ -1,28 +1,31 @@
 import chalk from 'chalk';
 import path from 'node:path';
-import {jest} from '@jest/globals';
-import type { SpyInstance } from "jest-mock";
+import { jest } from '@jest/globals';
+import type { SpyInstance } from 'jest-mock';
 
 import { defaultConfig as _defaultConfig } from '../src/config';
 import { messages } from '../src/messages';
 
-import { noop, spyOnLog } from './utils';
+import {
+  spyOnConsole,
+  spyOnProcess,
+  mockResolveProjectBasePath,
+} from './utils';
 
 const sourceRoot = '__tests__';
 let mockedGloblConfig;
-jest.mock('../src/utils/resolve-project-base-path', () => {
-  return {
-    resolveProjectBasePath: () => {
-      return { projectBasePath: sourceRoot };
-    }
-  }
-});
-jest.mock('@ngneat/transloco-utils', () => {
-  return {
-    getGlobalConfig: () => mockedGloblConfig
-  };
-});
 
+mockResolveProjectBasePath(sourceRoot);
+
+jest.unstable_mockModule('@ngneat/transloco-utils', () => ({
+  getGlobalConfig: () => mockedGloblConfig,
+}));
+
+/**
+ * With ESM modules, you need to mock the modules beforehand (with jest.unstable_mockModule) and import them ashynchronously afterwards.
+ * This thing is still in WIP at Jest, so keep an eye on it.
+ * @see https://jestjs.io/docs/ecmascript-modules#module-mocking-in-esm
+ */
 const { resolveConfig } = await import('../src/utils/resolve-config');
 
 describe('resolveConfig', () => {
@@ -38,10 +41,8 @@ describe('resolveConfig', () => {
 
   beforeAll(() => {
     mockedGloblConfig = {};
-    processExitSpy = jest
-      .spyOn(process, 'exit')
-      .mockImplementation(noop as any);
-    consoleLogSpy = spyOnLog();
+    processExitSpy = spyOnProcess('exit');
+    consoleLogSpy = spyOnConsole('log');
     spies = [processExitSpy, consoleLogSpy];
   });
 
@@ -107,7 +108,7 @@ describe('resolveConfig', () => {
     });
 
     afterAll(() => {
-      mockedGloblConfig = {}
+      mockedGloblConfig = {};
     });
 
     it('should merge the default and the transloco config', () => {
@@ -140,14 +141,14 @@ describe('resolveConfig', () => {
     function shouldFail(prop: string, msg: 'pathDoesntExist' | 'pathIsNotDir') {
       expect(processExitSpy).toHaveBeenCalled();
       expect(consoleLogSpy).toHaveBeenCalledWith(
-        chalk.bgRed.black(`${prop} ${messages[msg]}`)
+        chalk.bgRed.black(`${prop} ${messages[msg]}`),
       );
       clearSpies();
     }
 
     function shouldPass() {
       [processExitSpy, consoleLogSpy].forEach((s) =>
-        expect(s).not.toHaveBeenCalled()
+        expect(s).not.toHaveBeenCalled(),
       );
       clearSpies();
     }
@@ -195,11 +196,11 @@ describe('resolveConfig', () => {
       const config = resolveConfig({ input: ['comments'] });
       const assertPath = (p) =>
         expect(p.startsWith(path.resolve(process.cwd(), sourceRoot))).toBe(
-          true
+          true,
         );
       config.input.forEach(assertPath);
       ['output', 'translationsPath'].forEach((prop) =>
-        assertPath(config[prop])
+        assertPath(config[prop]),
       );
     });
   });

__tests__/resolveProjectBasePath.spec.ts

@@ -3,7 +3,7 @@ import path from 'path';
 
 import { resolveProjectBasePath } from '../src/utils/resolve-project-base-path';
 
-import { spyOnLog } from './utils';
+import { spyOnConsole } from './utils';
 
 const supportedConfigs = ['angular', 'workspace', 'project'] as const;
 const myProjectConfig = { projectType: 'library', sourceRoot: 'myRoot' };
@@ -17,7 +17,7 @@ const defaultConfig = {
 
 describe('resolveProjectBasePath', () => {
   it('should return the default "src"', () => {
-    const spy = spyOnLog();
+    const spy = spyOnConsole('log');
     expect(resolveProjectBasePath().projectBasePath).toBe('src');
     spy.mockRestore();
   });
@@ -134,7 +134,7 @@ function addProjectConfig({
   fs.mkdirsSync(resolvePath(path));
   fs.writeFileSync(
     jsonFile('project', path),
-    '// comment\n' + JSON.stringify(config)
+    '// comment\n' + JSON.stringify(config),
   );
 }
 
@@ -154,7 +154,7 @@ function addRootConfig({
 }) {
   fs.writeFileSync(
     jsonFile(configType, path),
-    '// comment\n' + JSON.stringify(config)
+    '// comment\n' + JSON.stringify(config),
   );
 }
 

__tests__/utils.ts

@@ -1,7 +1,20 @@
-import {jest} from '@jest/globals';
+import { jest } from '@jest/globals';
+import type { SpyInstance } from 'jest-mock';
 
 export function noop() {}
 
-export function spyOnLog() {
-  return jest.spyOn(console, 'log').mockImplementation(noop);
+export function spyOnConsole(method: 'log' | 'warn'): SpyInstance {
+  return jest.spyOn(console, method).mockImplementation(noop);
+}
+
+export function spyOnProcess(method: 'exit'): SpyInstance {
+  return jest
+    .spyOn(process, method)
+    .mockImplementation(noop as any) as SpyInstance;
+}
+
+export function mockResolveProjectBasePath(projectBasePath: string) {
+  jest.unstable_mockModule('../src/utils/resolve-project-base-path.ts', () => ({
+    resolveProjectBasePath: jest.fn().mockReturnValue({ projectBasePath }),
+  }));
 }

jest.config.mjs renamed to jest.config.ts

@@ -1,7 +1,7 @@
+import type { Config } from 'jest';
 import ngPreset from 'jest-preset-angular/presets/index.js';
 
-/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
-const config = {
+const jestConfig: Config = {
   ...ngPreset.defaultsESM,
   testMatch: ['**/__tests__/**/*.spec.ts'],
   moduleNameMapper: {
@@ -21,4 +21,4 @@ const config = {
   },
 };
 
-export default config;
+export default jestConfig;