sku@12.0.0
Major Changes
-
Drop support for styling with treat. Please migrate styles to Vanilla Extract. (#809)
-
Remove workaround for
classnamespackage issue (#803)A workaround for a bug in the
classnamespackage has been removed now that the bug has been fixed.Please evaluate whether you need to use
classnameslibrary in your app.
Prefer using Braid'sBoxcomponent, which supports the fullclsxAPI, instead.
If you need to construct class name strings for components other thanBox, prefer theclsxpackage over theclassnamespackage. -
sku initno longer installs and configures husky for you (#804)BREAKING CHANGE
sku initno longer addshuskyas a dependecy nor does it configure husky for you out of the box.
For instructions on how to set uphuskyto use sku's pre-commit hook, see the docs. -
Support Storybook v7 (#810)
sku now supports Storybook v7. Please read the Storybook migration guide for a high-level overview of what has changed. For a more detailed list of changes, take a look at the full migration notes.
NOTE: Since sku installs and configures Storybook for you, a lot of the changes will not be relevant to users.BREAKING CHANGE
As of Storybook v7, stories that use the
storiesOfAPI will not work by default. ThestoriesOfAPI is deprecated and will be removed in Storybook v8, so it is highly encouraged to migrate your stories to the Component Story Format (CSF).Migration can be done automatically via the migration tools provided by Storybook:
npx storybook@7 migrate storiesof-to-csf --glob="src/**/*.stories.tsx"After doing this migration, your stories may need some manual cleanup to function correctly, such as adding a default metadata export.
When your stories are working, you can also optionally migrate to the newer CSF 3:
npx storybook@7 migrate csf-2-to-3 --glob="src/**/*.stories.tsx"If you cannot migrate your stories to CSF, or you need to dynamically generate stories with
storiesOf(see this issue for more info on the future of thestoriesOfAPI), you can set thestorybookStoryStoreflag tofalsein your sku config:import { type SkuConfig } from 'sku'; export default { storybookStoryStore: false, } satisfies SkuConfig;
-
Drop support for
seek-style-guideBREAKING CHANGE
seek-style-guideis no longer supported by sku. Flow support was already removed from sku in v11, so
anyseek-style-guidecomponents that use flow currently don't work with sku. However, there were remnants
ofseek-style-guidestill present in sku's codebase. Specifically, import optimization and
component mocking. These features have now been removed. Please migrate tobraid-design-system. -
Require Node.js 18.12+ (#805)
BREAKING CHANGE
Node 14 has already reached end of life as of April 2023, and Node.js 16 had its end of life date brought forward to September 2023, so in the interest of preventing another breaking change in 4 months time, we're pre-emptively dropping support for Node.js 16 in addition to Node.js 14.
We've chosen to support Node.js versions from v18.12 onwards as this version was the first Node.js 18 LTS release.Consider upgrading the Node.js version for your project across:
.nvmrcpackage.json#/engines/node@types/nodepackage version- CI/CD configuration (
.buildkite/pipeline.yml,Dockerfile, etc.)
Minor Changes
-
Re-export all of
@storybook/react(#810)Previously, only specific APIs were re-exported under
sku/@storybook/react. All APIs are now re-exported. -
Upgrade to TypeScript 5.0 (#813)
This major release includes breaking changes. See the TypeScript 5.0 announcement for more information.