@prompt-template/formatters

@prompt-template/formatters provides a collection of formatters for use with @prompt-template/core. These formatters allow you to customize the formatting of input variables in your prompt templates.

Installation

npm i @prompt-template/core @prompt-template/formatters

Usage

import { PromptTemplate } from '@prompt-template/core'
import { camelCase } from '@prompt-template/formatters'

const promptTemplate = PromptTemplate.create`
  foo ${{ name: 'input', onFormat: camelCase }}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo barBaz'

Or more concisely

import { PromptTemplate } from '@prompt-template/core'
import { withCamelCase } from '@prompt-template/formatters'

const promptTemplate = PromptTemplate.create`
  foo ${withCamelCase('input')}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo barBaz'

API

camelCase

A formatter that converts the input string to camel case.

With onFormat

const promptTemplate = PromptTemplate.create`
  foo ${{ name: 'input', onFormat: camelCase }}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo barBaz'

With PromptTemplateInputVariableName

const promptTemplate = PromptTemplate.create`
  foo ${withCamelCase('input')}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo barBaz'

With PromptTemplateInputVariableConfig options

const promptTemplate = PromptTemplate.create`
  foo ${withCamelCase('input', { default: 'default' })}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo barBaz'

const promptWithDefault = promptTemplate.format({})
//=> 'foo default'

With formatterOptions

const promptTemplate = PromptTemplate.create`
  foo ${withCamelCase('input', { formatterOptions: { delimiter: ' ' } })}
`

const prompt = promptTemplate.format({
  input: 'bar baz',
})
//=> 'foo bar Baz'