sku v13: Explicitly define entrypoints via package.json#exports (#984)

.changeset/chilly-maps-care.md

@@ -0,0 +1,24 @@
+---
+'sku': major
+---
+
+Export jest preset path
+
+**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 CLI. 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,
+};
+```
+
+[testing documentation]: https://seek-oss.github.io/sku/#/./docs/testing

.changeset/moody-dodos-rescue.md

@@ -0,0 +1,11 @@
+---
+'sku': major
+---
+
+Add explicit package exports
+
+**BREAKING CHANGE**:
+
+Importing from arbitrary subpaths within `sku` is no longer possible. See the [API documentation] for a comprehensive list of `sku`'s API entrypoints.
+
+[API documentation]: https://seek-oss.github.io/sku/#/./docs/api

docs/docs/testing.md

@@ -28,12 +28,14 @@ For example, if you're using [React Testing Library](https://testing-library.com
 import '@testing-library/jest-dom';
 ```
 
-sku's Jest configuration can also be used as a [preset](https://jestjs.io/docs/configuration#preset-string), by specifying the `sku/config/jest` preset in your `jest.config.js`:
+sku's Jest configuration can also be used as a [preset](https://jestjs.io/docs/configuration#preset-string):
 
 ```js
+const { preset } = require('sku/config/jest');
+
 /** @type {import('jest').Config} */
 module.exports = {
-  preset: 'sku/config/jest',
+  preset,
 };
 ```
 

fixtures/jest-test/jest.config.js

@@ -1,4 +1,6 @@
+const { preset } = require('sku/config/jest');
+
 /** @type {import('jest').Config} */
 module.exports = {
-  preset: 'sku/config/jest',
+  preset,
 };

packages/sku/config/jest/index.d.ts

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

packages/sku/config/jest/index.js

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

packages/sku/package.json

@@ -2,17 +2,30 @@
   "name": "sku",
   "version": "12.8.1",
   "description": "Front-end development toolkit, powered by Webpack, Babel, CSS Modules, Less and Jest",
-  "main": "index.js",
+  "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"
+    },
+    "./config/storybook": "./config/storybook/index.js",
+    "./@loadable/component": "./@loadable/component/index.ts",
+    "./@storybook/react": "./@storybook/react/index.ts",
+    "./webpack-plugin": "./config/webpack/plugins/sku-webpack-plugin/index.js",
+    "./package.json": "./package.json"
+  },
   "engines": {
     "node": ">=18.12"
   },
   "scripts": {
     "postinstall": "node ./scripts/postinstall.js"
   },
-  "types": "./sku-types.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/seek-oss/sku.git",

packages/sku/scripts/test.js

@@ -1,4 +1,3 @@
-const path = require('node:path');
 const debug = require('debug');
 const jest = require('jest');
 
@@ -7,19 +6,17 @@ const { argv, watch } = require('../config/args');
 const { runVocabCompile } = require('../lib/runVocab');
 
 const log = debug('sku:jest');
-// https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html#configuring-your-testing-environment
-process.env.IS_REACT_ACT_ENVIRONMENT = true;
 
 (async () => {
   await runVocabCompile();
 
   // https://jestjs.io/docs/configuration#preset-string
-  const jestPreset = require.resolve('../config/jest/jest-preset');
-  log(`Using Jest preset at ${jestPreset}`);
+  const { preset } = require('../config/jest');
+  log(`Using Jest preset at ${preset}`);
 
   const jestArgv = [...argv];
 
-  jestArgv.push('--preset', path.dirname(jestPreset));
+  jestArgv.push('--preset', preset);
 
   if (isCI) {
     jestArgv.push('--ci');

test-utils/package.json

@@ -9,7 +9,6 @@
     "node-dir": "^0.1.17",
     "prettier": "^2.8.8",
     "serve-handler": "^6.1.3",
-    "sku": "workspace:*",
     "wait-on": "^7.0.0",
     "webpack-stats-plugin": "^1.0.3"
   },

test-utils/process.ts

@@ -7,10 +7,10 @@ import {
   type ChildProcess,
   type ExecFileOptions,
 } from 'node:child_process';
-import gracefulSpawn from 'sku/lib/gracefulSpawn';
+import gracefulSpawn from '../packages/sku/lib/gracefulSpawn.js';
 
 const execFile = promisify(_execFile);
-const skuBin = require.resolve('sku/bin/sku.js');
+const skuBin = require.resolve('../packages/sku/bin/sku.js');
 
 export const run = async (
   file: string,