Paperclip HTML Compiler

18.3.8 verified Fri May 01 auth: no javascript

The paperclip-compiler-html package at version 18.3.8 is an HTML compiler component of the Paperclip framework. It compiles Paperclip design documents into HTML. The library is currently a work in progress (WIP). Release cadence is unclear due to its early stage. Key differentiators: designed specifically for Paperclip's design-to-code pipeline. No stable releases yet; use with caution.

Common errors

error Cannot find module 'paperclip-compiler-html' ↓

cause Package not installed or incorrect import path.

fix

Run npm install paperclip-compiler-html and use correct import.

error compileHTML is not a function ↓

cause Import mistake: likely using default import instead of named.

fix

Use import { compileHTML } from 'paperclip-compiler-html'.

Warnings

gotcha Package is in early WIP state; API may change without notice. ↓

fix Pin to specific version and update frequently.

gotcha No stable release; expect breaking changes between minor versions. ↓

fix Watch for changelog and update dependencies carefully.

Install

npm install paperclip-compiler-html

yarn add paperclip-compiler-html

pnpm add paperclip-compiler-html

Imports

compileHTML

wrong

const compileHTML = require('paperclip-compiler-html');

correct

import { compileHTML } from 'paperclip-compiler-html'

ESM-only; no CommonJS support.

compileFile

wrong

import compileFile from 'paperclip-compiler-html';

correct

import { compileFile } from 'paperclip-compiler-html'

Named export, not default.

default

wrong

import { default as htmlCompiler } from 'paperclip-compiler-html';

correct

import htmlCompiler from 'paperclip-compiler-html'

Default export is available, but named exports are preferred.

Quickstart

Shows basic usage of compileHTML function to compile a Paperclip design string to HTML.

import { compileHTML } from 'paperclip-compiler-html';

const input = `<div>Hello</div>`;
const result = compileHTML(input, { mode: 'design' });
console.log(result);