Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

fake-tag

2.0.0 • Public • Published

fake-tag

npm version CI status

A fake template literal tag to trick syntax highlighters, linters and formatters into action. Interpolations and escapes are tested.

Setup

Install with npm:

npm install fake-tag

Usage

Import and use the tag with the required name:

import gql from 'fake-tag'
 
const typeDefs = gql`
  "A foo."
  type Foo {
    "The \`Foo\` ID."
    id: ID!
  }
`

Names other than gql can be used for other use cases.

Why not comment tags?

A comment tag looks like this:

const QUERY = /* GraphQL */ `
  {
    foo
  }
`

They are far superior to a fake tag:

  • No dependency to manage.
  • No inconvenient imports.
  • No bundle size bloat.
  • No runtime overhead.

Unfortunately not all tools support them yet. prettier has since v1.13.0, but eslint-plugin-graphql at v3.1.0 still doesn’t.

Why not String.raw?

This may be temptingly simple:

const gql = String.raw
const QUERY = gql`
  {
    foo
  }
`

However, it doesn’t unescape characters. For the usage example, if you console.log(typeDefs) before and after replacing the import with const gql = String.raw you will see the difference in the type description markdown:

    "A foo."
    type Foo {
-     "The `Foo` ID."
+     "The \`Foo\` ID."
      id: ID!
    }

Install

npm i fake-tag

DownloadsWeekly Downloads

168,880

Version

2.0.0

License

MIT

Unpacked Size

5.57 kB

Total Files

4

Last publish

Collaborators

  • avatar