Registry / devops / esbuild-plugin-liquid

esbuild-plugin-liquid

library0.2.0jsnpmunverified

esbuild plugin that allows importing .liquid template files as strings in JavaScript/TypeScript bundles. Current version 0.2.0 (peer dependency esbuild >=0.11.15). Does not render Liquid templates, only loads them as raw strings. Supports basic HTML minification when esbuild's --minify flag is active. Differentiates from other template loaders by specifically targeting Liquid syntax and integrating with esbuild's build pipeline.

devops

npm install esbuild-plugin-liquid

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-LIQ

esbuild-plugin-liquid

devopsjavascriptv0.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

liquidPlugin

✓ import liquidPlugin from 'esbuild-plugin-liquid'

✗ const { liquidPlugin } = require('esbuild-plugin-liquid')

Default export; use default import or require().default for CJS.

default

✓ const liquidPlugin = require('esbuild-plugin-liquid')

CJS require returns the default export directly.

liquidPlugin()

✓ plugins: [liquidPlugin()]

✗ plugins: [liquidPlugin]

Must call the imported function with no arguments; it returns a plugin object.

Shows how to register the liquid plugin in an esbuild build script, enabling import of .liquid files as strings.

const esbuild = require('esbuild'); const liquidPlugin = require('esbuild-plugin-liquid'); esbuild.build({ entryPoints: ['src/app.js'], outdir: 'dist', write: false, plugins: [liquidPlugin()], });

Debug

Known issues

gotchaRequires write: false in esbuild config, otherwise plugin may not function correctly.

fix

Set write: false in the build options.

affects: >=0.0

gotchaLiquid templates are imported as raw strings, not rendered. Errors related to missing template data or syntax are not caught at build time.

fix

Handle Liquid rendering at runtime using a separate library (e.g., liquidjs).

affects: >=0.0

Errors

Common errors & fixes

Error: The plugin "esbuild-plugin-liquid" doesn't have a setup function

Plugin object was passed directly instead of calling the default export as a function

fix

Use plugins: [liquidPlugin()] rather than plugins: [liquidPlugin]

TypeError: Cannot read properties of undefined (reading 'onLoad')

Plugin function was not called (i.e., used as reference instead of invocation)

fix

Call the imported function: liquidPlugin()

Upgrade

Version history

0.2.0latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency required for plugin to operate

Agent activity

2 hits · last 30 days

node

Resources

githubssh://git@github.com/jayelkaake/esbuild-plugin-liquid ↗

packageesbuild-plugin-liquid ↗

homepagehttps://github.com/jayelkaake/esbuild-plugin-liquid#readme ↗