tex2typst 0.0.11 → 0.0.16

package/.github/workflows/github-ci.yml

@@ -0,0 +1,35 @@
+name: tex2typst Tests
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  unit-tests:
+    name: Unit tests
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [18]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup node env
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run Vitest Test
+        run: npx vitest run

package/dist/map.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.symbolMap = void 0;
 exports.symbolMap = new Map([
     ['gets', 'arrow.l'],
-    ['infty', 'infinity'], // infinity
     ['nonumber', ''],
     ['vec', 'arrow'],
     ['mathbf', 'bold'],
@@ -44,36 +43,6 @@ exports.symbolMap = new Map([
     ['boxplus', 'plus.square'],
     ['otimes', 'times.circle'],
     ['boxtimes', 'times.square'],
-    /* symbols in mathematical logic */
-    ['neg', 'not'],
-    ['land', 'and'],
-    ['lor', 'or'],
-    ['varnothing', 'diameter'], // empty set
-    /* symbols about comparing numbers */
-    // tex: \neq \leq \geq \ll \gg \prec \succ \preceq \succeq
-    // typst: eq.not lt.eq gt.eq lt.double gt.double prec succ prec.eq succ.eq
-    ['neq', 'eq.not'],
-    ['leq', 'lt.eq'],
-    ['geq', 'gt.eq'],
-    ['ll', 'lt.double'],
-    ['gg', 'gt.double'],
-    ['prec', 'prec'],
-    ['succ', 'succ'],
-    ['preceq', 'prec.eq'],
-    ['succeq', 'succ.eq'],
-    /* symbols about differential */
-    ['Delta', 'Delta'],
-    ['nabla', 'nabla'],
-    ['partial', 'diff'],
-    /* symbols about integral */
-    // tex: \int \oint \iint \oiint \iiint \oiiint
-    // typst: integral integral.cont integral.double integral.surf integral.triple integral.vol
-    ['int', 'integral'],
-    ['oint', 'integral.cont'],
-    ['iint', 'integral.double'],
-    ['oiint', 'integral.surf'],
-    ['iiint', 'integral.triple'],
-    ['oiiint', 'integral.vol'],
     /* wave */
     // tex: \sim \approx \cong \simeq \asymp \equiv \propto
     // typst: tilde approx tilde.equiv tilde.eq ≍ equiv prop
@@ -94,7 +63,6 @@ exports.symbolMap = new Map([
     ['leftrightarrow', 'arrow.l.r'],
     ['longleftrightarrow', 'arrow.l.r.long'],
     ['rightrightarrows', 'arrows.rr'],
-    ['binom', 'binom'],
     /* left and right floor,ceil */
     // tex: \lfloor \rfloor \lceil \rceil
     // typst: ⌊ ⌋ ⌈ ⌉ 
@@ -181,12 +149,14 @@ exports.symbolMap = new Map([
     ['iiint', 'integral.triple'],
     ['iint', 'integral.double'],
     ['in', 'in'],
+    ['infty', 'infinity'],
     ['int', 'integral'],
     ['intercal', 'top'], // 'top' or 'tack.b'
     ['iota', 'iota'],
     ['jmath', 'dotless.j'],
     ['kappa', 'kappa'],
     ['lambda', 'lambda'],
+    ['land', 'and'],
     ['langle', 'angle.l'],
     ['lbrace', 'brace.l'],
     ['lbrack', 'bracket.l'],
@@ -202,6 +172,7 @@ exports.symbolMap = new Map([
     ['ll', 'lt.double'],
     ['longmapsto', 'arrow.long.bar'],
     ['longrightarrow', 'arrow.long'],
+    ['lor', 'or'],
     ['ltimes', 'times.l'],
     ['mapsto', 'arrow.bar'],
     ['measuredangle', 'angle.arc'],
@@ -215,14 +186,25 @@ exports.symbolMap = new Map([
     ['ne', 'eq.not'],
     ['neg', 'not'],
     ['neq', 'eq.not'],
+    ['nexists', 'exists.not'],
+    ['ni', "in.rev"],
+    ['nleftarrow', "arrow.l.not"],
+    ['nleq', "lt.eq.not"],
+    ['nparallel', "parallel.not"],
+    ['ngeq', 'gt.eq.not'],
     ['nmid', 'divides.not'],
     ['notin', 'in.not'],
-    ['nleftarrow', 'arrow.l.not'],
     ['nrightarrow', 'arrow.not'],
     ['nsim', 'tilde.not'],
+    ['nsubseteq', 'subset.eq.not'],
     ['nu', 'nu'],
+    ['ntriangleleft', 'lt.tri.not'],
+    ['ntriangleright', 'gt.tri.not'],
+    ['nwarrow', 'arrow.tl'],
     ['odot', 'dot.circle'],
     ['oint', 'integral.cont'],
+    ['oiint', 'integral.surf'],
+    ['oiiint', 'integral.vol'],
     ['omega', 'omega'],
     // ['omicron', 'omicron'], 
     ['ominus', 'minus.circle'],
@@ -234,6 +216,7 @@ exports.symbolMap = new Map([
     ['phi', 'phi.alt'],
     ['pi', 'pi'],
     ['pm', 'plus.minus'],
+    ['pounds', 'pound'],
     ['prec', 'prec'],
     ['preceq', 'prec.eq'],
     ['prime', 'prime'],
@@ -252,9 +235,14 @@ exports.symbolMap = new Map([
     ['sigma', 'sigma'],
     ['sim', 'tilde'],
     ['simeq', 'tilde.eq'],
+    ['slash', 'slash'],
+    ['smallsetminus', 'without'],
     // ['smile', 'paren.b'], 
+    ['spadesuit', 'suit.spade'],
     ['sqcap', 'sect.sq'],
     ['sqcup', 'union.sq'],
+    ['sqsubseteq', 'subset.eq.sq'],
+    ['sqsupseteq', 'supset.eq.sq'],
     ['star', 'star'],
     ['subset', 'subset'],
     ['subseteq', 'subset.eq'],
@@ -265,19 +253,24 @@ exports.symbolMap = new Map([
     ['supset', 'supset'],
     ['supseteq', 'supset.eq'],
     ['supsetneq', 'supset.neq'],
+    ['swarrow', 'arrow.bl'],
     ['tau', 'tau'],
     ['theta', 'theta'],
     ['times', 'times'],
     ['to', 'arrow.r'],
+    ['top', 'top'],
     ['triangle', 'triangle.t'],
+    ['triangledown', 'triangle.b.small'],
     ['triangleleft', 'triangle.l.small'],
-    ['triangleright', 'triangle.small'],
+    ['triangleright', 'triangle.r.small'],
+    ['twoheadrightarrow', 'arrow.r.twohead'],
     ['uparrow', 'arrow.t'],
     ['updownarrow', 'arrow.t.b'],
     ['upharpoonright', 'harpoon.tr'],
     ['uplus', 'union.plus'],
     ['upsilon', 'upsilon'],
     ['varepsilon', 'epsilon'],
+    ['varnothing', 'diameter'], // empty set
     ['varphi', 'phi'],
     ['varpi', 'pi.alt'],
     ['varrho', 'rho.alt'],
@@ -289,5 +282,10 @@ exports.symbolMap = new Map([
     ['wedge', 'and'],
     ['wr', 'wreath'],
     ['xi', 'xi'],
+    ['yen', 'yen'],
     ['zeta', 'zeta'],
+    // extended
+    ['mathscr', 'scr'],
+    ['LaTeX', '#LaTeX'],
+    ['TeX', '#TeX'],
 ]);

package/dist/parser.js

@@ -246,7 +246,7 @@ function parseTex(tex, customTexMacros) {
     // displayMode=true. Otherwise, "KaTeX parse error: {align*} can be used only in display mode."
     const macros = Object.assign({ 
         // KaTeX parse these commands so complicatedly that we need some hacks to keep things simple.
-        '\\mod': '\\operatorname{SyMb01-mod}', '\\liminf': '\\operatorname{SyMb01-liminf}', '\\limsup': '\\operatorname{SyMb01-limsup}', '\\qquad': '\\operatorname{SyMb01-qquad}', '\\quad': '\\operatorname{SyMb01-quad}', '\\cdots': '\\operatorname{SyMb01-cdots}', '\\colon': '\\operatorname{SyMb01-colon}', '\\imath': '\\operatorname{SyMb01-imath}', '\\\iiiint': '\\operatorname{SyMb01-iiiint}', '\\jmath': '\\operatorname{SyMb01-jmath}', '\\vdots': '\\operatorname{SyMb01-vdots}', '\\notin': '\\operatorname{SyMb01-notin}' }, customTexMacros);
+        '\\mod': '\\operatorname{SyMb01-mod}', '\\liminf': '\\operatorname{SyMb01-liminf}', '\\limsup': '\\operatorname{SyMb01-limsup}', '\\qquad': '\\operatorname{SyMb01-qquad}', '\\quad': '\\operatorname{SyMb01-quad}', '\\cdots': '\\operatorname{SyMb01-cdots}', '\\colon': '\\operatorname{SyMb01-colon}', '\\imath': '\\operatorname{SyMb01-imath}', '\\\iiiint': '\\operatorname{SyMb01-iiiint}', '\\jmath': '\\operatorname{SyMb01-jmath}', '\\vdots': '\\operatorname{SyMb01-vdots}', '\\notin': '\\operatorname{SyMb01-notin}', '\\slash': '\\operatorname{SyMb01-slash}', '\\LaTeX': '\\operatorname{SyMb01-LaTeX}', '\\TeX': '\\operatorname{SyMb01-TeX}' }, customTexMacros);
     const options = {
         macros: macros,
         displayMode: true,

package/dist/writer.js

@@ -310,6 +310,22 @@ class TypstWriter {
     }
     finalize() {
         this.flushQueue();
+        const smartFloorPass = function (input) {
+            // Use regex to replace all "⌊ xxx ⌋" with "floor(xxx)"
+            let res = input.replace(/⌊\s*(.*?)\s*⌋/g, "floor($1)");
+            // Typst disallow "floor()" with empty argument, so add am empty string inside if it's empty.
+            res = res.replace(/floor\(\)/g, 'floor("")');
+            return res;
+        };
+        const smartCeilPass = function (input) {
+            // Use regex to replace all "⌈ xxx ⌉" with "ceil(xxx)"
+            let res = input.replace(/⌈\s*(.*?)\s*⌉/g, "ceil($1)");
+            // Typst disallow "ceil()" with empty argument, so add an empty string inside if it's empty.
+            res = res.replace(/ceil\(\)/g, 'ceil("")');
+            return res;
+        };
+        this.buffer = smartFloorPass(this.buffer);
+        this.buffer = smartCeilPass(this.buffer);
         return this.buffer;
     }
 }
@@ -321,6 +337,9 @@ function convertToken(token) {
     else if (token === '\\\\') {
         return '\\\n';
     }
+    else if (['\\$', '\\#', '\\&', '\\_'].includes(token)) {
+        return token;
+    }
     else if (token.startsWith('\\')) {
         const symbol = token.slice(1);
         if (map_1.symbolMap.has(symbol)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tex2typst",
-  "version": "0.0.11",
+  "version": "0.0.16",
   "description": "JavaScript library for converting TeX code to Typst",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/map.ts

@@ -1,6 +1,5 @@
 export const symbolMap = new Map<string, string>([
     ['gets', 'arrow.l'],
-    ['infty', 'infinity'], // infinity
     ['nonumber', ''],
     ['vec', 'arrow'],
     ['mathbf', 'bold'],
@@ -46,40 +45,6 @@ export const symbolMap = new Map<string, string>([
     ['otimes', 'times.circle'],
     ['boxtimes', 'times.square'],
 
-    /* symbols in mathematical logic */
-    ['neg', 'not'],
-    ['land', 'and'],
-    ['lor', 'or'],
-
-    ['varnothing', 'diameter'], // empty set
-
-    /* symbols about comparing numbers */
-    // tex: \neq \leq \geq \ll \gg \prec \succ \preceq \succeq
-    // typst: eq.not lt.eq gt.eq lt.double gt.double prec succ prec.eq succ.eq
-    ['neq', 'eq.not'],
-    ['leq', 'lt.eq'],
-    ['geq', 'gt.eq'],
-    ['ll', 'lt.double'],
-    ['gg', 'gt.double'],
-    ['prec', 'prec'],
-    ['succ', 'succ'],
-    ['preceq', 'prec.eq'],
-    ['succeq', 'succ.eq'],
-
-    /* symbols about differential */
-    ['Delta', 'Delta'],
-    ['nabla', 'nabla'],
-    ['partial', 'diff'],
-
-    /* symbols about integral */
-    // tex: \int \oint \iint \oiint \iiint \oiiint
-    // typst: integral integral.cont integral.double integral.surf integral.triple integral.vol
-    ['int', 'integral'],
-    ['oint', 'integral.cont'],
-    ['iint', 'integral.double'],
-    ['oiint', 'integral.surf'],
-    ['iiint', 'integral.triple'],
-    ['oiiint', 'integral.vol'],
 
     /* wave */
     // tex: \sim \approx \cong \simeq \asymp \equiv \propto
@@ -103,7 +68,6 @@ export const symbolMap = new Map<string, string>([
     ['longleftrightarrow', 'arrow.l.r.long'],
     ['rightrightarrows', 'arrows.rr'],
 
-    ['binom', 'binom'],
 
     /* left and right floor,ceil */
     // tex: \lfloor \rfloor \lceil \rceil
@@ -193,12 +157,14 @@ export const symbolMap = new Map<string, string>([
     ['iiint', 'integral.triple'], 
     ['iint', 'integral.double'], 
     ['in', 'in'], 
+    ['infty', 'infinity'],
     ['int', 'integral'], 
     ['intercal', 'top'],  // 'top' or 'tack.b'
     ['iota', 'iota'], 
     ['jmath', 'dotless.j'], 
     ['kappa', 'kappa'], 
     ['lambda', 'lambda'], 
+    ['land', 'and'],
     ['langle', 'angle.l'], 
     ['lbrace', 'brace.l'], 
     ['lbrack', 'bracket.l'], 
@@ -214,6 +180,7 @@ export const symbolMap = new Map<string, string>([
     ['ll', 'lt.double'], 
     ['longmapsto', 'arrow.long.bar'], 
     ['longrightarrow', 'arrow.long'], 
+    ['lor', 'or'],
     ['ltimes', 'times.l'], 
     ['mapsto', 'arrow.bar'], 
     ['measuredangle', 'angle.arc'], 
@@ -227,14 +194,25 @@ export const symbolMap = new Map<string, string>([
     ['ne', 'eq.not'], 
     ['neg', 'not'], 
     ['neq', 'eq.not'], 
+    ['nexists', 'exists.not'],
+    ['ni', "in.rev"],
+    ['nleftarrow', "arrow.l.not"],
+    ['nleq', "lt.eq.not"],
+    ['nparallel', "parallel.not"],
+    ['ngeq', 'gt.eq.not'],
     ['nmid', 'divides.not'], 
     ['notin', 'in.not'], 
-    ['nleftarrow', 'arrow.l.not'], 
     ['nrightarrow', 'arrow.not'], 
     ['nsim', 'tilde.not'], 
+    ['nsubseteq', 'subset.eq.not'],
     ['nu', 'nu'], 
+    ['ntriangleleft', 'lt.tri.not'],
+    ['ntriangleright', 'gt.tri.not'],
+    ['nwarrow', 'arrow.tl'],
     ['odot', 'dot.circle'], 
     ['oint', 'integral.cont'], 
+    ['oiint', 'integral.surf'],
+    ['oiiint', 'integral.vol'],
     ['omega', 'omega'], 
     // ['omicron', 'omicron'], 
     ['ominus', 'minus.circle'], 
@@ -246,6 +224,7 @@ export const symbolMap = new Map<string, string>([
     ['phi', 'phi.alt'], 
     ['pi', 'pi'], 
     ['pm', 'plus.minus'], 
+    ['pounds', 'pound'], 
     ['prec', 'prec'], 
     ['preceq', 'prec.eq'], 
     ['prime', 'prime'], 
@@ -264,9 +243,14 @@ export const symbolMap = new Map<string, string>([
     ['sigma', 'sigma'], 
     ['sim', 'tilde'], 
     ['simeq', 'tilde.eq'], 
+    ['slash', 'slash'], 
+    ['smallsetminus', 'without'], 
     // ['smile', 'paren.b'], 
+    ['spadesuit', 'suit.spade'],
     ['sqcap', 'sect.sq'], 
     ['sqcup', 'union.sq'], 
+    ['sqsubseteq', 'subset.eq.sq'],
+    ['sqsupseteq', 'supset.eq.sq'],
     ['star', 'star'], 
     ['subset', 'subset'], 
     ['subseteq', 'subset.eq'], 
@@ -277,19 +261,24 @@ export const symbolMap = new Map<string, string>([
     ['supset', 'supset'], 
     ['supseteq', 'supset.eq'], 
     ['supsetneq', 'supset.neq'], 
+    ['swarrow', 'arrow.bl'], 
     ['tau', 'tau'], 
     ['theta', 'theta'], 
     ['times', 'times'], 
     ['to', 'arrow.r'], 
+    ['top', 'top'], 
     ['triangle', 'triangle.t'], 
+    ['triangledown', 'triangle.b.small'], 
     ['triangleleft', 'triangle.l.small'], 
-    ['triangleright', 'triangle.small'], 
+    ['triangleright', 'triangle.r.small'], 
+    ['twoheadrightarrow', 'arrow.r.twohead'], 
     ['uparrow', 'arrow.t'], 
     ['updownarrow', 'arrow.t.b'], 
     ['upharpoonright', 'harpoon.tr'], 
     ['uplus', 'union.plus'], 
     ['upsilon', 'upsilon'], 
     ['varepsilon', 'epsilon'], 
+    ['varnothing', 'diameter'], // empty set
     ['varphi', 'phi'], 
     ['varpi', 'pi.alt'], 
     ['varrho', 'rho.alt'], 
@@ -301,5 +290,11 @@ export const symbolMap = new Map<string, string>([
     ['wedge', 'and'], 
     ['wr', 'wreath'], 
     ['xi', 'xi'], 
+    ['yen', 'yen'], 
     ['zeta', 'zeta'], 
+
+    // extended
+    ['mathscr', 'scr'],
+    ['LaTeX', '#LaTeX'],
+    ['TeX', '#TeX'],
 ]);

package/src/parser.ts

@@ -253,6 +253,9 @@ export function parseTex(tex: string, customTexMacros: {[key: string]: string}):
         '\\jmath': '\\operatorname{SyMb01-jmath}',
         '\\vdots': '\\operatorname{SyMb01-vdots}',
         '\\notin': '\\operatorname{SyMb01-notin}',
+        '\\slash': '\\operatorname{SyMb01-slash}',
+        '\\LaTeX': '\\operatorname{SyMb01-LaTeX}',
+        '\\TeX': '\\operatorname{SyMb01-TeX}',
         ...customTexMacros
     };
     const options = {

package/src/writer.ts

@@ -312,6 +312,22 @@ export class TypstWriter {
 
     public finalize(): string {
         this.flushQueue();
+        const smartFloorPass = function (input: string): string {
+            // Use regex to replace all "⌊ xxx ⌋" with "floor(xxx)"
+            let res = input.replace(/⌊\s*(.*?)\s*⌋/g, "floor($1)");
+            // Typst disallow "floor()" with empty argument, so add am empty string inside if it's empty.
+            res = res.replace(/floor\(\)/g, 'floor("")');
+            return res;
+        };
+        const smartCeilPass = function (input: string): string {
+            // Use regex to replace all "⌈ xxx ⌉" with "ceil(xxx)"
+            let res = input.replace(/⌈\s*(.*?)\s*⌉/g, "ceil($1)");
+            // Typst disallow "ceil()" with empty argument, so add an empty string inside if it's empty.
+            res = res.replace(/ceil\(\)/g, 'ceil("")');
+            return res;
+        }
+        this.buffer = smartFloorPass(this.buffer);
+        this.buffer = smartCeilPass(this.buffer);
         return this.buffer;
     }
 }
@@ -322,6 +338,8 @@ function convertToken(token: string): string {
         return token;
     } else if (token === '\\\\') {
         return '\\\n';
+    } else if (['\\$', '\\#', '\\&', '\\_'].includes(token)) {
+        return token;
     } else if (token.startsWith('\\')) {
         const symbol = token.slice(1);
         if (symbolMap.has(symbol)) {