@blaze-ng/blaze-tools

Scanner and code generation utilities for Blaze template compilation.

Installation

npm install @blaze-ng/blaze-tools

Namespace

import { BlazeTools } from '@blaze-ng/blaze-tools';

Code Generation

toJS()

Convert an HTMLJS tree to JavaScript source code.

function toJS(node: HTMLNode): string;

import { HTML } from '@blaze-ng/htmljs';
import { BlazeTools } from '@blaze-ng/blaze-tools';

const node = HTML.DIV({ class: 'card' }, HTML.P('Hello'));
const js = BlazeTools.toJS(node);
// => 'HTML.DIV({"class": "card"}, HTML.P("Hello"))'

toJSLiteral()

Convert a JavaScript value to a source code literal.

function toJSLiteral(value: unknown): string;

toJSLiteral('hello'); // => '"hello"'
toJSLiteral(42); // => '42'
toJSLiteral(true); // => 'true'
toJSLiteral(null); // => 'null'
toJSLiteral(undefined); // => 'undefined'

toObjectLiteralKey()

Convert a string to a valid JavaScript object key.

function toObjectLiteralKey(key: string): string;

toObjectLiteralKey('class'); // => '"class"'
toObjectLiteralKey('validName'); // => 'validName'
toObjectLiteralKey('data-id'); // => '"data-id"'

Classes

EmitCode

Helper for building JavaScript code strings:

class EmitCode {
  value: string;
  constructor(value: string);
}

ToJSVisitor

HTMLJS visitor that generates JavaScript code:

class ToJSVisitor extends Visitor {
  visitTag(tag: Tag): EmitCode;
  visitString(str: string): EmitCode;
  visitArray(arr: unknown[]): EmitCode;
  // ...
}

Parsing Utilities

parseNumber()

Parse a number token from a string.

function parseNumber(scanner: Scanner): NumberToken | null;

parseIdentifierName()

Parse a JavaScript identifier.

function parseIdentifierName(scanner: Scanner): string | null;

parseExtendedIdentifierName()

Parse an extended identifier (includes . and /).

function parseExtendedIdentifierName(scanner: Scanner): string | null;

parseStringLiteral()

Parse a string literal (single or double quoted).

function parseStringLiteral(scanner: Scanner): StringToken | null;

Types

interface Scanner {
  pos: number;
  input: string;
  peek(): string;
  rest(): string;
  isEOF(): boolean;
}

interface NumberToken {
  type: 'number';
  value: number;
  raw: string;
}

interface StringToken {
  type: 'string';
  value: string;
  raw: string;
}