BibTeX TS Parser

BibTeX TS Parser based on the JS Parser from bibtex js parser. Now in TypeScript (ESNext).

Transforming a BibTeX file to an object in memory or a semi-structured file on disk.

Features

• [x] Full (insensitive-case) entry types support
• [x] Browser support
• [x] NPM support
• [x] Typing support for TypeScript projects
• [x] Exportable Entry Type for TypeScript projects
• [x] Includes inofficial type dataset

Quickstart

NPM / YARN

1. Install bibtex-ts-parser from npm registry.

npm install @liliana-sanfilippo/bibtex-ts-parser

yarn add @liliana-sanfilippo/bibtex-ts-parser

2. Import BibtexParser.

import {BibtexParser} from "@liliana-sanfilippo/bibtex-ts-parser";

If necessary or wanted also import Entry type to work with.

import {Entry} from "@liliana-sanfilippo/bibtex-ts-parser";

In-Browser Use

1. Include bibtex-ts-parser.js from CDN.

<script src="https://unpkg.com/@liliana-sanfilippo/bibtex-ts-parser/dist/umd/bibtex-ts-parser.js"></script>

2. Use exposed functions.

<script>
    const bibJSON = BibtexParser.parseToJSON(input);
    const bibJSONString = BibtexParser.parseToJSONString(input);
</script>

Build

Environment

I used Node.js v20.19.3

For Dev

Build a CommonJS script to dist/dev/bibtex-ts-parser-dev.js with source map.

npm run dev

Configuration is changeable in .webpack.config.dev.js.

For Test

Run tests defined in test after building for dev.

npm run test

For Production

Build a UMD script to dist/umd/bibtex-ts-parser.js and a CommonJS script to dist/cjs/bibtex-ts-parser.js and a module to to dist/module/bibtex-ts-parser.js.

npm run build

Configuration is changeable in .webpack.config.prod.js.

Usage

Related Projects

• BibTeX JS Parser
• react-bibtex-source-generator
• BibTeX Grammar
• BibTex Java Parser