Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/g-plane/markup_fmt
Configurable HTML/Vue/Svelte/Astro/Jinja/Twig/Nunjucks/Vento formatter, with dprint integration which behaves as dprint-plugin-html, dprint-plugin-vue, dprint-plugin-svelte and dprint-plugin-astro but all in one.
https://github.com/g-plane/markup_fmt
astro dprint dprint-plugin formatter formatting html jinja jinja2 nunjucks prettier svelte twig vento vue
Last synced: about 17 hours ago
JSON representation
Configurable HTML/Vue/Svelte/Astro/Jinja/Twig/Nunjucks/Vento formatter, with dprint integration which behaves as dprint-plugin-html, dprint-plugin-vue, dprint-plugin-svelte and dprint-plugin-astro but all in one.
- Host: GitHub
- URL: https://github.com/g-plane/markup_fmt
- Owner: g-plane
- License: mit
- Created: 2023-10-13T10:27:16.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-02T08:42:55.000Z (6 months ago)
- Last Synced: 2024-04-03T02:51:04.211Z (6 months ago)
- Topics: astro, dprint, dprint-plugin, formatter, formatting, html, jinja, jinja2, nunjucks, prettier, svelte, twig, vento, vue
- Language: Rust
- Homepage:
- Size: 537 KB
- Stars: 39
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
markup_fmt
markup_fmt is a configurable HTML, Vue, Svelte, Astro, Angular, Jinja, Twig, Nunjucks and Vento formatter.
## Notes for Vue and Svelte Users
This formatter provides some options such as `vBindStyle`, `vOnStyle` and more for Vue and
`svelteAttrShorthand` and `svelteDirectiveShorthand` for Svelte.
It's recommended to enable these options in this formatter and disable the corresponding
rules in [eslint-plugin-vue](https://eslint.vuejs.org) and [eslint-plugin-svelte](https://sveltejs.github.io/eslint-plugin-svelte) if you used.
This will make ESLint faster because less rules will be executed.
## Getting Started
### dprint
We've provided [dprint](https://dprint.dev/) integration.
This plugin only formats HTML syntax of your HTML, Vue, Svelte, Astro, Angular, Jinja, Twig, Nunjucks and Vento files.
You also need other dprint plugins to format the code in `` and `<style>` tags.
You can use [dprint-plugin-typescript](https://github.com/dprint/dprint-plugin-typescript) to
format TypeScript/JavaScript code and [Malva](https://github.com/g-plane/malva) to format CSS/SCSS/Sass/Less code.
Run the commands below to add plugins:
```bash
dprint config add g-plane/markup_fmt
dprint config add g-plane/malva
dprint config add typescript
```
If you also want to format JSON in `<script>` tag whose `"type"` is `"importmap"` or `"application/json"`,
you can add dprint-plugin-json:
```bash
dprint config add json
```
Or Biome:
```diff
- dprint config add typescript
- dprint config add json
+ dprint config add biome
```
After adding the dprint plugins, update your `dprint.json` and add configuration:
```jsonc
{
// ...
"plugins": [
// ... other plugins URL
"https://plugins.dprint.dev/g-plane/markup_fmt-v0.13.1.wasm"
],
"markup": { // <-- the key name here is "markup", not "markup_fmt"
// config comes here
}
}
```
You can also read [dprint CLI documentation](https://dprint.dev/cli/) for using dprint to format files.
### Use as a Rust crate
Please read the [documentation](https://docs.rs/markup_fmt).
## Configuration
Please refer to [Configuration](https://markup-fmt.netlify.app/).
## Credit
Tests come from:
- [Prettier](https://github.com/prettier/prettier/tree/main/tests/format)
- [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte)
- [prettier-plugin-astro](https://github.com/withastro/prettier-plugin-astro)
## License
MIT License
Copyright (c) 2023-present Pig Fang