Overleaf/services/web/test/frontend/features/source-editor/languages/latex/latex-linter.test.ts

import { assert } from 'chai'
import LintWorker from '../../../../../../frontend/js/features/source-editor/languages/latex/linter/latex-linter.worker.js'
import { errorsToDiagnostics } from '../../../../../../frontend/js/features/source-editor/languages/latex/linter/errors-to-diagnostics'
import { Diagnostic } from '@codemirror/lint'
import { mergeCompatibleOverlappingDiagnostics } from '../../../../../../frontend/js/features/source-editor/languages/latex/linter/merge-overlapping-diagnostics'

const { Parse } = new LintWorker()

describe('LatexLinter', function () {
  it('should accept a simple environment match without errors', function () {
    const { errors } = Parse('\\begin{foo}\n' + '\\end{foo}\n')
    assert.equal(errors.length, 0)
  })

  it('should accept an invalid \\it* command', function () {
    const { errors } = Parse('\\it*hello\n' + '\\bye\n')
    assert.equal(errors.length, 0)
  })

  it('should accept newcomlumntype', function () {
    const { errors } = Parse(
      'hello\n' +
        '\\newcolumntype{M}[1]{>{\\begin{varwidth}[t]{#1}}l<{\\end{varwidth}}}\n' +
        'bye'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept newenvironment', function () {
    const { errors } = Parse(
      '\\newenvironment{Algorithm}[2][tbh]%\n' +
        '{\\begin{myalgo}[#1]\n' +
        '\\centering\n' +
        '\\part{title}\\begin{minipage}{#2}\n' +
        '\\begin{algorithm}[H]}%\n' +
        '{\\end{algorithm}\n' +
        '\\end{minipage}\n' +
        '\\end{myalgo}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept newenvironment II', function () {
    const { errors } = Parse(
      '\\newenvironment{claimproof}[1][\\myproofname]{\\begin{proof}[#1]\\renewcommand*{\\qedsymbol}{\\(\\diamondsuit\\)}}{\\end{proof}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept superscript inside math mode', function () {
    const { errors } = Parse('this is $a^b$ test')
    assert.equal(errors.length, 0)
  })

  it('should accept subscript inside math mode', function () {
    const { errors } = Parse('this is $a_b$ test')
    assert.equal(errors.length, 0)
  })

  it('should return an error for superscript outside math mode', function () {
    const { errors } = Parse('this is a^b test')
    assert.equal(errors.length, 1)
    assert.equal(errors[0].text, '^ must be inside math mode')
    assert.equal(errors[0].type, 'error')
  })

  it('should return an error subscript outside math mode', function () {
    const { errors } = Parse('this is a_b test')
    assert.equal(errors.length, 1)
    assert.equal(errors[0].text, '_ must be inside math mode')
    assert.equal(errors[0].type, 'error')
  })

  it('should accept math mode inside \\hbox outside math mode', function () {
    const { errors } = Parse('this is \\hbox{for every $bar$}')
    assert.equal(errors.length, 0)
  })

  it('should accept math mode inside \\hbox inside math mode', function () {
    const { errors } = Parse('this is $foo = \\hbox{for every $bar$}$ test')
    assert.equal(errors.length, 0)
  })

  it('should accept math mode inside \\text inside math mode', function () {
    const { errors } = Parse('this is $foo = \\text{for every $bar$}$ test')
    assert.equal(errors.length, 0)
  })

  it('should accept verbatim', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{verbatim}\n' +
        'this is verbatim\n' +
        '\\end{verbatim}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept verbatim with environment inside', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{verbatim}\n' +
        'this is verbatim\n' +
        '\\begin{foo}\n' +
        'this is verbatim too\n' +
        '\\end{foo}\n' +
        '\\end{verbatim}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept verbatim with \\begin{verbatim} inside', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{verbatim}\n' +
        'this is verbatim\n' +
        '\\begin{verbatim}\n' +
        'this is verbatim too\n' +
        '\\end{verbatim}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept equation', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{equation}\n' +
        '\\alpha^2 + b^2 = c^2\n' +
        '\\end{equation}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept $$', function () {
    const { errors } = Parse(
      'this is text\n' +
        '$$\n' +
        '\\alpha^2 + b^2 = c^2\n' +
        '$$\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept $', function () {
    const { errors } = Parse(
      'this is text $\\alpha^2 + b^2 = c^2$' + ' this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\[', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\[\n' +
        '\\alpha^2 + b^2 = c^2\n' +
        '\\]\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\(', function () {
    const { errors } = Parse(
      'this is text \\(\\alpha^2 + b^2 = c^2\\)' + ' this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\begin{foo}', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{foo}\n' +
        'this is foo\n' +
        '\\end{foo}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\begin{foo_bar}', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{foo_bar}\n' +
        'this is foo bar\n' +
        '\\end{foo_bar}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\begin{foo} \\begin{bar}', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{foo}\n' +
        '\\begin{bar}\n' +
        '\\begin{baz}\n' +
        'this is foo bar baz\n' +
        '\\end{baz}\n' +
        '\\end{bar}\n' +
        '\\end{foo}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\verb|...|', function () {
    const { errors } = Parse('this is text \\verb|hello| and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept \\verb|...| with special chars', function () {
    const { errors } = Parse('this is text \\verb|{}()^_@$xhello| and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept \\url|...|', function () {
    const { errors } = Parse(
      'this is text \\url|http://www.sharelatex.com/| and more\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\url{...}', function () {
    const { errors } = Parse(
      'this is text \\url{http://www.sharelatex.com/} and more\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\url{...} with % chars', function () {
    const { errors } = Parse(
      'this is text \\url{http://www.sharelatex.com/hello%20world} and more\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept \\left( and \\right)', function () {
    const { errors } = Parse('math $\\left( x + y \\right) = y + x$ and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept \\left( and \\right.', function () {
    const { errors } = Parse('math $\\left( x + y \\right. = y + x$ and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept \\left. and \\right)', function () {
    const { errors } = Parse('math $\\left. x + y \\right) = y + x$ and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept complex math nesting', function () {
    const { errors } = Parse(
      'math $\\left( {x + {y + z} + x} \\right\\} = \\left[y + x\\right.$ and more\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept math toggling $a$$b$', function () {
    const { errors } = Parse('math $a$$b$ and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math toggling $$display$$$inline$', function () {
    const { errors } = Parse('math $$display$$$inline$ and more\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math definition commands', function () {
    const { errors } = Parse(
      '\\let\\originalleft\\left\n' +
        '\\let\\originalright\\right\n' +
        '\\renewcommand{\\left}{\\mathopen{}\\mathclose\\bgroup\\originalleft}\n' +
        '\\renewcommand{\\right}{\\aftergroup\\egroup\\originalright}\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept math reflectbox commands', function () {
    const { errors } = Parse('$\\reflectbox{$alpha$}$\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math scalebox commands', function () {
    const { errors } = Parse('$\\scalebox{2}{$alpha$}$\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math rotatebox commands', function () {
    const { errors } = Parse('$\\rotatebox{60}{$alpha$}$\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math resizebox commands', function () {
    const { errors } = Parse('$\\resizebox{2}{3}{$alpha$}$\n')
    assert.equal(errors.length, 0)
  })

  it('should accept all math box commands', function () {
    const { errors } = Parse(
      '\\[ \\left(\n' +
        '\\shiftright{2ex}{\\raisebox{-2ex}{\\scalebox{2}{$\\ast$}}}\n' +
        '\\reflectbox{$ddots$}\n' +
        '\\right). \\]\n'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept math tag commands', function () {
    const { errors } = Parse('$\\tag{$alpha$}$\n')
    assert.equal(errors.length, 0)
  })

  it('should accept math \\def commands', function () {
    const { errors } = Parse(
      '\\def\\peb[#1]{{\\left\\lfloor #1\\right\\rfloor}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept math \\def commands II', function () {
    const { errors } = Parse('\\def\\foo#1{\\gamma^#1}')
    assert.equal(errors.length, 0)
  })

  it('should accept DeclareMathOperator', function () {
    const { errors } = Parse('\\DeclareMathOperator{\\var}{\\Delta^2\\!}')
    assert.equal(errors.length, 0)
  })

  it('should accept DeclarePairedDelimiter', function () {
    const { errors } = Parse(
      '\\DeclarePairedDelimiter{\\spro}{\\left(}{\\right)^{\\ast}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept nested user-defined math commands', function () {
    const { errors } = Parse(
      '$\\foo{$\\alpha \\bar{x^y}{\\cite{hello}}$}{\\gamma}{$\\beta\\baz{\\alpha}$}{\\cite{foo}}$'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept nested user-defined math commands II', function () {
    const { errors } = Parse(
      '\\foo{$\\alpha \\bar{x^y}{\\cite{hello}}$}{\\gamma}{$\\beta\\baz{\\alpha}$}{\\cite{foo}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept newenvironment with multiple parameters', function () {
    const { errors } = Parse(
      '\\newenvironment{case}[1][\\textsc{Case}]\n' +
        '{\\begin{trivlist}\\item[\\hskip \\labelsep {\\textsc{#1}}]}{\\end{trivlist}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept newenvironment with no parameters', function () {
    const { errors } = Parse(
      '\\newenvironment{case}{\\begin{trivlist}\\item[\\hskip \\labelsep {\\textsc{#1}}]}{\\end{trivlist}}'
    )
    assert.equal(errors.length, 0)
  })

  it('should accept tikzfeynman', function () {
    const { errors } = Parse(
      '\\begin{equation*}\n' +
        '\\feynmandiagram[layered layout, medium, horizontal=a to b] {\n' +
        ' a [particle=\\(H\\)] -- [scalar] b [dot] -- [photon] f1 [particle=\\(W^{\\pm}\\)],\n' +
        ' b -- [boson, edge label=\\(W^{\\mp}\\)] c [dot],\n' +
        ' c -- [fermion] f2 [particle=\\(f\\)],\n' +
        " c -- [anti fermion] f3 [particle=\\(\\bar{f}'\\)],\n" +
        ' };this is a change\n' +
        '\\end{equation*}'
    )
    assert.equal(errors.length, 0)
  })

  it('should return errors from malformed \\end', function () {
    const { errors } = Parse(
      'this is text\n' +
        '\\begin{foo}\n' +
        '\\begin{bar}\n' +
        'this is foo bar baz\n' +
        '\\end{bar\n' +
        '\\end{foo}\n' +
        'this is more text\n'
    )
    assert.equal(errors.length, 4)
    assert.equal(errors[0].text, 'unclosed \\begin{bar} found at \\end{foo}')
    assert.equal(errors[1].text, 'invalid environment command \\end{bar')
    assert.equal(errors[2].text, 'unclosed open group { found at \\end{foo}')
    assert.equal(errors[3].text, 'unexpected \\end{foo} after \\begin{bar}')
  })

  it('should accept \\newcommand*', function () {
    const { errors } = Parse('\\newcommand*{\\foo}{\\bar}')
    assert.equal(errors.length, 0)
  })

  it('should accept incomplete \\newcommand*', function () {
    const { errors } = Parse('\\newcommand*{\\beq' + '}')
    assert.equal(errors.length, 0)
  })

  // %novalidate
  // %begin novalidate
  // %end novalidate
  // \begin{foo}
  // \begin{new_theorem}
  // \begin{foo   invalid environment command
  // \newcommand{\foo}{\bar}
  // \newcommand[1]{\foo}{\bar #1}
  // \renewcommand...
  // \def
  // \DeclareRobustCommand
  // \newcolumntype
  // \newenvironment
  // \renewenvironment
  // \verb|....|
  // \url|...|
  // \url{...}
  // \left(   \right)
  // \left.   \right.
  // $...$
  // $$....$$
  // $...$$...$
  // $a^b$ vs a^b
  // $$a^b$$ vs a^b
  // Matrix for envs for {} left/right \[ \] \( \) $ $$ begin end
  // begin equation
  // align(*)
  // equation(*)
  // ]
  // array(*)
  // eqnarray(*)
  // split
  // aligned
  // cases
  // pmatrix
  // gathered
  // matrix
  // alignedat
  // smallmatrix
  // subarray
  // vmatrix
  // shortintertext

  it('should return math mode contexts', function () {
    const { contexts } = Parse(
      '\\begin{document}\n' +
        '$$\n' +
        '\\begin{array}\n' +
        '\\left( \\foo{bar} \\right] & 2\n' +
        '\\end{array}\n' +
        '$$\n' +
        '\\end{document}'
    )
    assert.equal(contexts.length, 1)
    assert.equal(contexts[0].type, 'math')
    assert.equal(contexts[0].range.start.row, 1)
    assert.equal(contexts[0].range.start.column, 0)
    assert.equal(contexts[0].range.end.row, 5)
    assert.equal(contexts[0].range.end.column, 2)
  })

  it('should remove error when cursor is inside incomplete command', function () {
    const { errors } = Parse('\\begin{}')
    const diagnostics = errorsToDiagnostics(errors, 7, 9)
    assert.equal(errors.length, 1)
    assert.equal(diagnostics.length, 0)
  })

  it('should show an error when cursor is outside incomplete command', function () {
    const { errors } = Parse('\\begin{}')
    const diagnostics = errorsToDiagnostics(errors, 6, 9)
    assert.equal(errors.length, 1)
    assert.equal(diagnostics.length, 1)
    assert.equal(diagnostics[0].from, 0)
    assert.equal(diagnostics[0].to, 6)
  })

  it('should adjust an error range when the cursor is inside that range', function () {
    const { errors } = Parse('\\begin{}')
    const diagnostics = errorsToDiagnostics(errors, 4, 7)
    assert.equal(errors.length, 1)
    assert.equal(errors[0].startPos, 0)
    assert.equal(errors[0].endPos, 7)
    assert.equal(diagnostics.length, 1)
    assert.equal(diagnostics[0].from, 0)
    assert.equal(diagnostics[0].to, 4)
  })

  it('should reject an error when part of the error range is outside of the document boundaries', function () {
    const { errors } = Parse('\\begin{}')
    const diagnostics = errorsToDiagnostics(errors, 8, 6)
    assert.equal(errors.length, 1)
    assert.equal(diagnostics.length, 0)
  })

  it('should merge two overlapping identical diagnostics', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 1,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(mergedDiagnostics, [
      {
        from: 0,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
    ])
  })

  it('should merge two touching identical diagnostics', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 2,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(mergedDiagnostics, [
      {
        from: 0,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
    ])
  })

  it('should not merge two overlapping diagnostics with different messages', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 1,
        to: 3,
        message: 'Message 2',
        severity: 'error',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(diagnostics, mergedDiagnostics)
  })

  it('should not merge two overlapping diagnostics with different severities', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 1,
        to: 3,
        message: 'Message 1',
        severity: 'warning',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(diagnostics, mergedDiagnostics)
  })

  it('should merge three overlapping identical diagnostics', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 1,
        to: 4,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 3,
        to: 5,
        message: 'Message 1',
        severity: 'error',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(mergedDiagnostics, [
      {
        from: 0,
        to: 5,
        message: 'Message 1',
        severity: 'error',
      },
    ])
  })

  it('should merge two separate sets of overlapping identical diagnostics', function () {
    const diagnostics: Diagnostic[] = [
      {
        from: 0,
        to: 2,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 2,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 2,
        to: 5,
        message: 'Message 2',
        severity: 'error',
      },
      {
        from: 4,
        to: 6,
        message: 'Message 3',
        severity: 'error',
      },
      {
        from: 5,
        to: 7,
        message: 'Message 3',
        severity: 'error',
      },
    ]
    const mergedDiagnostics = mergeCompatibleOverlappingDiagnostics(diagnostics)
    assert.deepEqual(mergedDiagnostics, [
      {
        from: 0,
        to: 3,
        message: 'Message 1',
        severity: 'error',
      },
      {
        from: 2,
        to: 5,
        message: 'Message 2',
        severity: 'error',
      },
      {
        from: 4,
        to: 7,
        message: 'Message 3',
        severity: 'error',
      },
    ])
  })
})