Skip to content

codedge-llc/pane

Repository files navigation

Pane

Paginated data viewer for IEx. Written for scribe. Useful for inspecting large collections and deeply nested structs.

CI Version Total Downloads License Last Updated Documentation

Installation

Add :pane as a mix.exs dependency:

def deps do
  [
    {:pane, "~> 0.5.0"}
  ]
end

Usage

iex> data =  File.read!("mix.exs") # Or some other really long string
iex> Pane.console(data)

console

Available Commands

  • j - Next page
  • k - Previous page
  • f - First page
  • l - Last page
  • q - Quit

Contributing

Testing

Unit tests can be run with mix test or mix coveralls.html.

Formatting

This project uses Elixir's mix format and Prettier for formatting. Add hooks in your editor of choice to run it after a save. Be sure it respects this project's .formatter.exs.

Commits

Git commit subjects use the Karma style.

License

Copyright (c) 2017-2024 Codedge LLC (https://www.codedge.io/)

This library is MIT licensed. See the LICENSE for details.