https://github.com/bblfsh/uast-viewer
https://github.com/bblfsh/uast-viewer
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bblfsh/uast-viewer
- Owner: bblfsh
- License: apache-2.0
- Created: 2018-05-10T17:27:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-28T21:49:11.000Z (over 6 years ago)
- Last Synced: 2024-04-14T04:48:17.568Z (about 2 years ago)
- Language: JavaScript
- Size: 2.9 MB
- Stars: 7
- Watchers: 5
- Forks: 7
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/bblfsh/uast-viewer) [](https://greenkeeper.io/)
# UAST Viewer
`uast-viewer` is the simplest way to visualize [Universal Abstract Syntax Trees (UASTs)](https://doc.bblf.sh/uast/uast-specification.html).
## Features
- Drop-in component to display a UAST. [Example](https://uast-viewer.bblf.sh/#!/Uncontrolled)
- Get full control of the tree. [Example](https://uast-viewer.bblf.sh/#!/Controlled)
- Integration with online source code editor [Example](https://uast-viewer.bblf.sh/#!/With%20source%20code)
## Documentation
See the [documentation](https://uast-viewer.bblf.sh/) with live examples.
## Installation
1. Install UAST Viewer as a dependency
```bash
# Yarn
$ yarn add uast-viewer
# NPM
$ npm install uast-viewer
```
2. Import `uast-viewer` component
```js
import UASTViewer from 'uast-viewer';
```
3. Import styles by including `default-theme.css`
```js
import 'uast-viewer/dist/default-theme.css';
```
4. Render component with UAST JSON
```js
```
## Contribute
[Contributions](https://github.com/bblfsh/uast-viewer/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](CONTRIBUTING.md).
## Code of Conduct
All activities under source{d} projects are governed by the [source{d} code of conduct](https://github.com/bblfsh/guide/blob/master/.github/CODE_OF_CONDUCT.md).
## License
Apache License Version 2.0, see [LICENSE](LICENSE)