bottom: Encoding and decoding for the Bottom spec.

[ apache, codec, library, program ] [ Propose Tags ]

Encoding and decoding for the Bottom spec.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.2.0.0
Change log CHANGELOG.md
Dependencies base (==4.14.*), bottom, bytestring (>=0.11.1.0 && <0.12), deepseq (>=1.4.4.0 && <1.5), megaparsec (>=9.0.1 && <9.1), optparse-applicative (>=0.16.1.0 && <0.17), text (>=1.2.4.1 && <1.3) [details]
License Apache-2.0
Copyright 2021 Leo Zhang
Author Leo Zhang
Maintainer leo@leozhang.me
Category Codec
Home page https://github.com/bottom-software-foundation/bottom-hs
Bug tracker https://github.com/bottom-software-foundation/bottom-hs/issues
Source repo head: git clone git://github.com/bottom-software-foundation/bottom-hs.git
Uploaded by leo at 2021-04-02T08:22:57Z
Distributions NixOS:0.2.0.0
Executables bottom
Downloads 63 total (63 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-04-02 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for bottom-0.2.0.0

[back to package description]

bottom-hs

Build and test Hackage Hackage-Deps

Based off of the hilarious bottom-rs, built to the Bottom spec.

,,,,,,,,,

Using the CLI

$ cabal run bottom -- --help

Bottom translator 0.1.0

Usage: bottom ((-b|--bottomify) | (-r|--regress) | (-V|--version)) <TEXT>
  Fantastic (maybe) CLI for translating between bottom and human-readable text

Available options:
  -b,--bottomify           Translate text to bottom
  -r,--regress             Translate bottom to human-readable text (futile)
  -V,--version             Prints version information
  -h,--help                Show this help text
$ cabal run bottom -- --regress πŸ«‚βœ¨βœ¨πŸ₯Ί,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨πŸ₯Ί,,,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨βœ¨βœ¨πŸ‘‰πŸ‘ˆπŸ«‚βœ¨βœ¨πŸ₯Ί,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨βœ¨πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨βœ¨βœ¨πŸ₯Ί,,πŸ‘‰πŸ‘ˆπŸ«‚βœ¨βœ¨πŸ₯Ί,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨πŸ₯Ί,,,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–πŸ’–βœ¨βœ¨πŸ₯Ί,πŸ‘‰πŸ‘ˆπŸ«‚βœ¨βœ¨πŸ₯Ί,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨βœ¨βœ¨πŸ‘‰πŸ‘ˆ πŸ’–πŸ’–βœ¨βœ¨βœ¨βœ¨πŸ‘‰πŸ‘ˆ
γŒγ‚“γ°γ‚Œ
$ cabal run bottom -- --bottomify Test
πŸ’–βœ¨βœ¨βœ¨,,,,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–,πŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨πŸ₯ΊπŸ‘‰πŸ‘ˆπŸ’–πŸ’–βœ¨πŸ₯Ί,πŸ‘‰πŸ‘ˆ

Usage as a library

See the generated Haddock documentation in Hackage for module documentation.

Development

Useful commands:

  • cabal run bottom -- --help: Runs the CLI.
  • cabal repl: Run the library in the REPL. Loads Data.Encoding.Bottom with -XOverloadedStrings by default (see .ghci).
  • cabal test --enable-coverage: Run tests, with test coverage.
  • cabal bench: Run benchmarks.
  • cabal haddock --haddock-all --enable-documentation: Generate documentation.
  • ormolu --mode inplace $(find . -path ./dist-newstyle -prune -false -o -type f -name '*.hs'): Format code (see ormolu).
  • cabal-fmt -i bottom.cabal: Format .cabal file (see cabal-fmt).

License

Apache 2.