TypeScript

Author: kddnewton

bin/print

@@ -0,0 +1,19 @@
+#!./node_modules/.bin/ts-node
+
+import fs from "fs";
+import prettier from "prettier";
+
+import plugin from "../src/plugin";
+import { XMLOptions } from "../src/types";
+
+const code = fs.existsSync(process.argv[2])
+  ? fs.readFileSync(process.argv[2], "utf-8")
+  : process.argv.slice(2).join(" ").replace(/\\n/g, "\n");
+
+const options: Partial<XMLOptions> = {
+  parser: "xml",
+  plugins: [plugin],
+  xmlWhitespaceSensitivity: "ignore"
+};
+
+console.log(prettier.format(code, options));

bin/print.ts

@@ -23,9 +23,14 @@
     "prettier": ">=1.10"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.23",
+    "@types/prettier": "^2.2.3",
     "eslint": "^7.0.0",
     "eslint-config-prettier": "^8.0.0",
-    "jest": "^27.0.1"
+    "jest": "^27.0.1",
+    "ts-jest": "^27.0.2",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.2"
   },
   "eslintConfig": {
     "extends": [
@@ -51,7 +56,8 @@
     }
   },
   "jest": {
-    "testRegex": ".test.js$"
+    "preset": "ts-jest",
+    "testRegex": ".test.ts$"
   },
   "prettier": {
     "trailingComma": "none"

package.json

@@ -1,4 +1,9 @@
-const { builders, utils } = require("prettier/doc");
+import { ContentCtx, ElementCstNode } from "@xml-tools/parser";
+import type { Doc, FastPath, ParserOptions, Printer } from "prettier";
+import { builders, utils } from "prettier/doc";
+
+import { XMLAST } from "./types";
+
 const {
   concat,
   dedentToRoot,
@@ -10,12 +15,11 @@ const {
   literalline,
   softline
 } = builders;
-const { mapDoc, stripTrailingHardline } = utils;
 
 // Replace the string content newlines within a doc tree with literallines so
 // that all of the indentation lines up appropriately
-const replaceNewlines = (doc) =>
-  mapDoc(doc, (currentDoc) =>
+function replaceNewlines(doc: Doc) {
+  return utils.mapDoc(doc, (currentDoc) =>
     typeof currentDoc === "string" && currentDoc.includes("\n")
       ? concat(
           currentDoc
@@ -24,14 +28,15 @@ const replaceNewlines = (doc) =>
         )
       : currentDoc
   );
+}
 
 // Get the start and end element tags from the current node on the tree
-const getElementTags = (path, print) => {
-  const node = path.getValue();
+function getElementTags(path: FastPath<XMLAST>, print: (path: FastPath<XMLAST>) => Doc) {
+  const node = path.getValue() as ElementCstNode;
   const { OPEN, Name, attribute, START_CLOSE, SLASH_OPEN, END_NAME, END } =
     node.children;
 
-  const parts = [OPEN[0].image, Name[0].image];
+  const parts: Doc[] = [OPEN[0].image, Name[0].image];
 
   if (attribute) {
     parts.push(
@@ -51,7 +56,7 @@ const getElementTags = (path, print) => {
 
 // Get the name of the parser that is represented by the given element node,
 // return null if a matching parser cannot be found
-const getParser = (node, opts) => {
+function getParser(node: ElementCstNode, opts: ParserOptions<XMLAST>) {
   const { Name, attribute } = node.children;
   const parser = Name[0].image.toLowerCase();
 
@@ -81,6 +86,7 @@ const getParser = (node, opts) => {
   if (
     opts.plugins.some(
       (plugin) =>
+        typeof plugin !== "string" &&
         plugin.parsers &&
         Object.prototype.hasOwnProperty.call(plugin.parsers, parser)
     )
@@ -89,26 +95,27 @@ const getParser = (node, opts) => {
   }
 
   return null;
-};
+}
 
 // Get the source string that will be passed into the embedded parser from the
 // content of the inside of the element node
-const getSource = (content) =>
-  content.chardata
+function getSource(content: ContentCtx) {
+  return content.chardata
     .map((node) => {
       const { SEA_WS, TEXT } = node.children;
       const [{ image }] = SEA_WS || TEXT;
 
       return {
-        offset: node.location.startOffset,
+        offset: node.location!.startOffset,
         printed: image
       };
     })
     .sort(({ offset }) => offset)
     .map(({ printed }) => printed)
     .join("");
+}
 
-const embed = (path, print, textToDoc, opts) => {
+const embed: Printer<XMLAST>["embed"] = (path, print, textToDoc, opts) => {
   const node = path.getValue();
 
   // If the node isn't an element node, then skip
@@ -140,7 +147,7 @@ const embed = (path, print, textToDoc, opts) => {
       literalline,
       dedentToRoot(
         replaceNewlines(
-          stripTrailingHardline(textToDoc(getSource(content), { parser }))
+          utils.stripTrailingHardline(textToDoc(getSource(content), { parser }))
         )
       ),
       hardline,
@@ -149,4 +156,4 @@ const embed = (path, print, textToDoc, opts) => {
   );
 };
 
-module.exports = embed;
+export default embed;

src/embed.js renamed to src/embed.ts

@@ -0,0 +1,29 @@
+import type { Parser } from "prettier";
+import { parse as xmlToolsParse } from "@xml-tools/parser";
+
+const parser: Parser = {
+  parse(text) {
+    const { lexErrors, parseErrors, cst } = xmlToolsParse(text);
+  
+    if (lexErrors.length > 0 || parseErrors.length > 0) {
+      throw Error("Error parsing XML");
+    }
+  
+    return cst;
+  },
+  astFormat: "xml",
+  locStart(node) {
+    if (node.location) {
+      return node.location.startOffset;
+    }
+    return node.startOffset;
+  },
+  locEnd(node) {
+    if (node.location) {
+      return node.location.endOffset;
+    }
+    return node.endOffset;
+  }
+};
+
+export default parser;