npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@egomobile/dbml-renderer

v3.0.1

Published

[![npm version](https://img.shields.io/npm/v/@egomobile/dbml-renderer)](https://www.npmjs.com/package/@egomobile/dbml-renderer) ![.github/workflows/publish.yml](https://github.com/egomobile/dbml-renderer/actions/workflows/publish.yml/badge.svg)

Downloads

15

Readme

npm version .github/workflows/publish.yml

@egomobile/dbml-renderer

dbml-renderer renders DBML files to SVG images.

The tool was orginally implemented as CLI tool by softwaretechnik.berlin .

Install

npm install @egomobile/dbml-renderer

For instance, the following code will produce the image below:

import { parseDMBL } from "@egomobile/dbml-renderer";

const dbml = `Table users {
    id integer
    username varchar
    role varchar
    created_at timestamp
}

Table posts {
    id integer [primary key]
    title varchar
    body text [note: 'Content of the post']
    user_id integer
    created_at timestamp
}

Ref: posts.user_id > users.id`

console.log(
    parseDMBL(dbml, "svg")
);

Posts example output

The examples directory contains other input and output examples.

Testing

The tests can be run with npm test. They use the examples available in the examples directory. Each .dbml file is used as input to render each of the available output formats.

The output of a test run is placed in .test-output. In case the renderer has been modified, the test output can be visually inspected and, confirmed the output is good, the expectations can be updated by copying them with the following command:

cp .test-output/* examples/

To aid the visual inspection, you can open .compare-test-output.html to compare side-by-side each generated SVG.