https://github.com/tiago154/graphql-import-files

Light and easy package that will load .graphql files and use them with syntax highlighting
https://github.com/tiago154/graphql-import-files

apollo-server gql graphql graphql-files graphql-js hacktoberfest import import-file import-graph light syntax-highlighting

Last synced: about 2 months ago
JSON representation

Light and easy package that will load .graphql files and use them with syntax highlighting

• Host: GitHub
• URL: https://github.com/tiago154/graphql-import-files
• Owner: tiago154
• License: mit
• Created: 2020-02-01T19:56:30.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T12:14:43.000Z (about 1 year ago)
• Last Synced: 2024-05-16T18:23:40.795Z (7 months ago)
• Topics: apollo-server, gql, graphql, graphql-files, graphql-js, hacktoberfest, import, import-file, import-graph, light, syntax-highlighting
• Language: TypeScript
• Homepage:
• Size: 969 KB
• Stars: 19
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![npm](https://img.shields.io/npm/dy/graphql-import-files?color=%2303a1fc&style=for-the-badge)](https://npm-stat.com/charts.html?package=graphql-import-files)





[![Build Status](https://travis-ci.com/tiago154/graphql-import-files.svg?branch=master)](https://travis-ci.com/tiago154/graphql-import-files)

[![Coverage Status](https://coveralls.io/repos/github/tiago154/graphql-import-files/badge.svg)](https://coveralls.io/github/tiago154/graphql-import-files)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/tiago154/graphql-import-files)

[![Npm Version](https://img.shields.io/npm/v/graphql-import-files.svg)](https://www.npmjs.com/package/graphql-import-files)

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/tiago154/graphql-import-files)



# graphql-import-files

Light and easy package that will load .graphql files and use them with syntax highlighting.

## Install

```sh

npm i -S graphql-import-files

```

## Usage:

## Loading a single file

For example, your files and folders look like this:

```

root

├──src

  ├──index.js

  ├──schema

    ├──schema.graphql

```

Use the function ``loadFile`` that will load a single file.

```js

// index.js

const { ApolloServer } = require('apollo-server')

const { loadFile } = require('graphql-import-files')

const resolvers = require('./resolvers')

const server = new ApolloServer({

  typeDefs: loadFile('./schema/schema.graphql'), // Always consider the path at the root of the project

  resolvers

})

server.listen().then(({ url }) => {

  console.log(`Running on ${url}`)

})

```

**The `loadFile` function supports the `#import` annotation and this will allow you to load other files as if it were the import in a js file.**

```

root

├──src

  ├──index.js

  ├──schema

    ├──schema.graphql

    ├──user

      ├──user.graphql

    ├──location

      ├──location.graphql

```

./src/schema/schema.graphql

```graphql

#import './user/user.graphql'

#import './location/location.graphql'

type Query {

  user(id: ID!): User

  location(id: ID!): Location

}

```

./src/schema/user/user.graphql

```graphql

type User {

  id: ID!

  name: String!

}

```

./src/schema/location/location.graphql

```graphql

type Location {

  id: ID!

  name: String!

}

```

```js

// index.js

// ...

const { loadFile } = require('graphql-import-files')

const server = new ApolloServer({

  typeDefs: loadFile('./schema/schema.graphql'), // Always consider the path at the root of the project

  resolvers

})

// ...

```

## Loading multiple files

For example, your files and folders look like this:

```

root

├──src

  ├──index.js

  ├──schemas

    ├──query.graphql

    ├──user

      ├──user.gql

      ├──role.gql

    ├──product

      ├──product.graphql

```

Use the function ``loadFiles`` that will load multiple files.

```js

// index.js

const { ApolloServer } = require('apollo-server')

const { loadFiles } = require('graphql-import-files')

const resolvers = require('./resolvers')

const server = new ApolloServer({

  typeDefs: loadFiles('**/schemas/**/*.{graphql,gql}'), // Use the glob pattern to find multiple files

  resolvers

})

server.listen().then(({ url }) => {

  console.log(`Running on ${url}`)

})

```