@unified-latex/unified-latex 1.0.5

package/README.md

@@ -0,0 +1,30 @@
+<!-- DO NOT MODIFY -->
+<!-- This file was autogenerated by build-docs.ts -->
+<!-- Edit the docstring in index.ts and regenerate -->
+<!-- rather than editing this file directly. -->
+# unified-latex
+
+## What is this?
+
+Functions parse strings to a `unified-latex` Abstract Syntax Tree (AST).
+
+## When should I use this?
+
+If you have a string that you would like to parse to a `unified-latex` `Ast.Ast`, or
+if you are building a plugin for `unified()` that manipulates LaTeX.
+
+## Install
+
+```bash
+npm install @unified-latex/unified-latex
+```
+
+This package contains both esm and commonjs exports. To explicitly access the esm export,
+import the `.js` file. To explicitly access the commonjs export, import the `.cjs` file.
+
+# Constants
+
+| Name                          | Type                                                    | Description                                                                                                                                   |
+| :---------------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- |
+| `processLatexToAstViaUnified` | `() => Processor<Ast.Root, Ast.Root, Ast.Root, void>`   | Use `unified()` to a string to an `Ast.Ast` and then return it. This function&#xA;will not print/pretty-print the `Ast.Ast` back to a string. |
+| `processLatexViaUnified`      | `() => Processor<Ast.Root, Ast.Root, Ast.Root, string>` | Use `unified()` to a string to an `Ast.Ast` and then pretty-print it.                                                                         |

package/dist/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../index.ts", "../libs/unified-latex.ts"],
+  "sourcesContent": ["export * from \"./libs/unified-latex\";\n\n// NOTE: The docstring comment must be the last item in the index.ts file!\n/**\n * ## What is this?\n *\n * Functions parse strings to a `unified-latex` Abstract Syntax Tree (AST).\n *\n * ## When should I use this?\n *\n * If you have a string that you would like to parse to a `unified-latex` `Ast.Ast`, or\n * if you are building a plugin for `unified()` that manipulates LaTeX.\n */\n", "import { unified } from \"unified\";\nimport * as Ast from \"@unified-latex/unified-latex-types\";\nimport {\n    unifiedLatexAstComplier,\n    unifiedLatexFromString,\n} from \"@unified-latex/unified-latex-util-parse\";\nimport { unifiedLatexStringCompiler } from \"@unified-latex/unified-latex-util-to-string\";\n/**\n * Use `unified()` to a string to an `Ast.Ast` and then pretty-print it.\n */\nexport const processLatexViaUnified = () => {\n    return unified()\n        .use(unifiedLatexFromString)\n        .use(unifiedLatexStringCompiler, { pretty: true });\n};\n\n/**\n * Use `unified()` to a string to an `Ast.Ast` and then return it. This function\n * will not print/pretty-print the `Ast.Ast` back to a string.\n */\nexport const processLatexToAstViaUnified = () => {\n    return unified().use(unifiedLatexFromString).use(unifiedLatexAstComplier);\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,qBAAwB;AAExB,sCAGO;AACP,0CAA2C;AAIpC,IAAM,yBAAyB,MAAM;AACxC,SAAO,4BAAQ,EACV,IAAI,sDAAsB,EAC1B,IAAI,gEAA4B,EAAE,QAAQ,KAAK,CAAC;AACzD;AAMO,IAAM,8BAA8B,MAAM;AAC7C,SAAO,4BAAQ,EAAE,IAAI,sDAAsB,EAAE,IAAI,uDAAuB;AAC5E;",
+  "names": []
+}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./libs/unified-latex";
+/**
+ * ## What is this?
+ *
+ * Functions parse strings to a `unified-latex` Abstract Syntax Tree (AST).
+ *
+ * ## When should I use this?
+ *
+ * If you have a string that you would like to parse to a `unified-latex` `Ast.Ast`, or
+ * if you are building a plugin for `unified()` that manipulates LaTeX.
+ */
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AAGrC;;;;;;;;;GASG"}

package/dist/index.js

