Make texvcjs compatible to texvc

.eslintignore

@@ -0,0 +1,2 @@
+lib/parser.js
+test

.eslintrc.yml

@@ -0,0 +1,32 @@
+extends:
+  - wikimedia/server
+
+rules:
+  array-bracket-spacing:
+    - off
+  camelcase:
+    - error
+    - properties: never
+  computed-property-spacing:
+    - error
+    - never
+  indent:
+    - error
+    - 4
+    - SwitchCase: 1
+      MemberExpression: off
+  no-multi-spaces:
+    - off
+  # defined in eslint-config-wikimedia to avoid breaking IE. Not needed here
+  no-restricted-syntax:
+    - off
+  no-underscore-dangle:
+    - off
+  no-unused-vars:
+    - error
+    - args: none
+  space-in-parens:
+    - error
+    - never
+  es-x/no-hashbang:
+    - off

.gitignore

@@ -1 +1,57 @@
 node_modules
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+# nyc
+.nyc_output
+coverage
+/doc/main.aux
+/doc/main.fdb_latexmk
+/doc/main.fls
+/doc/main.log

.gitreview

@@ -0,0 +1,3 @@
+[gerrit]
+host=gerrit.wikimedia.org
+project=mediawiki/services/texvcjs

CHANGELOG.md

@@ -1,4 +1,15 @@
-# texvcjs x.x.x (not yet released)
+# texvcjs 0.6.0 (2025-11-06)
+
+* Update low-level grammar to Peggy version 5
+* test with node version 22
+
+# texvcjs 0.5.0 (2022-08-23)
+
+* Remove low-level API export as the internal structure has been refactored significantly.
+
+# texvcjs 0.4.0 (2022-07-14)
+
+* RenderT is removed from the AST
 
 # texvcjs 0.3.1 (2014-07-29)
 

README.md

@@ -1,21 +1,25 @@
 # texvcjs
-[![NPM][NPM1]][NPM2]
 
-[![Build Status][1]][2] [![dependency status][3]][4] [![dev dependency status][5]][6]
+[![NPM][NPM1]][NPM2]
 
-A TeX/LaTeX validator.
+A TeX/LaTeX validator. 
 
 `texvcjs` takes user input and validates it while replacing
 MediaWiki-specific functions.  It is a JavaScript port of [texvc],
 which was originally written in [OCaml] for the [Math extension].
 
 The `texvcjs` library was originally written to be used by the
-[mw-ocg-latexer] PDF-generation backend of the mediawiki
+[mw-ocg-latexer] PDF-generation backend of the MediaWiki
 [Collection extension].
 
+`texvcjs` also makes it possible to print the identified texvc tokens.
+Moreover, it provides additional information on the input, such as
+* listing the identifiers;
+* discovering if the expression ends with a dot.
+
 ## Installation
 
-Node version 0.8 and 0.10 are tested to work.
+Node version 22 is tested to work.
 
 Install the node package dependencies with:
 ```
@@ -37,6 +41,12 @@ which should emit:
 +\sin(x)+{}{}\cos(x)^{2}newcommand
 ```
 
+To test the info functionalities, run texvcjs with the info flag:
+```
+./bin/texvcjs --info -o json \\frac12 > ./vis/data.json
+```
+
+
 ## API
 
 Your programs can also use the JavaScript API exported by the
@@ -59,7 +69,7 @@ The `status` field is a single character:
 * `-`: Some other problem occurred.
 
 For status types `F`, `S`, and `-`, the position of the error may be found
-in the `line`, `column` and `offset` fields of the result.  More information
+in the `line`, `column`, and `offset` fields of the result.  More information
 about the problem can be found in the `details` field of the result, which
 is a string.
 
@@ -69,33 +79,49 @@ string requires the use of the corresponding [LaTeX packages].
 The `ams_required` field requires the use of the `amsmath` and `amssymb`
 packages.
 
