@formfeed/devkit

@formfeed/devkit

The local half of the Formfeed development kit: template folders, project configuration (formfeed.json) and offline rendering with the same engine the API uses. The formfeed CLI and @formfeed/testing are built on it; use it directly when you write your own tooling around a template repository.

npm install @formfeed/devkit

import { defaultData, diagnose, projectAround, readTemplate, renderLocal } from '@formfeed/devkit';

// a folder with template.html, template.json, styles.css, data/*.json (see the project layout docs)
const project = projectAround('templates/invoice-de');
const tpl = readTemplate(project, 'invoice-de');
const { data } = defaultData(tpl); // data/default.json, or the first data set

console.log(diagnose(tpl, data)); // the editor's diagnostics: syntax errors, unknown variables
const { document } = await renderLocal(project, tpl, data, { mode: 'print' }); // complete HTML, no browser

Errors are DevkitError instances with a code, which the CLI maps to its exit codes.

Documentation

• Development kit overview
• Project layout

Licence

MIT