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
- Host: GitHub
- URL: https://github.com/nice-move/prettier-plugin-dbml
- Owner: nice-move
- License: mit
- Created: 2022-09-02T06:56:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-11T10:51:39.000Z (about 1 year ago)
- Last Synced: 2025-01-12T04:51:20.464Z (12 months ago)
- Topics: database, dbml, prettier, prettier-plugin, schema, sql
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/prettier-plugin-dbml
- Size: 708 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)