Description

A powerful and fast parser and utilities for non-technical user input, inspired by lexure, powered by @sapphire/result.

The code in this package has been greatly inspired by lexure from 1Computer1.

Features

• Written in TypeScript
• Bundled with esbuild so it can be used in NodeJS and browsers
• Offers CommonJS, ESM and UMD bundles
• Fully tested
• Parses quoted input with multiple quote styles
• Parses flags and options with a customizable strategy system
• Keeps leading whitespace
• Includes a convenient wrapper to retrieve the parsed arguments
• Includes custom argument delimiter

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/lexure

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { Parser } = require('@sapphire/lexure') equals import { Parser } from '@sapphire/lexure'.

const parser = new Parser(new PrefixedStrategy(['--', '/'], ['=', ':']));
const lexer = new Lexer({
	quotes: [
		['"', '"'],
		['“', '”'],
		['「', '」']
	]
});

const content = 'foo bar';
const stream = new ArgumentStream(parser.run(lexer.run(content)));

console.log(stream.single()); // Some { value: 'foo' }
console.log(stream.single()); // Some { value: 'bar' }
console.log(stream.single()); // None

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!