@@ -0,0 +1,18 @@
+// libs/unified-latex.ts
+import { unified } from "unified";
+import {
+  unifiedLatexAstComplier,
+  unifiedLatexFromString
+} from "@unified-latex/unified-latex-util-parse";
+import { unifiedLatexStringCompiler } from "@unified-latex/unified-latex-util-to-string";
+var processLatexViaUnified = () => {
+  return unified().use(unifiedLatexFromString).use(unifiedLatexStringCompiler, { pretty: true });
+};
+var processLatexToAstViaUnified = () => {
+  return unified().use(unifiedLatexFromString).use(unifiedLatexAstComplier);
+};
+export {
+  processLatexToAstViaUnified,
+  processLatexViaUnified
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../libs/unified-latex.ts"],
+  "sourcesContent": ["import { unified } from \"unified\";\nimport * as Ast from \"@unified-latex/unified-latex-types\";\nimport {\n    unifiedLatexAstComplier,\n    unifiedLatexFromString,\n} from \"@unified-latex/unified-latex-util-parse\";\nimport { unifiedLatexStringCompiler } from \"@unified-latex/unified-latex-util-to-string\";\n/**\n * Use `unified()` to a string to an `Ast.Ast` and then pretty-print it.\n */\nexport const processLatexViaUnified = () => {\n    return unified()\n        .use(unifiedLatexFromString)\n        .use(unifiedLatexStringCompiler, { pretty: true });\n};\n\n/**\n * Use `unified()` to a string to an `Ast.Ast` and then return it. This function\n * will not print/pretty-print the `Ast.Ast` back to a string.\n */\nexport const processLatexToAstViaUnified = () => {\n    return unified().use(unifiedLatexFromString).use(unifiedLatexAstComplier);\n};\n"],
+  "mappings": ";AAAA;AAEA;AAAA;AAAA;AAAA;AAIA;AAIO,IAAM,yBAAyB,MAAM;AACxC,SAAO,QAAQ,EACV,IAAI,sBAAsB,EAC1B,IAAI,4BAA4B,EAAE,QAAQ,KAAK,CAAC;AACzD;AAMO,IAAM,8BAA8B,MAAM;AAC7C,SAAO,QAAQ,EAAE,IAAI,sBAAsB,EAAE,IAAI,uBAAuB;AAC5E;",
+  "names": []
+}

package/dist/libs/unified-latex.d.ts

@@ -0,0 +1,11 @@
+import * as Ast from "@unified-latex/unified-latex-types";
+/**
+ * Use `unified()` to a string to an `Ast.Ast` and then pretty-print it.
+ */
+export declare const processLatexViaUnified: () => import("unified").Processor<Ast.Root, Ast.Root, Ast.Root, string>;
+/**
+ * Use `unified()` to a string to an `Ast.Ast` and then return it. This function
+ * will not print/pretty-print the `Ast.Ast` back to a string.
+ */
+export declare const processLatexToAstViaUnified: () => import("unified").Processor<Ast.Root, Ast.Root, Ast.Root, void>;
+//# sourceMappingURL=unified-latex.d.ts.map

package/dist/libs/unified-latex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unified-latex.d.ts","sourceRoot":"","sources":["../../libs/unified-latex.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,oCAAoC,CAAC;AAM1D;;GAEG;AACH,eAAO,MAAM,sBAAsB,yEAIlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,uEAEvC,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+    "name": "@unified-latex/unified-latex",
+    "version": "1.0.5",
+    "description": "Process LaTeX to an AST or a string",
+    "main": "dist/index.js",
+    "type": "module",
+    "dependencies": {
+        "@unified-latex/unified-latex-types": "^1.0.5",
+        "@unified-latex/unified-latex-util-parse": "^1.0.5",
+        "@unified-latex/unified-latex-util-to-string": "^1.0.5",
+        "unified": "^10.1.2"
+    },
+    "files": [
+        "dist/**/*.ts",
+        "dist/**/*.js",
+        "dist/**/*.map",
+        "dist/**/*.json"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.cjs"
+        },
+        "./*js": "./dist/*js",
+        "./*": {
+            "import": "./dist/*.js",
+            "require": "./dist/*.cjs"
+        }
+    },
+    "scripts": {
+        "build": "npm run clean && mkdirp ./dist && npm run compile",
+        "clean": "rm -rf ./dist && rm -rf tsconfig.tsbuildinfo",
+        "compile": "tsc -b tsconfig.json & node build.js & wait",
+        "test": "jest"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/siefkenj/unified-latex.git"
+    },
+    "keywords": [
+        "pegjs",
+        "latex",
+        "parser",
+        "prettier",
+        "unified-latex",
+        "unified"
+    ],
+    "author": "Jason Siefken",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/siefkenj/unified-latex/issues"
+    },
+    "homepage": "https://github.com/siefkenj/unified-latex#readme",
+    "jest": {
+        "transformIgnorePatterns": [
+            "node_modules/(?!unified|bail|is-plain-obj|trough|vfile.*|unist.*|hast.*|property-information|html-void-elements|.*-separated-tokens|.*entities.*|ccount|rehype*|string-width|strip-ansi|ansi-regex|supports-color)"
+        ],
+        "transform": {
+            "\\.m?jsx?$": "esbuild-jest",
+            "latex.pegjs$": "<rootDir>/../../tests/pegjs-preprocessor-latex.js",
+            "\\.pegjs$": "<rootDir>/../../tests/pegjs-preprocessor.js",
+            "^.+\\.tsx?$": "ts-jest"
+        }
+    }
+}