Registry / web-framework / typewritingclass-esbuild

typewritingclass-esbuild

library0.2.4jsnpmunverified

esbuild plugin for static CSS extraction with Typewriting Class. Current version 0.2.4. Released on npm. Peer dependency on esbuild >=0.17.0. Ships TypeScript types. Differentiator: provides virtual CSS module import for seamless integration with esbuild build pipeline.

web-framework serialization

npm install typewritingclass-esbuild

github ↗package ↗

INSTALL

IMPORT

SIG · TYPEWRITINGCLASS-E

typewritingclass-esbuild

web-frameworkjavascriptv0.2.4

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.

twcPlugin

✓ import twcPlugin from 'typewritingclass-esbuild'

✗ const twcPlugin = require('typewritingclass-esbuild')

Default export only; ESM module.

twcPlugin

✓ import twcPlugin from 'typewritingclass-esbuild'

✗ import { twcPlugin } from 'typewritingclass-esbuild'

Default export, not named.

virtual:twc.css

✓ import 'virtual:twc.css'

✗ import './virtual:twc.css'

Virtual module identifier, not a file path.

Shows basic setup of esbuild with typewritingclass-esbuild plugin and virtual CSS import.

import esbuild from 'esbuild'; import twcPlugin from 'typewritingclass-esbuild'; await esbuild.build({ entryPoints: ['src/main.ts'], bundle: true, plugins: [twcPlugin()], });

Debug

Known issues

gotchaPlugin requires esbuild >=0.17.0 as a peer dependency; installing an older version will cause build failures.

fix

Update esbuild to version 0.17.0 or later.

affects: <0.17.0

gotchaThe virtual CSS import 'virtual:twc.css' must be present in your source code for the plugin to work.

fix

Add import 'virtual:twc.css' to your entry point or a module included in the bundle.

affects: *

gotchaWhen strict mode is enabled (default), dynamic values not wrapped in TWC functions will cause build errors.

fix

Disable strict mode via { strict: false } or wrap all dynamic values with TWC utilities.

affects: *

Errors

Common errors & fixes

Error: Cannot find module 'typewritingclass-esbuild'

Package not installed or missing from node_modules.

fix

Run 'npm install typewritingclass-esbuild' or 'bun add -d typewritingclass-esbuild'.

Error: Plugin 'typewritingclass-esbuild' must be used with esbuild >= 0.17.0

Installed esbuild version is too old.

fix

Update esbuild to version 0.17.0 or later.

Error: [plugin typewritingclass-esbuild] Could not resolve 'virtual:twc.css'

Plugin not added to the plugins array or import path is incorrect.

fix

Ensure the plugin is included in esbuild's plugins array and the import is exactly 'virtual:twc.css'.

Upgrade

Version history

0.2.4latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency to access build API

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/corysimmons/typewritingclass ↗

packagehttps://www.npmjs.com/package/typewritingclass-esbuild ↗