An open API service indexing awesome lists of open source software.

https://github.com/nice-move/prettier-plugin-dbml

A Prettier plugin for DBML
https://github.com/nice-move/prettier-plugin-dbml

database dbml prettier prettier-plugin schema sql

Last synced: 3 months ago
JSON representation

A Prettier plugin for DBML

Awesome Lists containing this project

README

          

# prettier-plugin-dbml

A [prettier] plugin for [DBML].

[prettier]: https://prettier.io/
[dbml]: https://www.dbml.org/

[![npm][npm-badge]][npm-url]
[![github][github-badge]][github-url]
![node][node-badge]

[npm-url]: https://www.npmjs.com/package/prettier-plugin-dbml
[npm-badge]: https://img.shields.io/npm/v/prettier-plugin-dbml.svg?style=flat-square&logo=npm
[github-url]: https://github.com/nice-move/prettier-plugin-dbml
[github-badge]: https://img.shields.io/npm/l/prettier-plugin-dbml.svg?style=flat-square&colorB=blue&logo=github
[node-badge]: https://img.shields.io/node/v/prettier-plugin-dbml.svg?style=flat-square&colorB=green&logo=node.js

## Installation

```bash
npm install prettier-plugin-dbml --save-dev
```

## Usage

```sh
prettier --write *.dbml
```

# Known Issues

- All String can't include single quotes
- Table alias will be transformed to Table name
- Comments will be removed
- See: https://github.com/holistics/dbml/issues/285

## Related

- [@nice-move/prettier-config](https://github.com/nice-move/nice-move/tree/master/packages/prettier-config)
- [@nice-move/prettier-plugin-package-json](https://github.com/nice-move/prettier-plugin-package-json)
- [@nice-move/prettier-plugin-ssh-config](https://github.com/nice-move/prettier-plugin-ssh-config)