{"id":16965034,"url":"https://github.com/propensive/hyperbole","last_synced_at":"2025-04-05T15:46:11.467Z","repository":{"id":80754925,"uuid":"586300696","full_name":"propensive/hyperbole","owner":"propensive","description":"Assintance with Scala 3 metaprogramming","archived":false,"fork":false,"pushed_at":"2025-01-23T19:41:55.000Z","size":2223,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T20:49:18.526Z","etag":null,"topics":["compile-time","macros","metaprogramming","scala","static-analysis"],"latest_commit_sha":null,"homepage":"https://propensive.com/hyperbole","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-01-07T16:46:53.000Z","updated_at":"2025-01-23T19:41:59.000Z","dependencies_parsed_at":"2023-11-16T09:25:55.910Z","dependency_job_id":"8889c40f-6280-43f3-bdbe-b73970c72889","html_url":"https://github.com/propensive/hyperbole","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%2Fhyperbole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhyperbole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhyperbole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhyperbole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/hyperbole/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":["compile-time","macros","metaprogramming","scala","static-analysis"],"created_at":"2024-10-13T23:44:52.690Z","updated_at":"2025-04-05T15:46:07.313Z","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/hyperbole/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/hyperbole/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# Hyperbole\n\n__Assistance with Scala 3 metaprogramming__\n\nHyperbole is a nascent set of tools to make it easier to write macros in Scala.\nTo begin, it includes an `introspect` method which can provide useful\nreflection detail about how the source of an expression translates into an AST.\n\n## Features\n\n- See a full introspection of an expression's AST\n- Renders the AST structure in an easy-to-read tree format\n- View source code alongside the AST\n- Also view the \"expanded\" source code alongside, showing \"invisible\" syntax\n- Produces output at compiletime or runtime, invoked inside or outside of a macro\n\n\n## Availability\n\n\n\n## Getting Started\n\nHyperbole runs at compiletime to inspect an expression, but can present its\noutput in different ways:\n- as a message reported at compiletime\n- as a terminal compile error\n- as a value which can be used in some way at runtime\n\nIt can be invoked on an expression in ordinary code, or in an inline context\nwhere a `Quotes` instance is available, on a lifted `Expr` or a `Tree` value.\n\nIn all cases, the macro is invoked with an `introspect` method, either passing\nthe expression to be inspected, or a lifted `Expr` expression value in a quoted\ncontext, disambiguated by overloading. In a quoted context, an additional\noptional parameter, `terminate`, may be specified as `true` to indicate that\nthe output should be reported as a compiler error rather than an informational\nmessage at compiletime; by default it is `false`.\n\nA contextual `Introspection` value determines what result should be yielded\nfrom a call to `introspect`. This given value can determine not only the result\ntype, but whether the expression is evaluated or its value retained. Three\nimplementations offered:\n\n- `introspection.println`—records the introspection details to `stdout` with\n  `println`, and returns the expression value\n- `introspection.text`—constructs a `Text` value containing the introspection\n  details, ignoring the expression without evaluating it\n\nThe default is to log using Eucalyptus. Note that this contextual value is not\nnecessary for the `introspect` method that take an `Expr` value.\n\nFor example, in a macro method body,\n```scala\nimport hyperbole.*\ndef macroImpl(expr: Expr[T])(using Quotes): Expr[Unit] =\n  import quotes.reflect.*\n  introspect(expr, terminate = true)\n```\nor, for example, in a [Probably](https://github.com/propensive/probably/) test,\n```scala\nimport hyperbole.*, introspection.log\nimport probably.*\nimport eucalyptus.*, logging.stdout\n\ntest(t\"Two joined lists are not empty\"):\n  val xs = List(1)\n  val ys = List(2)\n  introspect(xs ++ ys)\n.assert(!_.isEmpty)\n\n```\n\n\n\n\n\n## Status\n\nHyperbole is classified as __embryonic__. 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\nHyperbole is designed to be _small_. Its entire source code currently consists\nof 79 lines of code.\n\n## Building\n\nHyperbole 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 Hyperbole?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Hyperbole'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 Hyperbole 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 `hyperbole`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Hyperbole'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 Hyperbole are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/hyperbole/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Hyperbole\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\nHyperbole 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_Hyperbole_ is a tool for working with macros (short for _macroinstructions_) whose name implies a large—or hyperbolic—size.\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 a set of shapes formed from hyperbolic curves, reminiscent of a butterfly.\n\n## License\n\nHyperbole is copyright \u0026copy; 2024 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%2Fhyperbole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fhyperbole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fhyperbole/lists"}