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

#9: Implement Yes/No reading functions:

Add yesno function for asking a question with can be answered with either Yes or No
Add YesNo type (Yes | No)

#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)

#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.

#16: Write complete Iris tutorial with a usage example using Literate Haskell (by @Dponya, @chshersh)
#56: Implement tests for the --help parser (by @CThuleHansen)
#57: Add tests for the --version and --numeric-version flags (by @CThuleHansen)
#59: Write a test to check if global parsing conflicts with local parsing (by @zetkez)
#70: Add HLint configuration and CI support (by @blackheaven)
#64: Add Stan configuration and CI support (by @blackheaven)
#69: Add pre-commit hooks config (by @aleeusgr)
#74: Add pull request template (by @himanshumalviya15)
#62: Use fourmolu for code formatting (by @chshersh)

Initial release prepared by @chshersh.

#34: Add the --no-input CLI option for disabling interactivity (by @charrsky)
#36: Support Windows and macOS (by @charrsky)
#37: Support GHC 9.0.2 (by @charrsky)
#38: Support GHC 9.2.3 and GHC 9.2.4 (by @charrsky, @chshersh)
#42, #52: Add stack support and instructions to build with stack (by @charrsky, @chshersh)
#43: Add MonadUnliftIO instance for the CliApp monad (by @charrsky)