{"id":16965007,"url":"https://github.com/propensive/yossarian","last_synced_at":"2025-08-05T15:24:07.342Z","repository":{"id":210426133,"uuid":"726535392","full_name":"propensive/yossarian","owner":"propensive","description":"The insanity of terminal emulation","archived":false,"fork":false,"pushed_at":"2025-01-26T12:16:40.000Z","size":1185,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T20:49:20.633Z","etag":null,"topics":["ansi-escapes","console","console-emulator","headless","pty","scala","terminal-emulation","terminal-emulator","tty"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-02T17:02:50.000Z","updated_at":"2025-01-26T12:16:43.000Z","dependencies_parsed_at":"2023-12-20T11:03:26.515Z","dependency_job_id":"4cac464b-6241-414d-9a23-c93185055b92","html_url":"https://github.com/propensive/yossarian","commit_stats":null,"previous_names":["propensive/yossarian"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fyossarian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fyossarian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fyossarian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fyossarian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/yossarian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361598,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi-escapes","console","console-emulator","headless","pty","scala","terminal-emulation","terminal-emulator","tty"],"created_at":"2024-10-13T23:44:49.212Z","updated_at":"2025-04-05T15:46:02.743Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/yossarian/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/yossarian/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Yossarian\n\n__The insanity of terminal emulation__\n\n_Yossarian_ is a headless terminal emulator. It receives input, as a stream of\nbytes, and interprets it to maintain the state of a terminal, of some size. In\nparticular, most standard any many common escape sequences will be interpreted\nto modify the terminal's content (including colors and styles), cursor\nposition, and hyperlinks.\n\n## Features\n\n- interprets ANSI control sequences, notably CSI and SGR codes\n- terminals of any dimensions can be emulated\n- the graphic rendition of each character cell is tracked independently\n- hyperlinks are also tracked for each cell\n- take snapshots of the terminal\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\nAll terms and types are defined in the `yossarian` package:\n```scala\nimport yossarian.*\n```\n\n### Create a new Pseudo-Terminal\n\nAn instance of `Pty`, representing a pseudo-terminal (PTY), is the main\nentry-point to Yossarian's features. We can create one by specifying its width\nand height:\n```scala\nval pty = Pty(80, 24)\n```\n\nThis represents a screen size of 80×24 characters, white-on-black text, with a\ncursor in the top-left corner, and no interesting text styles.\n\n### Updating PTY state\n\nInput may be provided to the `Pty` instance by supplying it as a `Text` value\nto the `consume` method. For example,\n```scala\nval pty2 = pty.consume(t\"Hello world\\n\")\n```\n\nThis will construct a new `Pty` with the words `Hello world` on its virtual\nscreen, and move the cursor to the start of the next line. This is an immutable\noperation, so the original state of `pty` will be unchanged.\n\n### Accessing PTY state\n\nChanging the state of the PTY is not useful unless we can inspect its state! We\ncan access much of that state through `pty.buffer`, and instance of\n`ScreenBuffer`.\n\nA `ScreenBuffer` represents a rectangular region of characters in the\npseudo-terminal, which may not be the entire terminal window, and provides the\nfollowing methods:\n - `width` and `height`, to get the buffer's dimensions\n - `char(x, y)`, to get the character at a particular position\n - `style(x, y)`, to get the `Style` instance for a position\n - `link(x, y)`, to get the link text applied to the position\n - `line`, to get a new `ScreenBuffer` of the entire screen as a single line\n - `render`, to get the textual content of the screen\n - `styles`, to get an array of the `Style`s for each character in the buffer\n - `find(text)`, to get a smaller `ScreenBuffer` whose content matches the\n   search text\n\nA `Style` value provides information on the visual style of a single character\nin a `ScreenBuffer`. It includes the properties, `bold`, `italic`, `blink`\n(blinking text), `faint`, `conceal` (invisible text), `strike`\n(strike-through), `underline`, `reverse` (inverted colors), `foreground`\n(color) and `background` (color).\n\n#### Interactivity\n\nA pseudoterminal sometimes needs to _produce_ output to communicate with the\nprocess controlling it. For example, if the PTY receives the escape codes to\nquery its size, it needs to respond through some channel.\n\nThe `stream` method of `Pty` will provide a stream of `Text` output from the\npseudo-terminal, which the controlling process and read and interpret\naccordingly.\n\n\n\n\n## Status\n\nYossarian is classified as __embryotic__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nYossarian is designed to be _small_. Its entire source code currently consists\nof 455 lines of code.\n\n## Building\n\nYossarian will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Yossarian?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Yossarian's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Yossarian and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `yossarian`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Yossarian's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Yossarian are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/yossarian/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Yossarian\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nYossarian was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\n_Yossarian_ was the protagonist in Joseph Heller's _Catch 22_, in which he desires to be declared _insane_ in order to be excused from flying combat missions. But in doing so, he must request an evaluation, which only a _sane_ person would do, and would thus be considered proof of sanity. This library makes it possible to evaluate the sanity of terminal output.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nThe logo shows an abstract depiction of some rows of content in a console.\n\n## License\n\nYossarian is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fyossarian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fyossarian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fyossarian/lists"}