Changelog of @hackage/iris 0.1.0.0

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to PVP Versioning. The changelog is also available on GitHub.

Unreleased

0.1.0.0 — 2023-03-02 🎂

Added

  • #22: Implement full CLI Guidelines recommendations on colouring:

    • Detect colours of stdout and stderr automatically
    • Always output colours when --colour (or --color) is specified
    • Disable colours when:
      • --no-colour (or --no-color) is specified
      • Output handle doesn't support colouring
      • NO_COLOUR (or NO_COLOR) env is set
      • MYAPP_NO_COLOUR (or MYAPP_NO_COLOR) env is set
      • TERM=dumb env variable is set

    (by @marcellourbani, @chshersh)

  • #58: Detect non-interactive terminals automatically (by @marcellourbani)

  • #89 Add putStderrColoured and putStdoutColoured functions for putting string without outputting the line break (by @Dponya)

  • #84: Add support for GHC 9.4 (by @blackheaven)

  • #27: Add Haddock with usage examples to many modules (by @chshersh)

Changed

  • #90: Use Text instead of ByteString in putStdoutColoured(Ln) and putStderrColoured(Ln) functions (by @lillycat332)
    • Migration guide: Use functions from Data.Text.Encoding to convert between ByteString and Text or change your types to Text
  • #67: Remove the cliEnvSettingsRequiredTools field from the CliEnvSettings type. Also remove the CliEnvException type. Now, a new function need from Iris.Tool should be used for each individual command instead. (by @german1608)
    • Migration guide 1: Use the need function from the Iris.Tool module instead.
    • Migration guide 2: Don't catch CliEnvException from mkCliEnv anymore.
  • #33: Move errors from ToolCheckResult into a separate type (by @charrsky)
    • Migration guide: Change pattern-matching on ToolCheckResult to handle only one constructor with an error instead of previous two.

Non-UX changes

0.0.0.0 — 2022-08-09 🌇

Initial release prepared by @chshersh.

Added