prettier-plugin-marko/README.md

A prettier plugin for parsing and printing Marko files

<h1 align="center">
  <!-- Logo -->
  <br/>
  prettier-plugin-marko
	<br/>

  <!-- Language -->
  <a href="http://typescriptlang.org">
    <img src="https://img.shields.io/badge/%3C%2F%3E-typescript-blue.svg" alt="TypeScript"/>
  </a>
  <!-- Format -->
  <a href="https://github.com/prettier/prettier">
    <img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Styled with prettier"/>
  </a>
  <!-- CI -->
  <a href="https://github.com/marko-js/prettier/actions/workflows/ci.yml">
    <img src="https://github.com/marko-js/prettier/actions/workflows/ci.yml/badge.svg" alt="Build status"/>
  </a>
  <!-- Coverage -->
  <a href="https://codecov.io/gh/marko-js/prettier">
    <img src="https://codecov.io/gh/marko-js/prettier/branch/main/graph/badge.svg?token=v16tZuf0B1"/>
  </a>
  <!-- NPM Version -->
  <a href="https://npmjs.org/package/prettier-plugin-marko">
    <img src="https://img.shields.io/npm/v/prettier-plugin-marko.svg" alt="NPM Version"/>
  </a>
  <!-- Downloads -->
  <a href="https://npmjs.org/package/prettier-plugin-marko">
    <img src="https://img.shields.io/npm/dm/prettier-plugin-marko.svg" alt="Downloads"/>
  </a>
</h1>

> Note:
> For prettier@2 or below use `prettier-plugin-marko@2`.

A [Prettier](https://prettier.io/) plugin for parsing and printing Marko files.

# Installation

### npm

```console
npm install prettier prettier-plugin-marko -D
```

# Usage

See the Prettier ["using plugins"](https://prettier.io/docs/plugins#using-plugins) guide.

```console
npm exec -- prettier --write "**/*.marko" --plugin=prettier-plugin-marko
```

Or via [prettier configuration](https://prettier.io/docs/configuration) like:

```json
{
  "plugins": ["prettier-plugin-marko"]
}
```

## Editors

Editors such as [VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) provide plugins for calling [Prettier](https://prettier.io/) directly from your editor.

# Options

On top of [Prettier's options](https://prettier.io/docs/en/options.html), there are a few additional options picked up by this plugin.

## `markoSyntax: "auto" | "html" | "concise"`

Marko supports both an [html like](https://markojs.com/docs/syntax/) and [concise](https://markojs.com/docs/concise/) syntaxes.
By default this plugin will try to detect the syntax you are already using and output a formatted document in that syntax.

You can overide the default (`"auto"`) to enforce that all templates are formatted to the syntax of your choosing.

# Code of Conduct

This project adheres to the [eBay Code of Conduct](./.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.