https://github.com/eibens/ansiml
AnsiML is a markup language for ANSI colors in TypeScript for Deno.
https://github.com/eibens/ansiml
ansi colors deno formatting markup-language terminal typescript
Last synced: about 2 months ago
JSON representation
AnsiML is a markup language for ANSI colors in TypeScript for Deno.
- Host: GitHub
- URL: https://github.com/eibens/ansiml
- Owner: eibens
- License: mit
- Created: 2021-06-10T09:47:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T00:13:55.000Z (about 3 years ago)
- Last Synced: 2025-01-22T13:47:59.774Z (over 1 year ago)
- Topics: ansi, colors, deno, formatting, markup-language, terminal, typescript
- Language: TypeScript
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [AnsiML] - Markup Language for ANSI Colors
AnsiML is a library for inserting [ANSI Colors] into strings, implemented in
TypeScript for [Deno]. Text and colors are strictly separated, thus enabling
semantic operations on ANSI colored text and rendering to different output
formats.
[![License][license-shield]](LICENSE) [![Deno doc][deno-doc-shield]][deno-doc]
[![Deno module][deno-land-shield]][deno-land]
[![Github tag][github-shield]][github] [![Build][build-shield]][build]
[![Code coverage][coverage-shield]][coverage]
[github]: https://github.com/eibens/ansiml
[github-shield]: https://img.shields.io/github/v/tag/eibens/ansiml?label&logo=github
[coverage-shield]: https://img.shields.io/codecov/c/github/eibens/ansiml?logo=codecov&label
[license-shield]: https://img.shields.io/github/license/eibens/ansiml?color=informational
[coverage]: https://codecov.io/gh/eibens/ansiml
[build]: https://github.com/eibens/ansiml/actions/workflows/ci.yml
[build-shield]: https://img.shields.io/github/actions/workflow/status/eibens/ansiml/ci.yml?branch=main
[deno-doc]: https://doc.deno.land/https/deno.land/x/ansiml/mod.ts
[deno-doc-shield]: https://img.shields.io/badge/doc-informational?logo=deno
[deno-land]: https://deno.land/x/ansiml
[deno-land-shield]: https://img.shields.io/badge/x/ansiml-informational?logo=deno&label
# Introduction
[ANSI colors] are character codes for adding colors to console output. Yet, once
the color codes are mixed with the text, operations on the text become
difficult. Consider these scenarios:
- We want to print colored text with a maximum of 80 columns. If we do not
handle the color codes while calculating the positions of the line breaks, the
lines will end up shorter than they need to be.
- We want to print syntax-highlighted source code with colored line numbers to
the console. Inserting the line numbers into the source might break the parser
of the syntax highlighter. Inserting the line numbers after syntax
highlighting might overwrite the colors of the highlighted code.
[AnsiML] solves this with an intermediate representation that keeps color codes
separate from the actual text. It represents colored text as a tree of terminal
string values and non-terminal node objects. Each node object can have a
sequence of color commands, allowing for hierarchical styling of the text. See
the [examples](./examples/) folder for more.
# Features
- Rendering to ANSI colored text, HTML, or plain text.
- JSX runtime for using JSX syntax to create AnsiML trees.
- Generic `stringify` function for custom commands and output formats.
- High-level `Styled` component for nicer dev experience.
# Note on jsx-runtime
The modern way of configuring JSX is via the `jsxImportSource` compiler option,
specified either in the `compilerOptions` section or as a pragma comment. This
can be an URL or bare specifier (defined in an import map). TypeScript will then
append `/jsx-runtime` to this specifier and try to import it as a module. This
module is expected to export the JSX related functions, such as `jsx`, `jsxs`,
and `Fragment`.
Unfortunately, Deno will fail to interpret a module named `jsx-runtime` as a
TypeScript module because it does not end in `.ts` or `.tsx`. The workaround is
to host the module on a CDN that serves the module with the correct MIME type.
In order to run the examples in the repository locally, use
`deno run -A server.ts`.
As of May 2023, [https://deno.land/x/](https://deno.land/x/) does not serve the
module with the correct MIME type. Use the legacy configuration via `jsxFactory`
and `jsxFragmentFactory` or the pragma comments `@jsx` and `@jsxFrag` instead.
Import `h` and `Fragment` from [mod.ts]. Wait until
[this issue](https://github.com/denoland/dotland/issues/2212) is resolved.
[AnsiML]: #
[mod.ts]: mod.ts
[ansi.ts]: ansi.ts
[ANSI colors]: https://en.wikipedia.org/wiki/ANSI_escape_code
[Deno]: https://deno.land/
[ANSI colors module]: https://deno.land/std/fmt/colors.ts