graphql-tag vs graphql-tools vs optics-ts vs graphql-codegen
GraphQL Utility Libraries Comparison
Search packages..
1 Year
graphql-taggraphql-toolsoptics-tsgraphql-codegenSimilar Packages:
What's GraphQL Utility Libraries?

These packages enhance the development experience when working with GraphQL by providing tools for code generation, query parsing, schema manipulation, and performance monitoring. They streamline the process of building, managing, and optimizing GraphQL APIs, making it easier for developers to create robust applications while ensuring type safety and performance efficiency.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
graphql-tag7,638,9752,340-1004 years agoMIT
graphql-tools767,9095,3962.73 kB1712 months agoMIT
optics-ts172,355857137 kB202 years agoMIT
graphql-codegen15,8003,044-382-MIT
Feature Comparison: graphql-tag vs graphql-tools vs optics-ts vs graphql-codegen

Code Generation

  • graphql-tag:

    graphql-tag does not provide code generation features but allows you to define and parse queries in a concise manner, which can complement code generation tools by ensuring queries are correctly formatted.

  • graphql-tools:

    graphql-tools focuses on schema definition and manipulation rather than code generation, allowing developers to create and modify schemas programmatically, which can be useful in dynamic environments.

  • optics-ts:

    optics-ts does not offer code generation capabilities but provides performance monitoring tools that can help identify issues in your GraphQL queries, enhancing overall application performance.

  • graphql-codegen:

    graphql-codegen automates the generation of TypeScript types and resolvers based on your GraphQL schema, significantly reducing the manual effort required to maintain type safety across your application.

Schema Management

  • graphql-tag:

    graphql-tag is primarily for query parsing and does not handle schema management, focusing instead on the client-side aspect of GraphQL queries.

  • graphql-tools:

    graphql-tools excels in schema management, allowing developers to create, merge, and manipulate schemas easily, making it ideal for complex applications with multiple schemas.

  • optics-ts:

    optics-ts does not manage schemas but provides insights into how schemas perform under load, helping developers optimize their GraphQL APIs.

  • graphql-codegen:

    graphql-codegen does not directly manage schemas but generates types based on existing schemas, ensuring that your application stays in sync with your GraphQL API.

Performance Monitoring

  • graphql-tag:

    graphql-tag does not include performance monitoring capabilities; its focus is on simplifying query management for clients.

  • graphql-tools:

    graphql-tools does not offer performance monitoring but provides tools for creating efficient resolvers and schema definitions, which can indirectly improve performance.

  • optics-ts:

    optics-ts is specifically designed for performance monitoring, allowing developers to track the execution time of queries and mutations, helping to identify performance bottlenecks.

  • graphql-codegen:

    graphql-codegen does not provide performance monitoring features but ensures that the generated code is optimized for type safety and maintainability.

Learning Curve

  • graphql-tag:

    graphql-tag is easy to learn, especially for developers already familiar with GraphQL, as it simplifies the process of defining and using queries in client applications.

  • graphql-tools:

    graphql-tools may have a steeper learning curve due to its extensive features for schema manipulation, but it is well-documented and provides powerful capabilities for advanced users.

  • optics-ts:

    optics-ts has a moderate learning curve, as understanding performance monitoring concepts is essential, but it offers clear documentation to help developers get started.

  • graphql-codegen:

    graphql-codegen has a moderate learning curve, especially for those unfamiliar with code generation tools, but its documentation and examples make it accessible for most developers.

Extensibility

  • graphql-tag:

    graphql-tag is not designed for extensibility; it serves a specific purpose of query parsing and does not support plugin architecture.

  • graphql-tools:

    graphql-tools is extensible, enabling developers to create custom schema directives and resolvers, which can enhance the functionality of their GraphQL APIs.

  • optics-ts:

    optics-ts is somewhat extensible, allowing integration with other monitoring tools, but it primarily focuses on performance insights specific to GraphQL.

  • graphql-codegen:

    graphql-codegen is highly extensible, allowing developers to create custom plugins to generate additional artifacts or modify the code generation process to fit their needs.

