@etchteam/contentful

Helpers we use at Etch for working with Contentful.

Install

npm install @etchteam/contentful

CLI

Setup

The CLI depends on the following environment variables being present

• CONTENTFUL_SPACE_ID
• CONTENTFUL_ENVIRONMENT
• CONTENTFUL_MANAGEMENT_ACCESS_TOKEN

Usage

Use --help to display help for a command.

Install migrations

npx etch-contentful-cli migration:install

Creates a directory at /integrations/contentful/migrations containing a 0-init migration.

When migrations are run, this will set the migration content type on your configured contentful space.

New migration

npx etch-contentful-cli migration:new "MIGRATION_NAME"

Creates a new migration file at /integrations/contentful/migrations with the "MIGRATION_NAME" provided.

Run migrations

npx etch-contentful-cli migration:run

Runs all migrations that haven't already been run.

The migration:run command accepts an optional spaces argument --spaces <spaceOne,spaceTwo>.

This will filter out any migrations that don't export a matching space name as part of its module.exports.spaces array:

module.exports.spaces = ['spaceOne', 'spaceTwo'];

If no spaces argument is provided, all migrations will run.

Generate types

npx etch-contentful-cli typegen

Generate GraphQL API compatible types based on your content in Contentful

The typegen command accepts an optional filename argument --filename <filename>. If omitted the filename will default to contentful.d.ts.

Validators

Some basic validators are available to use with content types, they can be imported:

import { validator } from '@etchteam/contentful';

Then used with their corresponding Contentful input type:

newEntity
  .createField('summary')
  .type('RichText')
  .name('Summary')
  .validations(validator.richText.boldAndItalicOnly);