Metalsmith v2.5.1 Release Notes

Release Date: 2022-10-07 // 2 months ago
  • ⚡️ Updated

    • Dependencies: 774a164
      • debug: 4.3.3 ▶︎ 4.3.4
    • Clarified semver policy in README.md
    • ➕ Added SECURITY.md

    🛠 Fixed

    • 🛠 Fixes #373: do not crash when postinstall script fails in specific environments

Previous changes from v2.5.0

  • Important note to metalsmith-watch users: 🚀 Although 2.5.0 is a semver-minor release, it breaks compatibility with metalsmith-watch, which relies on the Metalsmith < 2.4.x private method signature using the outdated unyield package. See issue #374 for more details.

    ➕ Added

    • 👍 #354 Added Metalsmith#env method. Supports passing DEBUG and DEBUG_LOG amongst others. Sets CLI: true when run from the metalsmith CLI. b42df8c, 446c676, 33d936b, 4c483a3
    • 🔌 #356 Added Metalsmith#debug method for creating plugin debuggers
    • ⬆️ #362 Upgraded all generator-based methods (Metalsmith#read,Metalsmith#readFile,Metalsmith#write,Metalsmith#writeFile, Metalsmith#run and Metalsmith#process) to dual callback-/ promise-based methods 16a91c5, faf6ab6, 6cb6229
    • ➕ Added org migration notification to postinstall script to encourage users to upgrade 3a11a24

    ✂ Removed

    • 👍 [#231] Dropped support for Node < 12 0a53007
    • Dependencies:
      • thunkify: replaced with promise-based implementation faf6ab6
      • unyield replaced with promise-based implementation faf6ab6
      • co-fs-extra: replaced with native Node.js methods faf6ab6
      • chalk: not necessary for the few colors used by Metalsmith CLI 1dae1cb
      • clone: see [#247] a871af6

    ⚡️ Updated

    • ⚡️ Restructured and updated README.md 0da0c4d
    • 📇 #247 Calling Metalsmith#metadata no longer clones the object passed to it, overwriting the previous metadata, but merges it into existing metadata.

    🛠 Fixed

    • #355 Proper path resolution for edge-cases using CLI, running metalsmith from outside or subfolder of metalsmith.directory()5d75539