bebop-tools

library3.2.3jsnpmunverified

bebop-tools is the official CLI compiler for Bebop, a blazing fast, typesafe binary serialization library. Current stable version is 3.2.3. It compiles .bop schema files and generates idiomatic code for TypeScript, C#, Rust, C, and more. Unlike Protocol Buffers or FlatBuffers, Bebop focuses on minimal wire size and zero-copy parsing. Releases are frequent, with active development under the RainwayApp/6over3 organization.

serialization

npm install bebop-tools

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · BEBOP-TOOLS

bebop-tools

serializationjavascriptv3.2.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

BebopCompiler

✓ import { BebopCompiler } from 'bebop-tools'

✗ const BebopCompiler = require('bebop-tools').BebopCompiler

bebop-tools is ESM-only since v3. Use dynamic import or top-level await in CJS.

compile

✓ import { compile } from 'bebop-tools'

✗ import compile from 'bebop-tools'

compile is a named export, not default.

SyntaxKind

✓ import { SyntaxKind } from 'bebop-tools'

✗ import { Syntax } from 'bebop-tools'

Used for AST node types; exact name is SyntaxKind.

Demonstrates compiling a Bebop schema string to TypeScript code using the compile function.

import { compile } from 'bebop-tools'; import { writeFileSync } from 'fs'; const schema = ` message Person { string name; int32 age; } `; const result = compile(schema, { language: 'typescript', namespace: 'MyApp' }); if (result.success) { writeFileSync('Person.ts', result.code); console.log('Generated TypeScript code'); } else { console.error(result.errors); }

bebop --version

Debug

Known issues

breakingbeopc CLI renamed to bebopc in v2.0.0.

fix

Use 'bebopc' instead of 'beopc'.

affects: <2.0.0

breakingESM-only since v3.0.0 – CommonJS require() no longer works.

fix

Use dynamic import() or switch project to ESM (set "type": "module" in package.json).

affects: >=3.0.0

gotchaDefault export is not available; only named exports are provided.

fix

Import named exports like { compile, BebopCompiler }.

affects: >=0.1.0

deprecatedThe 'runtime' package is separate and not bundled in bebop-tools.

fix

Install @bebop/runtime for runtime helpers.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'bebop-tools'

Package not installed.

fix

Run 'npm install bebop-tools'.

TypeError: bebop_tools_1.compile is not a function

Incorrect import style (used default instead of named).

fix

Use 'import { compile } from 'bebop-tools''.

SyntaxError: Unexpected token 'export'

Using require() in a CommonJS environment with ESM-only package.

fix

Switch to ESM or use dynamic import().

Error: No language specified

Missing 'language' option in compile() call.

fix

Pass options with { language: 'typescript' }.

Upgrade

Version history

3.2.3latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

21 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/RainwayApp/bebop ↗

packagehttps://www.npmjs.com/package/bebop-tools ↗

homepagehttps://bebop.sh ↗