feat(prettier-ignore): handle prettier-ignore comment

Gives an escape hatch.

Example usage:

````xquery
(: prettier-ignore :)
let $matrix := [
  1,  0,  0
  0, -1,  0
  1,  0, -1
]

return $matrix
```

Author: DrRataplan

README.md

@@ -1,14 +1,22 @@
 # Prettier for XQuery
-[![NPM version](https://badge.fury.io/js/prettier-plugin-xquery.svg)](http://badge.fury.io/js/prettier-plugin-xquery) [![Tests](https://github.com/DrRataplan/prettier-plugin-xquery/actions/workflows/test.yml/badge.svg)](https://github.com/DrRataplan/prettier-plugin-xquery/actions/workflows/test.yml) [![Coverage Status](https://coveralls.io/repos/github/DrRataplan/prettier-plugin-xquery/badge.svg)](https://coveralls.io/github/DrRataplan/prettier-plugin-xquery)
+[![NPM
+version](https://badge.fury.io/js/prettier-plugin-xquery.svg)](http://badge.fury.io/js/prettier-plugin-xquery)
+[![Tests](https://github.com/DrRataplan/prettier-plugin-xquery/actions/workflows/test.yml/badge.svg)](https://github.com/DrRataplan/prettier-plugin-xquery/actions/workflows/test.yml)
+[![Coverage
+Status](https://coveralls.io/repos/github/DrRataplan/prettier-plugin-xquery/badge.svg)](https://coveralls.io/github/DrRataplan/prettier-plugin-xquery)
 
-`prettier-plugin-xquery` is a [prettier](https://prettier.io/) plugin for XQuery. `prettier` is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead.
+`prettier-plugin-xquery` is a [prettier](https://prettier.io/) plugin for XQuery. `prettier` is an
+opinionated code formatter that supports multiple languages and integrates with most editors. The
+idea is to eliminate discussions of style in code review and allow developers to get back to
+thinking about code design instead.
 
 ## Demo
 A demo page lives at [xquery.elliat.nl](https://xquery.elliat.nl).
 
 ## Getting started
 
-To run `prettier` with the XQuery plugin, you're going to need [`node`](https://nodejs.org/en/download/).
+To run `prettier` with the XQuery plugin, you're going to need
+[`node`](https://nodejs.org/en/download/).
 
 If you're using the `npm` CLI, then add the plugin by:
 
@@ -68,6 +76,31 @@ Or, they can be passed to `prettier` as arguments:
 prettier --plugin=prettier-plugin-xquery --tab-width 4 --write '**/*.xq*'
 ```
 
+## Ignoring
+
+A `prettier-ignore` comment marks code as ignored for formatting. Like this:
+
+```xquery
+module namespace el = "http://www.elliat.nl";
+
+declare function el:reverse (
+  $a as xs:integer,
+  $b as xs:integer,
+  $c as xs:integer,
+  $d as xs:integer
+) {
+  ($d, $c, $b, $a)
+};
+
+(: prettier-ignore :)
+declare function el:swap (
+  $a as xs:integer, $b as xs:integer,
+  $c as xs:integer, $b as xs:integer
+) {
+  ($b, $a, $d, $c)
+};
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

src/main.ts

@@ -131,12 +131,21 @@ const xqueryParser: Parser<Node> = {
 	},
 };
 
+const hasPrettierIgnore = (path: AstPath<Node>): boolean => {
+	const node = path.node as NonCommentNode;
+
+	return node.hasComments() && node.comments!.some((c) => c.value.includes("prettier-ignore"));
+};
+
 const xqueryPrinter: Printer<Node> = {
-	getVisitorKeys(node, nonTraversableKeys) {
+	getVisitorKeys(_node, _nonTraversableKeys) {
 		// Only traverse into children, not childrenByName
 		return ["children"];
 	},
 	willPrintOwnComments(path: AstPath<Node>) {
+		if (hasPrettierIgnore(path)) {
+			return false;
+		}
 		if (path.node.name === "IntermediateClause") {
 			return true;
 		}
@@ -193,6 +202,7 @@ const xqueryPrinter: Printer<Node> = {
 		const node = path.node as CommentNode;
 		return printComment(node);
 	},
+	hasPrettierIgnore,
 	print(path: AstPath<Node>, options, print: Print, _args) {
 		if (path.node instanceof LeafNode) {
 			switch (path.node.name) {

test/comments.spec.ts

@@ -274,4 +274,54 @@ xxx:yyy()
 			});
 		}
 	});
+
+	describe("prettier-ignore", () => {
+		it("handles the prettier-ignore comment to ignore the root node", async () => {
+			const script = `
+(: prettier-ignore :)
+let $tree := (  1,
+               2,3,
+              4,5,6,
+             7,8,9,0
+)
+return sum($tree)
+`;
+			const result = await prettier.format(script, {
+				parser: "xquery",
+				plugins: [xqueryPlugin],
+			});
+
+			assert.equal(result.trim(), script.trim());
+		});
+
+		it("handles the prettier-ignore comment to ignore just a part", async () => {
+			const script = `
+let $normal := (  1,
+               2,3,
+              4,5,6,
+             7,8,9,0)
+(: prettier-ignore :)
+let $tree := (  1,
+               2,3,
+              4,5,6,
+             7,8,9,0
+)
+return sum($tree)
+`;
+			const expectedOutput = `let $normal := (1, 2, 3, 4, 5, 6, 7, 8, 9, 0)
+(: prettier-ignore :)
+let $tree := (  1,
+               2,3,
+              4,5,6,
+             7,8,9,0
+)
+return sum($tree)`;
+			const result = await prettier.format(script, {
+				parser: "xquery",
+				plugins: [xqueryPlugin],
+			});
+
+			assert.equal(result.trim(), expectedOutput.trim());
+		});
+	});
 });