[email protected]

Major Changes

• Migrating sku to ESM from commonjs (#1156)

  BREAKING CHANGE:

  Most of skus API entrypoints are now ESM. Consumers that use the following API entrypoints may need to convert some of their configuration files to ESM:

  ---

  sku/webpack-plugin is now an ES module and has to be imported as such.

  If you are using require() to import sku/webpack-plugin you will have to change it to import.

  - const SkuWebpackPlugin = require('sku/webpack-plugin');
  + import SkuWebpackPlugin from 'sku/webpack-plugin';

  [!NOTE]
  The file that is importing sku/webpack-plugin must also be an ES module so further changes may be required.

  ---

  sku/config/eslint is a new entrypoint that exposes sku's flat ESLint configuration. It now only supports ESM.

• Update eslint-config-seek to v14 (#1156)

  Alongside the migration to ESLint v9, eslint-config-seek has been updated to v14 which supports the new flat config format.

  Some lint rules have been changed or renamed, so consumers should run sku format to automatically update their code to conform to the new rules. You may still need to manually review and adjust your code after running sku format as not all issues are auto-fixable.

  [!NOTE]
  You may need to migrate your ESLint configuration before running sku format.
  Please read the release notes for more information on how to migrate your ESLint configuration.

  Additionally, eslint-plugin-import has been replaced with eslint-plugin-import-x. You should replace any references to eslint-plugin-import with eslint-plugin-import-x and any import/ rules with import-x/.

  See the eslint-config-seek release notes for more information.

• Change the CLI to commander.js. (#1156)

  BREAKING CHANGE

  sku now uses commander.js for its CLI. The CLI options and commands are now more narrowly defined and scoped. Some combinations of options that were previously possible may no longer work.

  The new -h, --help flag now shows the help output generated by commander.js and shows the available commands and options.

  The following option flags are now available in their respective scope

  Global options

  • the -e, --environment option
  • the -c, --config option
  • the -d, --debug option
  • new: the -h, --help option
  • new: the -v, --version option

  Scoped options

  • the build, build-ssr, start, and start-ssr commands have the following options
    • -s, --stats option
  • the serve command now has the following options
    • --port option
    • --site option
  • the translation compile command now has the following options
    • -w, --watch option
  • the translation push command now has the following option
    • --delete-unused-keys option
  • the init command now has the following options
    • -p, --package-manager option. This has changed from --packageManager preferring kebab-case over camelCase for option flags.
    • --verbose option

• Update to ESLint v9 (#1156)

  ESLint v9 defaults to the new flat config format. As such, sku's ESLint config has been migrated to this new format, and consumers will need to migrate any custom overrides set via dangerouslySetESLintConfig to the new format as well.

  For example, if you are overriding an ESLint rule, you can migrate to the new config format like so:

  dangerouslySetESLintConfig: (config) => {
  -  return {
  -    ...config,
  -    rules: {
  -      ...config.rules,
  -      'no-console': 'off'
  -    }
  -  };
  +  return [
  +    ...config,
  +    {
  +      rules: {
  +        'no-console': 'off'
  +      }
  +    }
  +  ];
  }

  More complicated overrides such as the use of plugins or modification of parser options may require a more involved migration. Please refer to the migration guide for more information.

  Additionally, the .eslintignore file is no longer used by ESLint. Instead, ignore patterns are now configured directly in your ESLint config file. Since sku controls your ESLint config, you can configure any custom ignore patterns in your sku config via the new eslintIgnore option.

  For example:

  import type { SkuConfig } from 'sku';
  
  export default {
    eslintIgnore: ['a-large-file.js', '**/generated/'],
  } satisfies SkuConfig;

  [!TIP]
  Upon installation, sku will automatically try to migrate any custom entries in your .eslintignore to the new eslintIgnore configuration.
  This migration must be done locally, it will not be committed to your repository from CI.
  If this migration fails, you will need to manually migrate any custom ignore entries.

  [!IMPORTANT]
  Changes to ignore patterns or other ESLint configuration via eslintIgnore and dangerouslySetESLintConfig respectively will no longer be reflected directly in your eslint.config.js file.
  The sku/config/eslint entrypoint handles the composition of these configurations.
  The best way to visualize your final ESLint configuration is use the official ESLint config inspector.

• Drop support for Node.js versions below 20.18.2 (#1156)

  BREAKING CHANGE:

  The minimum supported Node.js version is now 20.18.2. Consumers must upgrade to Node.js v20.18.2 or later.

• Drop support for React 17.x (#1156)

  BREAKING CHANGE

  React 17 is no longer supported. Consumers will need to upgrade to React 18. Consumers still on v17 should follow the How to Upgrade to React 18 guide. Additionally, ensure any dependencies that rely on React are compatible with React 18.

Minor Changes

• Expose sku's ESLint config under sku/config/eslint entrypoint (#1156)

  This entrypoint is used by sku to configure ESLint. Most consumers will not need to use this entrypoint directly.

• Add support for .mjs sku configuration files (#1156)

  In addition to sku.config.ts and sku.config.js, sku will now also look for a sku.config.mjs file when attempting to resolve your application's configuration file.

Patch Changes

• sku init: Ensure latest React 18 version is installed in new projects as React 19 is not yet supported (#1156)