{"id":16964979,"url":"https://github.com/propensive/harlequin","last_synced_at":"2025-03-23T17:31:02.163Z","repository":{"id":80754937,"uuid":"430658483","full_name":"propensive/harlequin","owner":"propensive","description":"Syntax highlighting for Scala code","archived":false,"fork":false,"pushed_at":"2025-01-26T12:13:20.000Z","size":1539,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T22:21:57.311Z","etag":null,"topics":["scala","syntax-highlighting"],"latest_commit_sha":null,"homepage":"https://propensive.com/harlequin/","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":"2021-11-22T10:18:59.000Z","updated_at":"2025-01-26T12:13:23.000Z","dependencies_parsed_at":"2023-05-15T15:15:36.578Z","dependency_job_id":"188f6d2f-5707-4f7d-b970-93525557acde","html_url":"https://github.com/propensive/harlequin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fharlequin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fharlequin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fharlequin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fharlequin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/harlequin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245140855,"owners_count":20567457,"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":["scala","syntax-highlighting"],"created_at":"2024-10-13T23:44:45.695Z","updated_at":"2025-03-23T17:31:02.141Z","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/harlequin/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/harlequin/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# Harlequin\n\n__Syntax highlighting for Scala code__\n\nScala source code is nontrivial to parse, and while many syntax-highlighting scripts or\nconfigurations exist (for example, for editors), the complexity of the Scala language means that\nthey can make mistakes when encountering unusual combinations of tokens. _Harlequin_ uses the\nactual Scala compiler to ensure that code is parsed exactly as it would be during compilation.\n\nThe result of parsing code contains only three different types of token—spaces, newlines and\ncontent—which lend themselves to conversion to HTML or another format.\n\n## Features\n\n- Parses fragments of Scala code using the Scala compiler\n- Takes a string and returns a `List` of simple tokens\n- Tokens represent newlines, spaces and content, for easy transformation into other formats, like HTML\n- Content includes metadata to indicate its nature\n- Erroneous content may also be parsed\n- Parsing is fast; a short fragment will typically take a few milliseconds\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\n_Harlequin_ provides only a single method, `ScalaSyntax.highlight`, which takes a `Text` value and\nreturns a `List[Token]`, like so:\n```scala\nimport harlequin.*, gossamer.*\n\nval code = t\"def inc(x: Int): Unit =\\n  x + 1\"\nval tokens = ScalaSyntax.highlight(code)\n```\n\nThe returned value, `tokens`, for this example will be the following `List`:\n```scala\nList(Code(\"def\", Keyword), Space(1), Code(\"inc\", Term), Code(\"(\", Parens), Code(\"x\", Term),\n    Code(\":\", Symbol), Space(1), Code(\"Int\", Type), Code(\")\", Parens), Code(\":\", Symbol), Space(1),\n    Code(\"Unit\", Type), Space(1), Code(\"=\", Symbol), Newline, Space(2), Code(\"x\", Ident), Space(1),\n    Code(\"+\", Ident), Space(1), Code(\"1\", Number))\n```\n\nHere, each token is either, a space of a particular size, for example, `Space(2)` represents two\nspace characters, a `Newline`, or a fragment of code, consisting of the text with an \"accent\"; an\nindication of the meaning of that code token.\n\n### Accents\n\nThe accent will be one of the following possible values:\n\n- `Error`, an erroneous token,\n- `Ident`, a reference to a term,\n- `Keyword`, a non-modifier keyword,\n- `Modifier`, a modifier keyword,\n- `Number`, a number literal,\n- `Parens`, parenthesis,\n- `String`, a string literal (including interpolated strings),\n- `Term`, a term definition,\n- `Type`, a type definition.\n\nTypically, these would be mapped to different colors during conversion to markup.\n\nIt is likely that as Harlequin evolves, the set of `Accent` values will grow.\n\n\n\n\n\n## Status\n\nHarlequin is classified as __fledgling__. 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\nHarlequin is designed to be _small_. Its entire source code currently consists\nof 229 lines of code.\n\n## Building\n\nHarlequin 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 Harlequin?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Harlequin'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 Harlequin 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 `harlequin`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Harlequin'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 Harlequin are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/harlequin/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Harlequin\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\nHarlequin 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\nA harlequin's clothes are a patchwork of bright colors, much as highlighted source code is.\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 the motley pattern of a harlequin.\n\n## License\n\nHarlequin 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%2Fharlequin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fharlequin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fharlequin/lists"}