How to Choose: graphql-tag vs graphql-tools vs optics-ts vs graphql-codegen
  • graphql-tag:

    Opt for graphql-tag if you need a simple way to parse GraphQL queries into a format that can be used by Apollo Client or other GraphQL clients, making it easier to manage queries in your application.

  • graphql-tools:

    Select graphql-tools if you require advanced schema manipulation capabilities, such as merging schemas, creating mock data, or defining custom resolvers, which can be particularly useful in complex applications.

  • optics-ts:

    Use optics-ts if you want to monitor and analyze the performance of your GraphQL operations, providing insights into query execution times and helping to identify bottlenecks in your API.

  • graphql-codegen:

    Choose graphql-codegen if you want to automate the generation of TypeScript types, resolvers, and other artifacts from your GraphQL schema, enhancing type safety and reducing boilerplate code.

Similar Npm Packages to graphql-tag

graphql-tag is a popular library used in JavaScript applications to parse GraphQL query strings into a format that can be understood by GraphQL clients. It provides a simple way to define and manage GraphQL queries and mutations, enabling developers to work with GraphQL in a more structured manner. While graphql-tag is widely used, there are several alternatives in the GraphQL ecosystem that offer different functionalities. Here are a few notable alternatives:

  • apollo-client is a comprehensive state management library for JavaScript that enables you to manage both local and remote data with GraphQL. It provides powerful features such as caching, optimistic UI updates, and support for subscriptions. Apollo Client integrates seamlessly with React and other frameworks, making it a popular choice for developers looking to build applications that leverage GraphQL. If you need a robust solution for managing GraphQL data and want to take advantage of advanced features, Apollo Client is an excellent option.
  • graphql-tools is a set of utilities for building and manipulating GraphQL schemas. It allows developers to create, merge, and extend GraphQL schemas easily. With graphql-tools, you can define your schema using a simple syntax and then enhance it with resolvers, middleware, and other functionalities. If your focus is on schema design and manipulation rather than just querying data, graphql-tools provides the necessary tools to create a powerful GraphQL API.
  • graphql.macro is a library that allows you to use GraphQL queries as template literals in your code without the need for a separate parsing step. It leverages Babel macros to enable a more concise and readable syntax for defining GraphQL queries. If you prefer a more streamlined approach to writing GraphQL queries directly in your components, graphql.macro can simplify your workflow significantly.

To see how graphql-tag compares with apollo-client, graphql-tools, and graphql.macro, check out the comparison: Comparing apollo-client vs graphql-tag vs graphql-tools vs graphql.macro.

Similar Npm Packages to graphql-tools

graphql-tools is a powerful set of utilities for building GraphQL schemas and resolvers in JavaScript. It provides developers with tools to create, manipulate, and extend GraphQL schemas easily, making it a popular choice for those looking to implement GraphQL in their applications. With features like schema stitching, merging, and type definitions, graphql-tools simplifies the process of building a robust GraphQL API. However, there are other libraries in the GraphQL ecosystem that also serve similar purposes. Here are a few alternatives:

  • apollo-server is a community-driven, open-source GraphQL server that is designed to work seamlessly with Apollo Client. It provides a straightforward way to set up a GraphQL server with built-in support for features like subscriptions, file uploads, and more. apollo-server is ideal for developers looking for a comprehensive solution that integrates well with the Apollo ecosystem, making it easier to manage both client and server-side GraphQL implementations. Its extensive documentation and community support make it a go-to choice for many developers.
  • express-graphql is a middleware for integrating GraphQL with Express, one of the most popular web frameworks for Node.js. It allows developers to create a GraphQL API quickly and easily by leveraging the existing Express infrastructure. express-graphql is a great choice if you are already using Express in your application and want to add GraphQL capabilities without introducing a new framework. It provides a simple way to define your schema and resolvers while benefiting from the flexibility and middleware capabilities of Express.

To see how graphql-tools compares with apollo-server and express-graphql, check out the comparison: Comparing graphql-tools vs apollo-server vs express-graphql.

Similar Npm Packages to optics-ts

