https://github.com/schneidmaster/coffee-relay

Handle Relay.QL fragments in CoffeeScript.
https://github.com/schneidmaster/coffee-relay

Last synced: about 2 months ago
JSON representation

Handle Relay.QL fragments in CoffeeScript.

• Host: GitHub
• URL: https://github.com/schneidmaster/coffee-relay
• Owner: schneidmaster
• License: mit
• Created: 2016-06-28T02:24:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-28T02:24:39.000Z (over 8 years ago)
• Last Synced: 2024-10-17T02:29:31.940Z (3 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/coffee-relay.svg)](https://badge.fury.io/js/coffee-relay)

[![CircleCI](https://circleci.com/gh/schneidmaster/coffee-relay.svg?style=shield)](https://circleci.com/gh/schneidmaster/coffee-relay)

# coffee-relay

coffee-relay is a utility package to compile React.QL backtick queries before they're passed to the CoffeeScript compiler.

## Installation

```

npm install coffee-relay --save-dev

```

## How it works

CoffeeScript uses backticks to execute code directly as JavaScript. This conflicts with Relay's usage of backticks to write query fragments.

coffee-relay makes use of babel to compile Relay fragments into JavaScript, which is then inlined in the source CoffeeScript file using regular backtick syntax. For a few examples, check out the source and transpiled files under `test/fixtures`.

## Usage

``` javascript

var coffee = require('coffee-script');

var coffeeRelay = require('coffee-relay');

var schema = require('./data/schema.json')

var transpiled = coffeeRelay(fs.readFileSync('some-file.coffee').toString(), schema);

var compiled = coffee.compile(transpiled);

```

Alternatively, use the [webpack loader](https://www.npmjs.com/package/coffee-relay-loader).

## Testing

* `npm run test` to run the mocha tests.

## Contributing

1. Fork it ( https://github.com/schneidmaster/coffee-relay/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## License

MIT