lean-format

Meta package for LEAN Format - A minimal, human-readable data interchange format.

Quick Install

npm install lean-format

This package is a convenience wrapper that installs @lean-format/core. Both packages provide the same functionality.

What is LEAN?

LEAN (Lightweight Efficient Adaptive Notation) is a data format that's:

• 40% more compact than JSON for tabular data
• Human-readable with natural syntax
• Flexible with support for row syntax, comments, and dot notation

Usage

import { parse, format } from 'lean-format';

// Parse LEAN to JavaScript
const data = parse(`
users(id, name, email):
  - 1, Alice, [email protected]
  - 2, Bob, [email protected]
`);

// Format JavaScript as LEAN
const lean = format(data);
console.log(lean);

Packages

This is a meta package that includes:

• @lean-format/core - Core parser and serializer

You can also install packages individually:

npm install @lean-format/core  # Core library
npm install -g @lean-format/cli  # Command-line tool

Features

• ✅ Row Syntax - Compact tabular data representation
• ✅ Comments - Line and inline comments supported
• ✅ Dot Notation - Simplified nested object syntax
• ✅ Type Safe - Full TypeScript support
• ✅ Schema Validation - JSON Schema-like validation
• ✅ 94% Test Coverage - Production-ready

Learn More

• Documentation
• Specification
• API Reference
• GitHub Repository

License

MIT © LEAN Format Team