### ----------------------------------------------------
### -- CoreHackers::Q
### -- Licenses: Artistic-2.0
### -- Authors: Zoffix Znet, Raku community modules team
### -- File: README.md
### ----------------------------------------------------
[![Actions Status](https://github.com/raku-community-modules/CoreHackers-Q/workflows/test/badge.svg)](https://github.com/raku-community-modules/CoreHackers-Q/actions)

CoreHackers::Q
==============

QAST tree visualizer

DESCRIPTION
===========

Installs `q` command line script that parses out QAST trees from a program and makes an HTML file from them.

The HTML page provides these extra features unavailable in plain `raku --target=ast` and `raku --target=optimize` output:

  * Control-click on individual tree nodes to collapse/expand them

  * Color coding: of sunk nodes, `QAST::Want` alternatives, static and non-static

calls, etc.

Example output:

[An example](example.png)

USAGE
=====

        Usage:
          q a '[<args> ...]'
          q o '[<args> ...]'

`a` command
-----------

```bash
$ q a raku -e 'say "hello"' > out.html; google-chrome out.html
```

`a` stands for `--target=ast` and the args that follow is a `raku` invocation to run the script (the `--target=ast` argument will be inserted automatically).

The script will parse QAST generated by the given `raku` program and output an HTML file to STDOUT. View the file in any browser to examine the QAST tree.

`o` command
-----------

```bash
$ q o raku -e 'say "hello"' > out.html; google-chrome out.html
```

`o` stands for `--target=optimize` . Same as `a` , except parses `--target=optimize` QAST. Once again, you don't need to manually specify `--target` parameter.

`z` command
-----------

```bash
$ q z raku -e 'say "hello"'
```

Just runs the raku command as is. Mnemonic: "zero". This command exists simply to easily switch between ``a`/`o`` runs and plain raku runs.

----------------------------------------------------------------------------------------------------

Meta
----

### REPOSITORY

Fork this module on GitHub: https://github.com/raku-community-modules/CoreHackers-Q

### BUGS

To report bugs or request features, please use https://github.com/raku-community-modules/CoreHackers-Q/issues

### AUTHOR

Originally Zoffix Znet, now maintained by the Raku Community Adoption Center.

### LICENSE

You can use and distribute this module under the terms of the The Artistic License 2.0. See the `LICENSE` file included in this distribution for complete details.

The `META6.json` file of this distribution may be distributed and modified without restrictions or attribution.