-### Low-level API
-
-The low level parser, abstract syntax tree (AST), and renderer are also
-exported from the module.  This allows you to define more interesting
-queries on the input source.  An example can be found in `lib/astutil.js`
-which defines a visitor function to test for the presence of specific
-TeX functions in the input.
+## mhchem
+
+To use the `\ce` tags from the mhchem package, the parser needs to be called
+with the mhchem option. During the parsing, if a `\ce` tag is encountered,
+its contents are treated according to the [mhchem grammar]. The parsing in
+general and the building up of the AST is done in a similar fashion to the
+math mode, but preserves the whitespaces when needed.
+
+As the design of the parser does not allow the usage of the dollar sign in
+the math mode, the tags `\begin{math}` and `\end{math}` were introduced to 
+provide the ability to switch to math mode within a chemical formula. The
+undocumented `\color` tag of mhchem is only supported for named colors. 
+The full documentation of the mhchem package can be found on the 
+[mhchem website].
+
+### Examples:
+This example would be typeset wrongly without the extended parser, as some
+charges would be typeset as bonds, and some addition signs would end up as 
+charges. Running:
+```sh
+bin/texvcjs  --usemhchem '\ce{2Na + 2H2O -> 2Na+ + 2OH- + H-H}'
+```
+emits:
+```
++{\ce {2Na + 2H2O -> 2Na+ + 2OH- + H-H}}
+```
+More examples can be found on the [mhchem website].
 
 ## License
 
-Copyright (c) 2014 C. Scott Ananian
+Copyright (c) 2014-2022 C. Scott Ananian, Moritz Schubotz, Johannes Stegmüller
 
 Licensed under GPLv2.
 
 [mw-ocg-latexer]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-latex_renderer
-[texvc]: https://git.wikimedia.org/blob/mediawiki%2Fextensions%2FMath/REL1_23/texvccheck%2FREADME
+[texvc]: https://phabricator.wikimedia.org/diffusion/EMAT/browse/REL1_23/texvccheck/README
 [Math extension]: https://www.mediawiki.org/wiki/Extension:Math
 [Collection extension]: https://www.mediawiki.org/wiki/Extension:Collection
 [OCaml]: https://ocaml.org/
 [LaTeX packages]: http://www.ctan.org/
 
-[NPM1]: https://nodei.co/npm/texvcjs.svg
-[NPM2]: https://nodei.co/npm/texvcjs/
+[mhchem grammar]: https://raw.githubusercontent.com/mhchem/MathJax-mhchem-validity-syntax/master/mhchem-strict-simplified.grm
+[mhchem website]: https://mhchem.github.io/MathJax-mhchem/
 
-[1]: https://travis-ci.org/cscott/texvcjs.svg
-[2]: https://travis-ci.org/cscott/texvcjs
-[3]: https://david-dm.org/cscott/texvcjs.svg
-[4]: https://david-dm.org/cscott/texvcjs
-[5]: https://david-dm.org/cscott/texvcjs/dev-status.svg
-[6]: https://david-dm.org/cscott/texvcjs#info=devDependencies
+[NPM1]: https://nodei.co/npm/mathoid-texvcjs.png
+[NPM2]: https://nodei.co/npm/mathoid-texvcjs/

TODO.md

@@ -4,4 +4,4 @@
   functions they are valid after.
 * Verify UTF-8 handling
   - does CLI handle utf-8 correctly?
-* Add test cases from [[mw:MathTest]]
+* Add test cases from [[mw:MathTest]]

bin/batch-evaluate

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+'use strict';
+
+const program = require('commander');
+
+const json = require('../package.json');
+
+program
+    .version(json.version)
+    .usage('[options] <input> <output>')
+    .description('Gets a json file with inputs in the form' +
+        ' key=>input and writes out a json file in the form' +
+        ' key=>output')
+;
+program.parse();
+
+const texvcjs = require('../');
+
+const formulae = require(program.args[0]);
+Object.keys(formulae).forEach((k) => {
+    formulae[k] = texvcjs.check(formulae[k]).output;
+})
+const fs = require('fs');
+fs.writeFileSync(
+    program.args[1],
+    JSON.stringify(formulae, null, 2));
+
+process.exit(0);
+
+