Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 3.32 KB

README.md

File metadata and controls

96 lines (69 loc) · 3.32 KB


prettier-plugin-marko
TypeScript Styled with prettier Build status NPM Version Downloads

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

A Prettier plugin for parsing and printing Marko files.

Installation

npm

npm install prettier prettier-plugin-marko -D

yarn

yarn add prettier prettier-plugin-marko -D

Usage

NPM 6

npx --no-install prettier --write "**/*.marko"

NPM 7

npm exec -- prettier --write "**/*.marko"

Yarn

yarn prettier  --write "**/*.marko"

Editors

Editors such as Atom and VSCode provide plugins for calling Prettier directly from your editor.

If you'd like to use these plugins without installing prettier-plugin-marko in the project, you can also install prettier-plugin-marko globally with either npm, yarn or your package manager choice.

Options

On top of Prettier's options, there are a few additional options picked up by this plugin.

markoSyntax: "auto" | "html" | "concise"

Marko supports both an html like and 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.

markoAttrParen: boolean

For the most part Marko is very flexible when it comes to the expressions uses within attributes. By default this plugin will not wrap attribute values in parenthesis unless absolutely necessary. By setting this value to true it will instead output parenthesis whenever the attribute value contains any unenclosed whitespace.

Code of Conduct

This project adheres to the eBay Code of Conduct. By participating in this project you agree to abide by its terms.