# gemfile

> A Gemfile.lock parser for Node.js represented with JSON.

Latest version **1.1.0** (published 2018-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gemfile
pnpm add gemfile
yarn add gemfile
bun add gemfile
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-09-03 |
| First published | 2016-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.2.4 |
| Dependencies | 0 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Trey Cordova |
| Maintainers | treycordova |
| Keywords | Gemfile, Gemfile.lock, parser, Ruby, Rails, Gems, RubyGems |

## Links

- npm: https://www.npmjs.com/package/gemfile
- Repository: github.com/treycordova/gemfile
- npm.io page: https://npm.io/package/gemfile

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-09-03
- 1.0.0 — 2016-01-11

## README

## gemfile [![Build Status](https://travis-ci.org/treycordova/gemfile.svg?branch=master)](https://travis-ci.org/treycordova/gemfile) [![Version Status](https://img.shields.io/npm/v/gemfile.svg)](https://www.npmjs.org/package/gemfile)
### A Gemfile.lock parser for Node.js represented with JSON.
#### Installation
```bash
$ npm install gemfile
```
#### API
```javascript
// Takes a path to a Gemfile.lock.
parse(filename) // String => Promise => String
parseSync(filename) // String => String

// Takes the Gemfile.lock in String format.
interpret(gemfile) // String => String
```
#### Output Expectations
1. Anything that looks like a path will be identifiable by `.path`.
2. Anything that looks like a package version will be identifiable by `.version`.
3. Anything that uses a remote resource that is **not** [https://rubygems.org](https://rubygems.org) will be identifiable by `.outsourced`.
4. Anything that looks like a SHA-1 will be identifiable by `.sha`.
6. Everything other than "BUNDLED WITH" is an object.
5. "BUNDLED WITH" is _not_ an Object, but rather a String containing the version.

#### Tests
```bash
$ npm test
```

#### Contributions
Please feel free to improve the script and submit a [pull request](https://github.com/treycordova/gemfile/compare).

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