Prettier Plugin for Astro

Official Prettier plugin adding support for formatting .astro files.

Installation

npm i --save-dev prettier-plugin-astro prettier

Recommended configuration

For optimal compatibility with the different package managers and Prettier plugins, we recommend manually specifying your plugins and the parser to use for Astro files in your Prettier config as shown in the example below:

module.exports = {
  plugins: [require.resolve('prettier-plugin-astro')],
  overrides: [
    {
      files: '*.astro',
      options: {
        parser: 'astro',
      },
    },
  ],
};

Alternatively, for use inside a non-JS config file, the require.resolve call can be changed to a direct path, such as plugins: ["./node_modules/prettier-plugin-astro"].

To customize formatting behavior, see the Configuration section below.

Using in VS Code

Note If you're using Astro's VS Code extension, Prettier and this plugin are already included. Only follow the guide below to format using Prettier's official extension.

First install the VS Code Prettier extension and add the following settings to your VS Code configuration:

{
  "prettier.documentSelectors": ["**/*.astro"],
  "[astro]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

The settings above ensure that VS Code is aware that Prettier can be used for Astro files, and sets Prettier as the default formatter for Astro files.

Reporting issues

When submitting issues about formatting your .astro files in VS Code, please specify which extension you are using to format your files: Astro's own extension or the Prettier extension.

Configuration

Most options from Prettier will work with the plugin and can be set in a configuration file or through CLI flags.

Astro Allow Shorthand

Set if attributes with the same name as their expression should be formatted to the short form automatically (for example, if enabled <element name={name} /> will become simply <element {name} />)

Default	CLI Override	API Override
false	--astro-allow-shorthand <bool>	astroAllowShorthand: <bool>

Example .prettierrc.cjs

{
  astroAllowShorthand: false;
}

Contributing

Pull requests of any size and any skill level are welcome, no contribution is too small. Changes to the Astro Prettier Plugin are subject to Astro Governance and should adhere to the Astro Style Guide.

See CONTRIBUTING.md for instructions on how to set up your development environment.

Sponsors

Astro is generously supported by Netlify, Storyblok, and several other amazing organizations.

❤️ Sponsor Astro! ❤️