@birdcc/dprint-plugin-bird

Overview · Features · Installation · Usage · Configuration · Architecture · Development

Overview

@birdcc/dprint-plugin-bird is the official dprint plugin for BIRD Internet Routing Daemon (BIRD2) configuration files. Built with Rust and compiled to WebAssembly, it delivers blazing-fast, cross-platform code formatting.

This plugin is part of the BIRD-LSP toolchain, providing enterprise-grade formatting capabilities for network engineers.

---

Features

Feature	Description
Rust Performance	Core engine written in Rust for maximum speed
Cross-Platform WASM	Compiled to wasm32-wasip1 for consistent behavior
dprint Compatible	Seamlessly integrates with dprint CLI and editors
Tree-sitter	Leverages Tree-sitter for syntax-aware formatting
Configurable	Supports lineWidth, indentWidth, safeMode
Memory Safe	Rust's ownership model guarantees safety

---

Installation

Prerequisites

• Rust ≥ 1.70
• wasm32-wasip1 target
• Node.js ≥ 20

Setup Rust WASM Target

rustup target add wasm32-wasip1

Install via npm

npm install @birdcc/dprint-plugin-bird

---

Usage

With dprint CLI

Add to your dprint.json:

{
  "plugins": [
    "https://npmjs.com/@birdcc/dprint-plugin-bird/dprint-plugin-bird.wasm"
  ],
  "bird": {
    "lineWidth": 100,
    "indentWidth": 2,
    "safeMode": true
  }
}

Then run:

dprint fmt bird.conf
dprint check bird.conf

Via @birdcc/formatter

When configured with engine: "dprint", this plugin is automatically used:

{
  "$schema": "https://raw.githubusercontent.com/bird-chinese-community/BIRD-LSP/main/schemas/bird.config.schema.json",
  "formatter": {
    "engine": "dprint",
    "indentSize": 2,
    "lineWidth": 100,
    "safeMode": true
  }
}

Programmatic Usage

import { getPath, getBuffer } from "@birdcc/dprint-plugin-bird";

// Get WASM file path
const wasmPath = getPath();

// Or get WASM buffer directly
const wasmBuffer = getBuffer();

---

Configuration

Options

Option	Type	Default	Description
lineWidth	number	80	Maximum line length
indentWidth	number	2	Spaces per indentation level
safeMode	boolean	true	Enable safe mode to prevent errors

---

Architecture

Plugin Architecture

flowchart TB
    subgraph "Host Environment"
        D1[dprint CLI]
        D2[Editor Plugin]
        D3[@birdcc/formatter]
    end

    subgraph "WASM Runtime"
        WASM[WASM Module<br/>wasm32-wasip1]
        HOST[Host Functions]
    end

    subgraph "Rust Core"
        R1[Plugin Entry]
        R2[Configuration]
        R3[Format Engine]
    end

    subgraph "Parsing"
        P1[Tree-sitter Parser]
        P2[AST Builder]
    end

    subgraph "Formatting"
        F1[Layout Engine]
        F2[Indentation]
        F3[Line Breaking]
    end

    subgraph "Output"
        O[Formatted Text]
    end

    D1 --> WASM
    D2 --> WASM
    D3 --> WASM
    WASM --> HOST
    HOST --> R1
    R1 --> R2
    R1 --> R3
    R3 --> P1
    P1 --> P2
    P2 --> F1
    F1 --> F2
    F1 --> F3
    F2 --> O
    F3 --> O

    style WASM fill:#f3e5f5
    style R3 fill:#e8f5e9

Data Flow

sequenceDiagram
    participant Host as Host (dprint/formatter)
    participant WASM as WASM Runtime
    participant Plugin as Rust Plugin
    participant Parser as Tree-sitter
    participant Formatter as Format Engine

    Host->>WASM: load_plugin()
    WASM->>Plugin: initialize()
    Plugin-->>WASM: plugin info
    WASM-->>Host: ready

    Host->>WASM: format_text(source, config)
    WASM->>Plugin: format_request()
    Plugin->>Parser: parse_source()
    Parser-->>Plugin: CST/AST
    Plugin->>Formatter: format_node(node, config)
    Formatter->>Formatter: compute_layout()
    Formatter->>Formatter: apply_indentation()
    Formatter->>Formatter: handle_line_breaks()
    Formatter-->>Plugin: formatted_text
    Plugin-->>WASM: result
    WASM-->>Host: formatted output

Build Pipeline

flowchart LR
    subgraph "Source"
        RS[Rust Source<br/>src/*.rs]
        TS[TypeScript<br/>src/*.ts]
    end

    subgraph "Compile"
        RUSTC[Rust Compiler]
        TSC[TypeScript Compiler]
    end

    subgraph "Output"
        WASM[dprint-plugin-bird.wasm]
        JS[index.js]
        DTS[index.d.ts]
    end

    subgraph "Package"
        PKG[npm Package]
    end

    RS --> RUSTC
    TS --> TSC
    RUSTC --> WASM
    TSC --> JS
    TSC --> DTS
    WASM --> PKG
    JS --> PKG
    DTS --> PKG

    style WASM fill:#f3e5f5

---

Development

Build

Execute from the monorepo root:

pnpm build

This command performs:

1. Compiles Rust code to WebAssembly (wasm32-wasip1)
2. Generates TypeScript declaration files
3. Outputs to the dist/ directory

Manual Build Steps

# Build WASM
node scripts/build-wasm.mjs

# Compile TypeScript
tsc -p tsconfig.json

Project Structure

Path	Description
src/lib.rs	Library entry point
src/configuration.rs	Configuration structures
src/format_text.rs	Core formatting implementation
src/wasm_plugin.rs	WASM bindings
src/index.ts	TypeScript bindings
scripts/build-wasm.mjs	WASM build script
dist/	Build output directory

Available Scripts

Command	Description
pnpm build	Build WASM + TypeScript
pnpm test	Run Rust unit tests
pnpm typecheck	Run TypeScript type checking
pnpm lint	Run oxlint and cargo clippy
pnpm format	Format code using oxfmt

Testing

# Run Rust tests
cargo test

# Run with output
cargo test -- --nocapture

---

Relationship with @birdcc/formatter

Package	Role	Description
@birdcc/dprint-plugin-bird	dprint Plugin	Official dprint plugin for BIRD2
@birdcc/formatter	Abstraction Layer	Unified interface with multiple engines

@birdcc/formatter serves as a higher-level abstraction that can use this dprint plugin as its backend, while also providing a built-in fallback formatter.

---

Related Packages

Package	Description
@birdcc/parser	Tree-sitter grammar and parser
@birdcc/core	Semantic analysis engine
@birdcc/formatter	Unified formatting interface
@birdcc/linter	Lint rules and diagnostics
@birdcc/lsp	LSP server implementation
@birdcc/cli	Command-line interface

---

Documentation

• BIRD Official Documentation
• BIRD2 User Manual
• dprint Documentation
• GitHub Project

---

License

GPL-3.0-only BIRD Chinese Community

---

_{Built with by the BIRD Chinese Community (BIRDCC)}

GitHub · Marketplace · Report Issues