CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.2.1] - 2023-09-11
+
+### Added
+
+- Updated the documentation to reflect that you need to pass the plugin path now.
+
+### Changed
+
+- Error messages thrown by the plugin are now much closer to the error messages thrown by prettier.
+- Fixed a bug where self-closing tags that looked like embeds would throw an error.
+
 ## [3.2.0] - 2023-08-08
 
 ### Added
@@ -228,7 +239,8 @@ and it will maintain your formatting.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-xml/compare/v3.2.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-xml/compare/v3.2.1...HEAD
+[3.2.1]: https://github.com/prettier/plugin-xml/compare/v3.2.0...v3.2.1
 [3.2.0]: https://github.com/prettier/plugin-xml/compare/v3.1.1...v3.2.0
 [3.1.1]: https://github.com/prettier/plugin-xml/compare/v3.1.0...v3.1.1
 [3.1.0]: https://github.com/prettier/plugin-xml/compare/v3.0.0...v3.1.0

README.md

@@ -39,7 +39,7 @@ yarn add --dev prettier @prettier/plugin-xml
 The `prettier` executable is now installed and ready for use:
 
 ```bash
-./node_modules/.bin/prettier --write '**/*.xml'
+./node_modules/.bin/prettier --plugin=@prettier/plugin-xml --write '**/*.xml'
 ```
 
 ## Configuration
@@ -69,7 +69,7 @@ file](https://prettier.io/docs/en/configuration.html). For example:
 Or, they can be passed to `prettier` as arguments:
 
 ```bash
-prettier --tab-width 4 --write '**/*.xml'
+prettier --plugin=@prettier/plugin-xml --tab-width 4 --write '**/*.xml'
 ```
 
 ### Whitespace

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-xml",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "prettier plugin for XML",
   "type": "module",
   "main": "src/plugin.js",
@@ -32,7 +32,7 @@
     "husky": "^8.0.0",
     "jest": "^29.2.1",
     "linguist-languages": "^7.21.0",
-    "lint-staged": "^13.2.3",
+    "lint-staged": "^14.0.0",
     "prettier": "^3.0.0"
   },
   "eslintConfig": {

src/embed.js

@@ -124,6 +124,11 @@ function embed(path, opts) {
     return;
   }
 
+  // If the node is self-closing, then skip
+  if (!node.children.content) {
+    return;
+  }
+
   // If the node does not actually contain content, or it contains any content
   // that is not just plain text, then skip
   const content = node.children.content[0].children;

src/parser.js

@@ -1,34 +1,54 @@
 import { parse as xmlToolsParse } from "@xml-tools/parser";
 
+function createError(message, options) {
+  // TODO: Use `Error.prototype.cause` when we drop support for Node.js<18.7.0
+
+  // Construct an error similar to the ones thrown by Prettier.
+  const error = new SyntaxError(
+    message +
+      " (" +
+      options.loc.start.line +
+      ":" +
+      options.loc.start.column +
+      ")"
+  );
+
+  return Object.assign(error, options);
+}
+
 const parser = {
   parse(text) {
     const { lexErrors, parseErrors, cst } = xmlToolsParse(text);
 
     // If there are any lexical errors, throw the first of them as an error.
     if (lexErrors.length > 0) {
       const lexError = lexErrors[0];
-      const error = new Error(lexError.message);
-
-      error.loc = {
-        start: { line: lexError.line, column: lexError.column },
-        end: { line: lexError.line, column: lexError.column + lexError.length }
-      };
-
-      throw error;
+      throw createError(lexError.message, {
+        loc: {
+          start: { line: lexError.line, column: lexError.column },
+          end: {
+            line: lexError.line,
+            column: lexError.column + lexError.length
+          }
+        }
+      });
     }
 
     // If there are any parse errors, throw the first of them as an error.
     if (parseErrors.length > 0) {
       const parseError = parseErrors[0];
-      const error = new Error(parseError.message);
-
-      const { token } = parseError;
-      error.loc = {
-        start: { line: token.startLine, column: token.startColumn },
-        end: { line: token.endLine, column: token.endColumn }
-      };
-
-      throw error;
+      throw createError(parseError.message, {
+        loc: {
+          start: {
+            line: parseError.token.startLine,
+            column: parseError.token.startColumn
+          },
+          end: {
+            line: parseError.token.endLine,
+            column: parseError.token.endColumn
+          }
+        }
+      });
     }
 
     // Otherwise return the CST.

test/embed.test.js

@@ -89,3 +89,10 @@ customScript!!!
 
   expect(formatted).toEqual(expected);
 });
+
+test("does not embed when self-closing", async () => {
+  const expected = `<script type="text/javascript" />\n`;
+  const formatted = await format(expected);
+
+  expect(formatted).toEqual(expected);
+});

test/parser.test.js

@@ -0,0 +1,12 @@
+import parser from "../src/parser.js";
+
+test("parseError", () => {
+  const expected = new SyntaxError(
+    "Expecting: one of these possible Token sequences:\n" +
+      "  1. [CLOSE]\n" +
+      "  2. [SLASH_CLOSE]\n" +
+      "but found: '/' (1:6)"
+  );
+
+  expect(() => parser.parse("<foo /")).toThrow(expected);
+});