Use Jest projects (#1294)

* use jest projects * poc * tweak ordering * Add changeset * Nit * remove extra export * update changeset * Tweak changeset * Update src/api/jest/index.ts Co-authored-by: Ryan Ling <ryan@outlook.com.au> --------- Co-authored-by: Ryan Ling <ryan@outlook.com.au>
seek-oss · Oct 11, 2023 · 2d8b57a · 2d8b57a
1 parent 93a431a
commit 2d8b57a
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 22 deletions.
diff --git a/.changeset/breezy-bees-judge.md b/.changeset/breezy-bees-judge.md
@@ -0,0 +1,55 @@
+---
+'skuba': minor
+---
+
+Jest.mergePreset: Propagate root-level configuration options to `projects`
+
+[`Jest.mergePreset`](https://seek-oss.github.io/skuba/docs/development-api/jest.html#mergepreset) now propagates the `moduleNameMapper` and `transform` options from root-level configuration to the `projects` array.
+
+If you were referencing the base config in the `projects` array:
+
+```ts
+const baseConfig = Jest.mergePreset({
+  // ...
+});
+
+export default {
+  ...baseConfig,
+  projects: [
+    {
+      ...baseConfig,
+      displayName: 'unit',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testPathIgnorePatterns: ['\\.int\\.test\\.ts'],
+    },
+    {
+      ...baseConfig,
+      displayName: 'integration',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testMatch: ['**/*.int.test.ts'],
+    },
+  ],
+};
+```
+
+You can replace it with the following:
+
+```ts
+export default Jest.mergePreset({
+  // ...
+  projects: [
+    {
+      displayName: 'unit',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testPathIgnorePatterns: ['\\.int\\.test\\.ts'],
+    },
+    {
+      displayName: 'integration',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testMatch: ['**/*.int.test.ts'],
+    },
+  ],
+});
+```
+
+The `projects` option allows you to reuse a single Jest config file for different test types. View the [Jest documentation](https://jestjs.io/docs/configuration#projects-arraystring--projectconfig) for more information.
diff --git a/jest.config.int.ts b/jest.config.int.ts
diff --git a/jest.config.ts b/jest.config.ts
@@ -4,9 +4,25 @@ export default Jest.mergePreset({
   coveragePathIgnorePatterns: ['<rootDir>/integration/', '<rootDir>/template/'],
   displayName: 'unit',
   setupFiles: ['<rootDir>/jest.setup.ts'],
-  testPathIgnorePatterns: [
-    '<rootDir>/template/',
-    '\\.int\\.test\\.ts',
-    '/test\\.ts',
+  testPathIgnorePatterns: ['<rootDir>/template/', '/test\\.ts'],
+  watchPathIgnorePatterns: [
+    '<rootDir>/integration/format/',
+    '<rootDir>/integration/lint/',
+  ],
+  projects: [
+    {
+      displayName: 'unit',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testPathIgnorePatterns: [
+        '<rootDir>/template/',
+        '/test\\.ts',
+        '\\.int\\.test\\.ts',
+      ],
+    },
+    {
+      displayName: 'integration',
+      setupFiles: ['<rootDir>/jest.setup.ts'],
+      testMatch: ['**/*.int.test.ts'],
+    },
   ],
 });
diff --git a/package.json b/package.json
@@ -36,11 +36,11 @@
     "release": "yarn build && changeset publish",
     "skuba": "yarn build && node lib/skuba",
     "stage": "changeset version && yarn format",
-    "test": "yarn skuba test",
-    "test:ci": "yarn skuba test --config jest.config.int.ts --runInBand",
-    "test:int": "yarn skuba test --config jest.config.int.ts --runInBand",
+    "test": "yarn skuba test --selectProjects unit",
+    "test:ci": "yarn skuba test --runInBand",
+    "test:int": "yarn skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
-    "test:watch": "yarn skuba test --config jest.config.int.ts --runInBand --watch"
+    "test:watch": "yarn skuba test --runInBand --watch"
   },
   "remarkConfig": {
     "plugins": [

diff --git a/src/api/jest/index.test.ts b/src/api/jest/index.test.ts
@@ -30,4 +30,31 @@ describe('mergePreset', () => {
 
     expect(config).toHaveProperty('testEnvironment', 'jsdom');
   });
+
+  it('provides the jest preset transform and moduleNameMapper to projects', () => {
+    const config = mergePreset({
+      projects: [{ displayName: 'unit' }, { displayName: 'integration' }],
+    });
+
+    expect(config.projects).toStrictEqual([
+      {
+        displayName: 'unit',
+        transform: expect.any(Object),
+        moduleNameMapper: expect.any(Object),
+      },
+      {
+        displayName: 'integration',
+        transform: expect.any(Object),
+        moduleNameMapper: expect.any(Object),
+      },
+    ]);
+  });
+
+  it('allows paths to be passed to projects', () => {
+    const config = mergePreset({
+      projects: ['src/project1', 'src/project2'],
+    });
+
+    expect(config.projects).toStrictEqual(['src/project1', 'src/project2']);
+  });
 });
diff --git a/src/api/jest/index.ts b/src/api/jest/index.ts
@@ -34,6 +34,28 @@ type DefaultOptions =
  */
 export const mergePreset = <
   AdditionalOptions extends keyof Config.InitialOptions,
->(
-  options: Pick<Config.InitialOptions, AdditionalOptions | DefaultOptions>,
-): Config.InitialOptions => mergeRaw(jestPreset, options);
+>({
+  projects,
+  ...options
+}: Pick<
+  Config.InitialOptions,
+  AdditionalOptions | DefaultOptions
+>): Config.InitialOptions => {
+  const root = mergeRaw(jestPreset, options);
+
+  return {
+    ...root,
+
+    projects: projects?.map((project) => {
+      if (typeof project === 'string') {
+        return project;
+      }
+
+      return {
+        moduleNameMapper: root.moduleNameMapper,
+        transform: root.transform,
+        ...project,
+      };
+    }),
+  };
+};