Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evenchange4/graphql.macro
Compile GraphQL AST at build-time with babel-plugin-macros.
https://github.com/evenchange4/graphql.macro
babel-plugin-macros graphql-tag
Last synced: 8 days ago
JSON representation
Compile GraphQL AST at build-time with babel-plugin-macros.
- Host: GitHub
- URL: https://github.com/evenchange4/graphql.macro
- Owner: evenchange4
- License: mit
- Created: 2018-01-19T18:56:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T21:18:53.000Z (7 months ago)
- Last Synced: 2024-04-14T07:24:36.616Z (7 months ago)
- Topics: babel-plugin-macros, graphql-tag
- Language: JavaScript
- Size: 518 KB
- Stars: 241
- Watchers: 3
- Forks: 21
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - graphql.macro - time with babel-plugin-macros. | evenchange4 | 230 | (JavaScript)
README
# graphql.macro
> Compile GraphQL AST at build-time with babel-plugin-macros.
[![Travis][build-badge]][build]
[![Codecov Status][codecov-badge]][codecov]
[![npm package][npm-badge]][npm]
[![npm downloads][npm-downloads]][npm]
[![prettier][prettier-badge]][prettier]
[![license][license-badge]][license]
## Installation
```sh
$ yarn add graphql.macro
```
_Note: You'll need to install and configure [babel-plugin-macros](https://github.com/kentcdodds/babel-plugin-macros) if you haven't already._
## Example
[evenchange4/graphql.macro-example (with [email protected])](https://github.com/evenchange4/graphql.macro-example) [[DEMO](https://graphqlmacro.netlify.com/)]
## Usage
### `loader`
```js
import { loader } from 'graphql.macro';
const query = loader('./fixtures/query.graphql');
↓ ↓ ↓ ↓ ↓ ↓
const query = {
"kind": "Document",
"definitions": [{
...
```
### `gql`
```diff
-import gql from 'graphql-tag';
+import { gql } from 'graphql.macro';
const query = gql`
query User {
user(id: 5) {
lastName
...UserEntry1
}
}
`;
↓ ↓ ↓ ↓ ↓ ↓
const query = {
"kind": "Document",
"definitions": [{
...
```
## Alternative
- [Webpack preprocessing with graphql/loader](https://github.com/apollographql/graphql#webpack-preprocessing-with-graphqlloader)
- [Babel preprocessing](https://github.com/apollographql/graphql#babel-preprocessing)
- https://github.com/leoasis/graphql-tag.macro
## Development
### Requirements
- node >= 11.10.0
- yarn >= 1.13.0
```sh
$ yarn install --pure-lockfile
```
## Test
```sh
$ yarn run format
$ yarn run eslint
$ yarn run flow
$ yarn run test:watch
$ yarn run build
```
## Publish
```bash
$ npm version patch
$ npm run changelog
git commit & push
```
---
## CONTRIBUTING
- ⇄ Pull requests and ★ Stars are always welcome.
- For bugs and feature requests, please create an issue.
- Pull requests must be accompanied by passing automated tests.
## [CHANGELOG](CHANGELOG.md)
## [LICENSE](LICENSE)
MIT: [http://michaelhsu.mit-license.org](http://michaelhsu.mit-license.org)
[build-badge]: https://img.shields.io/travis/evenchange4/graphql.macro/master.svg?style=flat-square
[build]: https://travis-ci.org/evenchange4/graphql.macro
[npm-badge]: https://img.shields.io/npm/v/graphql.macro.svg?style=flat-square
[npm]: https://www.npmjs.org/package/graphql.macro
[codecov-badge]: https://img.shields.io/codecov/c/github/evenchange4/graphql.macro.svg?style=flat-square
[codecov]: https://codecov.io/github/evenchange4/graphql.macro?branch=master
[npm-downloads]: https://img.shields.io/npm/dt/graphql.macro.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/graphql.macro.svg?style=flat-square
[license]: http://michaelhsu.mit-license.org/
[prettier-badge]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square
[prettier]: https://github.com/prettier/prettier