Skip to content

Respect Prettier's behaviour for self closing elements #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Respect Prettier's behaviour for self closing elements #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87fc8cb
feat(html): Update self closing behaviour to be more in line with Pre…
Princesseuh Feb 6, 2023
6dcdcbc
chore: changeset
Princesseuh Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rich-keys-bake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'prettier-plugin-astro': minor
---

Updated self-closing behaviour to be more in line with Prettier's HTML formatter
43 changes: 31 additions & 12 deletions src/printer/elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,50 @@
export type TagName = keyof HTMLElementTagNameMap | 'svg';
export type TagName = keyof HTMLElementTagNameMap | keyof SVGElementTagNameMap;

// https://github.com/prettier/prettier/blob/main/vendors/html-void-elements.json
export const selfClosingTags = [
export const selfClosingTags: TagName[] = [
'area',
'base',
'basefont',
'bgsound',
'br',
'col',
'command',
'embed',
'frame',
'hr',
'image',
'img',
'input',
'isindex',
'keygen',
'link',
'menuitem',
'meta',
'nextid',
'param',
'slot',
'source',
'track',
'wbr',

// The SVG spec doesn't really have a concept of void elements, everything is allowed
// However, some tags are very commonly self-closed by users, and as such they find it confusing for them to not be closed
'circle',
'ellipse',
'line',
'path',
'polygon',
'polyline',
'rect',
'stop',
'use',

// Filters
'feBlend',
'feColorMatrix',
'feComponentTransfer',
'feComposite',
'feConvolveMatrix',
'feDiffuseLighting',
'feDisplacementMap',
'feFlood',
'feGaussianBlur',
'feMerge',
'feMorphology',
'feOffset',
'feSpecularLighting',
'feTile',
'feTurbulence',
];

// https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements#Elements
Expand Down
12 changes: 7 additions & 5 deletions src/printer/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Doc } from 'prettier';
import { selfClosingTags } from './elements';
import { selfClosingTags, type TagName } from './elements';
import { TextNode } from './nodes';
import {
AstPath,
Expand Down Expand Up @@ -130,16 +130,18 @@ export function print(path: AstPath, opts: ParserOptions, print: printFn): Doc {

/**
* An element is allowed to self close only if:
* It's already self-closing OR
* It is empty AND
* It's a component OR
* It's in the HTML spec as a void element OR
* It has a `set:*` directive
*/
const isSelfClosingTag =
isEmpty &&
(node.type === 'component' ||
selfClosingTags.includes(node.name) ||
hasSetDirectives(node));
(node.position?.end && opts.originalText.at(opts.locEnd(node) - 1) == '/') ||
(isEmpty &&
(node.type === 'component' ||
selfClosingTags.includes(node.name as TagName) ||
hasSetDirectives(node)));

const isSingleLinePerAttribute = opts.singleAttributePerLine && node.attributes.length > 1;
const attributeLine = isSingleLinePerAttribute ? breakParent : '';
Expand Down