optics-ts is a TypeScript library designed for working with GraphQL queries and mutations in a more type-safe and efficient manner. It provides a way to define and manipulate GraphQL queries using optics, which are a functional programming concept that allows for safe and composable access to deeply nested data structures. This makes it easier to build and maintain complex GraphQL applications while ensuring type safety and reducing runtime errors. While optics-ts offers a unique approach to handling GraphQL, there are several alternatives in the ecosystem that also provide useful functionalities. Here are a few alternatives:

  • graphql-codegen is a powerful tool that generates TypeScript typings, resolvers, and other artifacts based on your GraphQL schema and operations. It helps developers avoid manual typing and ensures that your code is always in sync with your GraphQL schema. If you are looking for a way to automate the generation of TypeScript types and improve the developer experience when working with GraphQL, graphql-codegen is an excellent choice.
  • graphql-tag is a library that allows you to parse GraphQL queries into the format that Apollo Client and other GraphQL clients can understand. It provides a simple way to define your GraphQL queries using template literals, making it easy to integrate GraphQL into your React applications. If you are looking for a straightforward way to handle GraphQL queries in your application, graphql-tag is a great option.
  • graphql-tools is a set of utilities for building and manipulating GraphQL schemas. It provides functionalities for merging schemas, creating mock data, and defining resolvers, making it a versatile tool for GraphQL development. If you need to build complex GraphQL servers or need to manipulate schemas, graphql-tools is a valuable resource.

To see how optics-ts compares with graphql-codegen, graphql-tag, and graphql-tools, check out the comparison: Comparing graphql-codegen vs graphql-tag vs graphql-tools vs optics-ts.

Similar Npm Packages to graphql-codegen

graphql-codegen is a powerful tool designed to automate the generation of TypeScript typings, resolvers, and other code artifacts from GraphQL schemas. It streamlines the development process by reducing the amount of boilerplate code developers need to write, ensuring type safety and consistency across applications. While graphql-codegen is a robust solution, there are other libraries in the GraphQL ecosystem that serve similar purposes. Here are a few alternatives:

  • apollo-codegen was a tool specifically designed for generating TypeScript typings from GraphQL queries and schemas used in Apollo Client applications. Although it has been largely superseded by other tools, it was popular for its ability to integrate seamlessly with Apollo's ecosystem. If you are working with older Apollo projects, you might still encounter this tool, but it's worth noting that it is not actively maintained anymore.
  • graphql-code-generator is another widely used tool that serves a similar purpose to graphql-codegen. It provides a flexible and extensible way to generate TypeScript typings, resolvers, and other code artifacts from GraphQL schemas. With a rich plugin ecosystem, it allows developers to customize the generated output to fit their specific needs. If you are looking for a comprehensive solution with a strong community and support, graphql-code-generator is an excellent choice.
  • graphql-tools is a library that provides utilities for building and manipulating GraphQL schemas. While its primary focus is not on code generation, it can be used in conjunction with other tools to create a more robust development workflow. It allows developers to compose schemas, create mock data, and define resolvers, making it a valuable addition to any GraphQL project.

For a detailed comparison of these packages, check out: Comparing apollo-codegen vs graphql-code-generator vs graphql-codegen vs graphql-tools.

README for graphql-tag

graphql-tag

npm version Build Status Get on Slack

Helpful utilities for parsing GraphQL queries. Includes:

  • gql A JavaScript template literal tag that parses GraphQL query strings into the standard GraphQL AST.
  • /loader A webpack loader to preprocess queries

graphql-tag uses the reference graphql library under the hood as a peer dependency, so in addition to installing this module, you'll also have to install graphql.

gql

The gql template literal tag can be used to concisely write a GraphQL query that is parsed into a standard GraphQL AST. It is the recommended method for passing queries to Apollo Client. While it is primarily built for Apollo Client, it generates a generic GraphQL AST which can be used by any GraphQL client.

import gql from 'graphql-tag';

const query = gql`
  {
    user(id: 5) {
      firstName
      lastName
    }
  }
`

The above query now contains the following syntax tree.

{
  "kind": "Document",
  "definitions": [
    {
      "kind": "OperationDefinition",
      "operation": "query",
      "name": null,
      "variableDefinitions": null,
      "directives": [],
      "selectionSet": {
        "kind": "SelectionSet",
        "selections": [
          {
            "kind": "Field",
            "alias": null,
            "name": {
              "kind": "Name",
              "value": "user",
              ...
            }
          }
        ]
      }
    }
  ]
}

Fragments

The gql tag can also be used to define reusable fragments, which can easily be added to queries or other fragments.

import gql from 'graphql-tag';

const userFragment = gql`
  fragment User_user on User {
    firstName
    lastName
  }
`

The above userFragment document can be embedded in another document using a template literal placeholder.

