# @buxlabs/ruby-ast

> Ruby to abstract syntax tree converter

Latest version **0.1.0** (published 2017-11-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @buxlabs/ruby-ast
pnpm add @buxlabs/ruby-ast
yarn add @buxlabs/ruby-ast
bun add @buxlabs/ruby-ast
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2017-11-25 |
| First published | 2017-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emil Ajdyna |
| Maintainers | buxlabs |
| Keywords | ruby, ast, converter |

## Links

- npm: https://www.npmjs.com/package/@buxlabs/ruby-ast
- Repository: https://github.com/buxlabs/ruby-ast
- Homepage: https://github.com/buxlabs/ruby-ast#readme
- Issues: https://github.com/buxlabs/ruby-ast/issues
- npm.io page: https://npm.io/package/@buxlabs/ruby-ast

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2017-11-25

## README

# ruby-ast

Ruby to abstract syntax tree converter

## Requirements

- ruby 1.9+

## Why?

Some libraries like rollup or webpack can use assets in various formats to build applications. This tool should be able to convert Ruby code into an abstract syntax tree that can be consumed or converted by other tools, e.g. such that convert ruby to js, which in the end would let you use ruby in js apps.

## How does it work?

This package uses `Ripper` which is a Ruby script parser from the standard library. The method `Ripper.sexp` is called in a child process via a tiny cli script and returns a json with an abstract syntax tree (a symbolic expression tree, called S-expression).

## Examples

```js
import { convert } from '@buxlabs/ruby-ast'
convert('puts "Hello world!"')
.then(result => {
  console.log(result) // [ 'program', [ [ 'command', [Array], [Array] ] ] ]
}) 
```

## Status

Experimental, as most of Ripper methods are not locked. Not suggested for production use.

Instead of relying on a builtin parser it could also be a js lib without any dependencies but the maintenance cost is currently too high.

## Todo

- find good s-expression docs,
- add more tests,
- add benchmarks,
- consider other execution approaches,
- expose other Ripper methods

---
_Source: https://npm.io/package/@buxlabs/ruby-ast · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
