Skip to content

Release v5.0.0

Latest

Choose a tag to compare

@github-actions github-actions released this 15 Sep 11:10
· 2 commits to main since this release

Changed

  • The separate commands optimize favicons and optimize icons have been removed.
  • The optimize all command has been renamed to optimize assets.
  • The -h (--help) flag without specifying a command now only prints general brief help information.
  • The -v (--version) flag in any of the commands now only displays the version and terminates execution.
  • optimize assets command:
    • The -h (--help) flag now only prints detailed help for the optimize assets command.
    • The -r (--remove-origin) flag is now enabled by default (use --no-r to prevent the removal of raster image source files).
    • The -a (--add-origin-format) flag is no longer available.
    • The -i (--input-directory) option is no longer available.
    • The -o (--output-directory) option is no longer available.
    • The new -s (--shared-directory) option is now available with a default value of ./src/shared/.
    • Behavior:
      • Raster and vector images (not icons) must now be located in the <publicDirectory>/images/ directory.
      • The metadata of all raster images from <publicDirectory>/images is now stored in the images field in the <sharedDirectory>/data.json file, with the other fields in that file remaining unchanged.
      • Raster image metadata no longer contains paths and imports.
      • The names of generated custom properties for icons are now lowercase with a hyphen as a word separator, consistent with the style of custom properties generated from design tokens.
      • All generated favicons are now placed directly in <publicDirectory> with names starting with favicon.
      • If manifest.webmanifest already exists, its contents are now saved with only the array in the icons field replaced with the new one.
      • If the name and description fields are missing from manifest.webmanifest, they will now be filled with the values of these fields from the project field in the <sharedDirectory>/data.json file, if they exist.
      • The links.md file is now created in the <sharedDirectory> directory.
  • optimize images command:
    • The -h (--help) flag now only prints detailed help for the optimize images command.
    • The default value of the -i (--input-directory) option is now changed to ./.
    • The default value of the -f (--target-formats) option is now changed to avif.
    • The default value of the -d (--origin-density) option is now changed to 0.
    • The -a (--add-origin-format) flag is no longer available.
    • The -m (--add-meta-data) flag is no longer available.
    • The -p (--public-directory) option is no longer available.