const query = gql`
  {
    user(id: 5) {
      ...User_user
    }
  }
  ${userFragment}
`

Note: While it may seem redundant to have to both embed the userFragment variable in the template literal AND spread the ...User_user fragment in the graphQL selection set, this requirement makes static analysis by tools such as eslint-plugin-graphql possible.

Why use this?

GraphQL strings are the right way to write queries in your code, because they can be statically analyzed using tools like eslint-plugin-graphql. However, strings are inconvenient to manipulate, if you are trying to do things like add extra fields, merge multiple queries together, or other interesting stuff.

That's where this package comes in - it lets you write your queries with ES2015 template literals and compile them into an AST with the gql tag.

Caching parse results

This package only has one feature - it caches previous parse results in a simple dictionary. This means that if you call the tag on the same query multiple times, it doesn't waste time parsing it again. It also means you can use === to compare queries to check if they are identical.

Importing graphQL files

To add support for importing .graphql/.gql files, see Webpack loading and preprocessing below.

Given a file MyQuery.graphql

query MyQuery {
  ...
}

If you have configured the webpack graphql-tag/loader, you can import modules containing graphQL queries. The imported value will be the pre-built AST.

import MyQuery from 'query.graphql'

Importing queries by name

You can also import query and fragment documents by name.

query MyQuery1 {
  ...
}

query MyQuery2 {
  ...
}

And in your JavaScript:

import { MyQuery1, MyQuery2 } from 'query.graphql'

Preprocessing queries and fragments

Preprocessing GraphQL queries and fragments into ASTs at build time can greatly improve load times.

Babel preprocessing

GraphQL queries can be compiled at build time using babel-plugin-graphql-tag. Pre-compiling queries decreases script initialization time and reduces bundle sizes by potentially removing the need for graphql-tag at runtime.

TypeScript preprocessing

Try this custom transformer to pre-compile your GraphQL queries in TypeScript: ts-transform-graphql-tag.

React Native and Next.js preprocessing

Preprocessing queries via the webpack loader is not always possible. babel-plugin-import-graphql supports importing graphql files directly into your JavaScript by preprocessing GraphQL queries into ASTs at compile-time.

E.g.:

import myImportedQuery from './productsQuery.graphql'

class ProductsPage extends React.Component {
  ...
}

Webpack loading and preprocessing

Using the included graphql-tag/loader it is possible to maintain query logic that is separate from the rest of your application logic. With the loader configured, imported graphQL files will be converted to AST during the webpack build process.

Example webpack configuration

{
  ...
  loaders: [
    {
      test: /\.(graphql|gql)$/,
      exclude: /node_modules/,
      loader: 'graphql-tag/loader'
    }
  ],
  ...
}

Create React App

Preprocessing GraphQL imports is supported in create-react-app >= v2 using evenchange4/graphql.macro.

For create-react-app < v2, you'll either need to eject or use react-app-rewire-inline-import-graphql-ast.

Testing

Testing environments that don't support Webpack require additional configuration. For Jest use jest-transform-graphql.

Support for fragments

With the webpack loader, you can import fragments by name:

In a file called query.gql:

fragment MyFragment1 on MyType1 {
  ...
}

fragment MyFragment2 on MyType2 {
  ...
}

And in your JavaScript:

import { MyFragment1, MyFragment2 } from 'query.gql'

Note: If your fragment references other fragments, the resulting document will have multiple fragments in it. In this case you must still specify the fragment name when using the fragment. For example, with @apollo/client you would specify the fragmentName option when using the fragment for cache operations.

Warnings

This package will emit a warning if you have multiple fragments of the same name. You can disable this with:

import { disableFragmentWarnings } from 'graphql-tag';

disableFragmentWarnings()

Experimental Fragment Variables

This package exports an experimentalFragmentVariables flag that allows you to use experimental support for parameterized fragments.

You can enable / disable this with:

import { enableExperimentalFragmentVariables, disableExperimentalFragmentVariables } from 'graphql-tag';

Enabling this feature allows you declare documents of the form

fragment SomeFragment ($arg: String!) on SomeType {
  someField
}

Resources

You can easily generate and explore a GraphQL AST on astexplorer.net.

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc or npmjs.com, the official website for the npm registry. Please note that npm is a registered trademark of npm, Inc. For more details, please refer to our Terms & Privacy.