npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@unified-latex/unified-latex-builder

v1.8.0

Published

Tools for constructing unified-latex ASTs

Downloads

16,602

Readme

unified-latex-builder

What is this?

Functions to help build a unified-latex Abstract Syntax Tree (AST) with hyperscript-like syntax.

When should I use this?

If you want to programmatically create Ast.Node nodes.

Install

npm install @unified-latex/unified-latex-builder

This package contains both esm and commonjs exports. To explicitly access the esm export, import the .js file. To explicitly access the commonjs export, import the .cjs file.

Functions

arg(args, special)

Create an Argument. special.braces can optionally specify the signature of the open/close marks that each argument uses. For example

arg("a", { braces: "[]" });

will result in arguments [a]. Valid braces are *, [, {, <, and (.

null may be passed as the value of an empty optional argument. If null is passed, the openBrace and closeBrace of the argument will be set to empty strings and the contents will be set to an empty array. For example,

args([null, "b"], { braces: "[]{}" });

will produce the same structure as if the the first "optional argument" were omitted in regular parsing.

function arg(
  args: CoercibleArgument | Ast.Node[],
  special: ArgumentSpecialOptions
): Ast.Argument;

Parameters

| Param | Type | | :------ | :-------------------------------- | | args | Omitted | | special | ArgumentSpecialOptions |

where

type ArgumentSpecialOptions = {
  braces?: string;
  openMark?: string;
  closeMark?: string;
};

args(args, special)

Create an Argument list. special.braces can optionally specify the signature of the open/close marks that each argument uses. For example

args(["a", "b"], { braces: "[]{}" });

will result in arguments [a]{b}. Valid braces are *, [, {, (, and <.

null may be passed as the value of an empty optional argument. If null is passed, the openBrace and closeBrace of the argument will be set to empty strings and the contents will be set to an empty array. For example,

args([null, "b"], { braces: "[]{}" });

will produce the same structure as if the the first "optional argument" were omitted in regular parsing.

function args(
  args: CoercibleArgument | CoercibleArgument[],
  special: ArgumentsSpecialOptions
): Ast.Argument[];

Parameters

| Param | Type | | :------ | :-------------------------------- | | args | Omitted | | special | ArgumentsSpecialOptions |

where

type ArgumentsSpecialOptions = {
  braces?: string;
  defaultOpenMark?: string;
  defaultCloseMark?: string;
};

env(name, body, envArgs, special)

Create an Environment node.

function env(
  name: String,
  body: CoercibleNode | CoercibleNode[],
  envArgs: CoercibleArgument | CoercibleArgument[],
  special: {}
): Ast.Environment;

Parameters

| Param | Type | | :------ | :-------------------------------- | | name | String | | body | Omitted | | envArgs | Omitted | | special | {} |

m(name, marcoArgs, special)

Create a Macro with the given name. The macro may be followed by any number of arguments.

function m(
  name: String,
  marcoArgs: CoercibleArgument | CoercibleArgument[],
  special: MacroSpecialOptions
): Ast.Macro;

Parameters

| Param | Type | | :-------- | :-------------------------------- | | name | String | | marcoArgs | Omitted | | special | MacroSpecialOptions |

where

type MacroSpecialOptions = {
  escapeToken?: string;
};

s(value)

Create a String node from value

function s(value: string | Ast.String): Ast.String;

Parameters

| Param | Type | | :---- | :--------------------- | | value | string \| Ast.String |

Constants

| Name | Type | Description | | :--- | :--------------- | :--------------- | | SP | Ast.Whitespace | Whitespace node. |