npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

webql-tools-graphql-tag-pluck

v6.3.0

Published

Pluck graphql-tag template literals

Downloads

5

Readme

GraphQL Tag Pluck

webql-tools-graphql-tag-pluck will take JavaScript code as an input and will pluck all template literals provided to graphql-tag.

Input:

import gql from 'graphql-tag';

const fragment = gql`
  fragment Foo on FooType {
    id
  }
`;

const doc = gql`
  query foo {
    foo {
      ...Foo
    }
  }

  ${fragment}
`;

Output:

fragment Foo on FooType {
  id
}

query foo {
  foo {
    ...Foo
  }
}

Originally created because of https://graphql-code-generator.com/.

Usage

webql-tools-graphql-tag-pluck is installable via NPM (or Yarn):

$ npm install webql-tools-graphql-tag-pluck

Once installed you can pluck GraphQL template literals using one of the following methods:

import gqlPluck, { gqlPluckFromFile, gqlPluckFromCodeString } from 'webql-tools-graphql-tag-pluck';

// Returns promise
gqlPluck.fromFile(filePath, {
  useSync: true, // Optional, will return string if so
});

// Returns string
gqlPluck.fromFile.sync(filePath);

// Returns string
gqlPluck.fromCodeString(codeString, {
  fileExt: '.ts', // Optional, defaults to '.js'
});

Template literals leaded by magic comments will also be extracted :-)

/* GraphQL */ `
  enum MessageTypes {
    text
    media
    draftjs
  }
`;

supported file extensions are: .js, .jsx, .ts, .tsx, .flow, .flow.js, .flow.jsx, .graphqls, .graphql, .gqls, .gql.

Options

I recommend you to look at the source code for a clearer understanding of the transformation options.

  • gqlMagicComment

    The magic comment anchor to look for when parsing GraphQL strings. Defaults to graphql, which may be translated into /* GraphQL */ in code.

  • globalGqlIdentifierName

    Allows to use a global identifier instead of a module import.

    // `graphql` is a global function
    export const usersQuery = graphql`
      {
        users {
          id
          name
        }
      }
    `;
  • modules

    An array of packages that are responsible for exporting the GraphQL string parser function. The following modules are supported by default:

    {
      modules: [
        {
          // import gql from 'graphql-tag'
          name: 'graphql-tag',
        },
        {
          name: 'graphql-tag.macro',
        },
        {
          // import { graphql } from 'gatsby'
          name: 'gatsby',
          identifier: 'graphql',
        },
        {
          name: 'apollo-server-express',
          identifier: 'gql',
        },
        {
          name: 'apollo-server',
          identifier: 'gql',
        },
        {
          name: 'react-relay',
          identifier: 'graphql',
        },
        {
          name: 'apollo-boost',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-koa',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-hapi',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-fastify',
          identifier: 'gql',
        },
        {
          name: ' apollo-server-lambda',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-micro',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-azure-functions',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-cloud-functions',
          identifier: 'gql',
        },
        {
          name: 'apollo-server-cloudflare',
          identifier: 'gql',
        },
      ];
    }

License

MIT