typewritingclass-esbuild

0.2.4 verified Fri May 01 auth: no javascript

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.

Common errors

error Error: Cannot find module 'typewritingclass-esbuild' ↓

cause Package not installed or missing from node_modules.

fix

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

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

cause Installed esbuild version is too old.

fix

Update esbuild to version 0.17.0 or later.

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

cause 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'.

Warnings

gotcha Plugin 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.

gotcha The 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.

gotcha When 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.

Install

npm install typewritingclass-esbuild

yarn add typewritingclass-esbuild

pnpm add typewritingclass-esbuild

Imports

twcPlugin

wrong

const twcPlugin = require('typewritingclass-esbuild')

correct

import twcPlugin from 'typewritingclass-esbuild'

Default export only; ESM module.

twcPlugin

wrong

import { twcPlugin } from 'typewritingclass-esbuild'

correct

import twcPlugin from 'typewritingclass-esbuild'

Default export, not named.

virtual:twc.css
wrong
```
import './virtual:twc.css'
```
correct
```
import 'virtual:twc.css'
```
Virtual module identifier, not a file path.

Quickstart

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()],
});