sku 13.0.1 → 13.0.2

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # sku
 
+## 13.0.2
+
+### Patch Changes
+
+- Replace `sku/config/jest` entrypoint with `sku/jest-preset` ([#1024](https://github.com/seek-oss/sku/pull/1024))
+
+  **BREAKING CHANGE FOR CUSTOM JEST CONFIG**:
+
+  This breaking change will only affect a very small number of projects that have a custom Jest configuration/wish to debug tests in their IDE, and it is intended to be a quick fix/improvement for a feature released in `sku@13.0.0`. Therefore, it's not being released as a major version.
+
+  The `sku/config/jest` entrypoint has been removed in favor of a new `sku/jest-preset` entrypoint. The `sku/jest-preset` module is a better way to expose a [jest preset], rather than a relative path (the previous implementation), as it works even if `sku` is hoisted to a parent `node_modules` directory.
+
+  **MIGRATION GUIDE**:
+
+  ```diff
+  // jest.config.js
+  - const { preset } = require('sku/config/jest');
+
+  /** @type {import('jest').Config} */
+  module.exports = {
+     // If you've already migrated to sku v13
+  -  preset,
+     // If you're still on sku v12.x
+  -  preset: 'sku/config/jest',
+  +  preset: 'sku',
+  };
+  ```
+
+  [jest preset]: https://jestjs.io/docs/configuration#preset-string
+
 ## 13.0.1
 
 ### Patch Changes
@@ -10,22 +40,20 @@
 
 ### Major Changes
 
-- Export jest preset path ([#984](https://github.com/seek-oss/sku/pull/984))
+- Export jest preset ([#984](https://github.com/seek-oss/sku/pull/984))
 
   **BREAKING CHANGE**:
 
-  The jest preset is now accessible via a relative path rather than pointing to a module. This may affect users that require a jest config for debugging tests in their IDE. See the [testing documentation] for more information.
+  The jest preset is now accessible via the `sku` preset. This may affect users that require a jest config for debugging tests in their IDE. See the [testing documentation] for more information.
 
   **MIGRATION GUIDE**:
 
   ```diff
   // jest.config.js
-  + const { preset } = require('sku/config/jest');
-
   /** @type {import('jest').Config} */
   module.exports = {
   -  preset: 'sku/config/jest',
-  +  preset,
+  +  preset: 'sku',
   };
   ```
 
@@ -170,6 +198,26 @@
   }
   ```
 
+  If you have a [multi-language] application, you will want to compile your translations before running the Storybook CLI:
+
+  ```jsonc
+  // package.json
+  {
+    "scripts": {
+      "storybook": "sku translations compile && storybook dev" // or storybook build
+    }
+  }
+  ```
+
+  If you want to run a development Storybook and see Vocab translations update in real time, you can run the [`sku translations compile --watch`][translations compile watch] command at the same time as `storybook dev`.
+  This can be achieved via a package such as [`concurrently`], or if you are using `pnpm` you can use `pnpm`'s built-in support for [running multiple scripts] in parallel.
+
+  Please read the [Storybook CLI documentation] for more information.
+
+  [multi-language]: ./docs/multi-language
+  [translations compile watch]: ./docs/cli?id=translations-compile
+  [`concurrently`]: https://www.npmjs.com/package/concurrently
+  [running multiple scripts]: https://pnpm.io/8.x/cli/run#running-multiple-scripts
   [storybook cli]: https://storybook.js.org/docs/cli/
 
   #### Update Storybook imports

package/package.json

@@ -1,19 +1,14 @@
 {
   "name": "sku",
-  "version": "13.0.1",
+  "version": "13.0.2",
   "description": "Front-end development toolkit, powered by Webpack, Babel, Vanilla Extract and Jest",
   "types": "./sku-types.d.ts",
   "bin": {
     "sku": "./bin/sku.js"
   },
   "exports": {
-    ".": {
-      "types": "./sku-types.d.ts"
-    },
-    "./config/jest": {
-      "default": "./config/jest/index.js",
-      "types": "./config/jest/index.d.ts"
-    },
+    ".": "./sku-types.d.ts",
+    "./jest-preset": "./config/jest/jest-preset.js",
     "./config/storybook": {
       "default": "./config/storybook/index.js",
       "types": "./config/storybook/index.d.ts"
@@ -145,6 +140,7 @@
   "devDependencies": {
     "@types/cross-spawn": "^6.0.3",
     "@types/debug": "^4.1.12",
+    "@types/eslint": "^8.56.10",
     "@types/minimist": "^1.2.5",
     "@types/picomatch": "^2.3.3",
     "@types/react": "^18.2.3",

package/scripts/test.js

@@ -11,12 +11,12 @@ const log = debug('sku:jest');
   await runVocabCompile();
 
   // https://jestjs.io/docs/configuration#preset-string
-  const { preset } = require('../config/jest');
-  log(`Using Jest preset at ${preset}`);
+  const jestPreset = 'sku';
+  log(`Using '${jestPreset}' Jest preset`);
 
   const jestArgv = [...argv];
 
-  jestArgv.push('--preset', preset);
+  jestArgv.push('--preset', jestPreset);
 
   if (isCI) {
     jestArgv.push('--ci');

package/config/jest/index.d.ts

@@ -1 +0,0 @@
-export const preset: string;

package/config/jest/index.js

@@ -1,8 +0,0 @@
-// @ts-check
-
-// Relative preset paths must start with `./` or jest complains
-const preset = './node_modules/sku/config/jest/jest-preset.js';
-
-module.exports = {
-  preset,
-};