Releases: seek-oss/sku
sku@12.2.0
Minor Changes
-
Export internal Jest configuration as a preset under
sku/config/jest
. This allows consumers to debug tests in their IDE by specifying the preset in theirjest.config.js
: (#850)/** @type {import('jest').Config} */ module.exports = { preset: 'sku/config/jest', };
-
srcPaths
no longer affectstsconfig.json#include
. Instead, you can use thedangerouslySetTSConfig
option to have more control over which files are included in the type checking process. (#848)Previously, sku managed the
include
field intsconfig.json
, but this was problematic for projects that wanted more fine grained control over what was included and/or excluded from compilation.Note: If you were previously using
srcPaths
for this purpose, you should remove the paths which are not source files. -
Update
tsconfig.json
options to match the latest version of the TypeScript compiler. (#844)
Patch Changes
-
Upgrade to TypeScript 5.1 (#844)
-
Update dependency
eslint-config-seek
. (#844)This reverts the autofix for a Cypress rule and improves the performance of linting TypeScript files.
-
The presence of a
sku.config.js
file previously had an effect on what was included in thetsconfig.json#include
array. With the removal of the defaultinclude
array, this is no longer the case and you might see a TypeScript error like this: (#848)error TS18003: No inputs were found in config file '/path/to/project/tsconfig.json'. Specified 'include' paths were '["**/*"]' and 'exclude' paths were '[]'.
If your project contains only JavaScript files and you see the above error, you should rename
sku.config.js
tosku.config.ts
and the error will go away.
sku@12.1.2
Patch Changes
- Don't use
.git
folder to find root, only glob PNPM virtual store if PNPM is detected as the package manager (#845)
sku@12.1.1
Patch Changes
-
Improve compile package detection in PNPM apps (#840)
-
Makes some more of the array types in the sku config type into readonly versions. (#843)
This allows for arrays that have been declared withas const
to be passed in.Affected fields are
sites
,sites[].routes
,site[].languages
,routes
, androutes[].languages
.
sku@12.1.0
Minor Changes
-
Remove
babel-plugin-dynamic-import-node
dependency (#835)This plugin was used to transform dynamic imports into deferred requires within jest tests.
However, dynamic imports are well supported in Node, so this plugin is no longer required.
Patch Changes
sku@12.0.5
Patch Changes
- Fix
sku init
on Windows (#833)
sku@12.0.4
Patch Changes
- Bump
eslint-config-seek
to11.2.0
(#830)
sku@12.0.3
Patch Changes
- Fix ESLint warning and error reporting (#826)
sku@12.0.2
Patch Changes
- Ensure
sku pre-commit
lints the same files assku lint
(#821)
sku@12.0.1
Patch Changes
- Check that paths exist before looking for
*.less
files in them (#817)
sku@12.0.0
Major Changes
-
Drop support for styling with treat. Please migrate styles to Vanilla Extract. (#809)
-
Remove workaround for
classnames
package issue (#803)A workaround for a bug in the
classnames
package has been removed now that the bug has been fixed.Please evaluate whether you need to use
classnames
library in your app.
Prefer using Braid'sBox
component, which supports the fullclsx
API, instead.
If you need to construct class name strings for components other thanBox
, prefer theclsx
package over theclassnames
package. -
sku init
no longer installs and configures husky for you (#804)BREAKING CHANGE
sku init
no longer addshusky
as a dependecy nor does it configure husky for you out of the box.
For instructions on how to set uphusky
to 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
storiesOf
API will not work by default. ThestoriesOf
API 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 thestoriesOf
API), you can set thestorybookStoryStore
flag tofalse
in your sku config:import { type SkuConfig } from 'sku'; export default { storybookStoryStore: false, } satisfies SkuConfig;
-
Drop support for
seek-style-guide
BREAKING CHANGE
seek-style-guide
is no longer supported by sku. Flow support was already removed from sku in v11, so
anyseek-style-guide
components that use flow currently don't work with sku. However, there were remnants
ofseek-style-guide
still 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:
.nvmrc
package.json#/engines/node
@types/node
package 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.