fake-tag

fake-tag

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!
    }

Changelog

1.0.1

Patch

• Updated dev dependencies.
• Removed husky and lint-staged.
• Replaced old ESLint config with eslint-config-env.
• Use test-director instead of ava for tests.
• Updated the package description.
• Simplified the package repository field.
• Added a package main field.
• Added a package engines field declaring support for Node.js >= v8.10, as that is what ESLint supports. This only limits the dev environment; the published code is very simple and should be able to run almost anywhere.
• Added a package browserslist field, for linting.
• Moved dev tool config from package.json to separate files to reduce the published package size.
• Updated package scripts.
• Ensure Prettier also lints .yml files.
• Replaced Travis with GitHub Actions for CI.
• Removed package-lock.json from the .gitignore file, as it has been disabled anyway.
• Removed some readme badges, and used badgen.net instead of shields.io for the npm version badge.
• Updated the readme with more details, links, and a typo fix.
• Corrected the first version number in the changelog from 0.1.0 to 1.0.0.