CHANGELOG.md

Changelog

Notable changes to this project are documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Breaking changes:

New features:

Bugfixes:

• Ensure that callbacks passed to question and question' are invoked (#38 by @youngnh)
• Fixed typo in options passed to readline.createInterface (#38 by @youngnh)

Other improvements:

v8.1.1 - 2024-06-30

Bugfixes:

• Ensure that callbacks passed to question and question' are invoked (#38 by @youngnh)
• Fixed typo in options passed to readline.createInterface (#38 by @youngnh)

v8.1.0 - 2023-07-26

Bugfixes:

• Bump node-streams to v9.0.0 to fix FFI issues (#37 by @JordanMartinez)

v8.0.0 - 2023-07-21

Breaking changes:

• Removed setLineHandler and LineHandler type alias (#34 by @JordanMartinez)

  setLineHandler was previously implemented as

  readline.removeAllListeners("line");
  readline.on("line", cb);
  
  With the addition of bindings from `EventEmitter`,
  this can be done using `on`
  ```purs
  example = do
    removeListener <- interface # on lineH \line -> do
      ...
    ...
    removeListener

New features:

• Added missing createInterface options (#35 by @JordanMartinez)

  • history
  • removeHistoryDuplicates
  • prompt
  • crlfDelay
  • escapeCodeTimeout
  • tabSize

• Added missing APIs (#35, #36 by @JordanMartinez)

  • pause/resume
  • question'
  • getPrompt
  • write exposed as writeData and writeKey
  • line, cursor
  • getCursorPos, clearLine variants, clearScreenDown variants
  • cursorTo variants, moveCursor variants
  • emitKeyPressEvents

• Added Aff-based convenience methods (#36 by @JordanMartinez)

  • question
  • question'
  • countLines
  • blockUntilClosed

• Added bindings for AbortController/AbortSignal (#36 by @JordanMartinez)

Bugfixes:

Other improvements:

• Update CI node version to lts/* (#31, #32 by @JordanMartinez)
• Update CI actions to v3 (#31, #32 by @JordanMartinez)
• Format code via purs-tidy; enforce formatting in CI (#31, #32 by @JordanMartinez)
• Update FFI to use uncurried functions (#33 by @JordanMartinez)
• Reordered export list (#35 by @JordanMartinez)

v7.0.0 - 2022-04-29

Breaking changes:

• Update project and deps to PureScript v0.15.0 (#28 by @JordanMartinez, @sigma-andex)

v6.0.0 - 2022-04-27

Due to implementing a breaking change incorrectly, use v7.0.0 instead.

v5.0.0 - 2021-02-26

Breaking changes:

• Added support for PureScript 0.14 and dropped support for all previous versions (#20)
• Removed length parameter for setPrompt (#21)
• Ensured a consistent argument position for functions using Interface (#23)

Other improvements:

• Migrated CI to GitHub Actions and updated installation instructions to use Spago (#19)
• Added a changelog and pull request template (#22)

v4.0.1 - 2019-06-08

• Relax upper bounds to allow building with 0.13. (@klntsky)

v4.0.0 - 2018-05-29

• Updates for 0.12

v3.1.0 - 2017-08-22

• Add question (@dgendill)

v3.0.1 - 2017-08-04

• Relax the upper bound in bower.json on node-process, so that this library can be depended on together with version 5.0.0 of node-process without any hassle.

v3.0.0 - 2017-04-05

• Updates for 0.11 compiler

v2.0.0 - 2016-10-22

• Updated dependencies

v1.0.0 - 2016-06-13

• Updates for 0.9.1 compiler (@kika)

v0.4.1 - 2016-03-07

• Fix a bug with completers (@Thimoteus)

v0.4.0 - 2016-02-27

• Expose more of the node API (@spicydonuts, #4)

v0.3.1 - 2015-08-10

• Add close (@aspidites)

v0.3.0 - 2015-08-05

• Flip arguments to setLineHandler (@aspidites)

v0.2.0 - 2015-07-14

• Release for 0.7 compiler.

v0.1.1 - 2014-10-29

• Prevent row subtraction wonkiness in setLineHandler.

v0.1.1 - 2014-08-27

• Simplify some type signatures, provide default completion, and provide better handling of events.

v0.1.0 - 2014-06-14

• Initial release