Merge pull request #4368 from James-Yu/4365-integration-of-intellisen…

…se-data-common-to-the-koma-script-document-classes Include base KOMA macro/env in KOMA art, book, rept
James-Yu · Sep 6, 2024 · e0bdfaf · e0bdfaf
2 parents 62601bd + 6533600
commit e0bdfaf
Show file tree

Hide file tree

Showing 10 changed files with 4,704 additions and 826 deletions.
diff --git a/data/packages/class-scrartcl.json b/data/packages/class-scrartcl.json
diff --git a/data/packages/class-scrbook.json b/data/packages/class-scrbook.json
diff --git a/data/packages/class-scrreprt.json b/data/packages/class-scrreprt.json
diff --git a/dev/packages/class-scrartcl,scrreprt,scrbook.json b/dev/packages/class-scrartcl,scrreprt,scrbook.json
diff --git a/dev/packages/class-scrartcl.json b/dev/packages/class-scrartcl.json
diff --git a/dev/packages/class-scrbook.json b/dev/packages/class-scrbook.json
diff --git a/dev/packages/class-scrreprt.json b/dev/packages/class-scrreprt.json
diff --git a/dev/parse-cwl.ts b/dev/parse-cwl.ts
@@ -446,12 +446,24 @@ function findArg(arg: string, regexp: RegExp, index: number): string | false {
  * @returns The parsed package object.
  */
 function parsePkg(pkgName: string): PackageRaw {
-    const content = fs.readFileSync(`cwl/${pkgName}.cwl`).toString()
+    let content = fs.readFileSync(`cwl/${pkgName}.cwl`).toString()
+    content = handleKomaClasses(pkgName, content)
     const pkg: PackageRaw = { deps: [], macros: [], envs: [], keys: {}, args: [] }
     parseLines(pkg, content.split('\n'))
     return pkg
 }
 
+function handleKomaClasses(pkgName: string, content: string): string {
+    if (!['class-scrartcl', 'class-scrbook', 'class-scrreprt', 'class-scrartcl,scrreprt,scrbook'].includes(pkgName)) {
+        return content
+    }
+    if (pkgName === 'class-scrartcl,scrreprt,scrbook') {
+        return ''
+    }
+    const baseContent = fs.readFileSync('cwl/class-scrartcl,scrreprt,scrbook.cwl').toString()
+    return baseContent + '\n' + content
+}
+
 /**
  * Parses an array of file paths and converts CWL files to JSON format.
  *

diff --git a/test/fixtures/armory/intellisense/koma.tex b/test/fixtures/armory/intellisense/koma.tex
@@ -0,0 +1,3 @@
+\documentclass{scrartcl}
+\begin{document}
+\end{document}
diff --git a/test/suites/04_intellisense.test.ts b/test/suites/04_intellisense.test.ts
@@ -441,4 +441,15 @@ suite('Intellisense test suite', () => {
         assert.ok(undefined === suggestions.items.find(item => item.label === '#+' && item.insertText instanceof vscode.SnippetString && item.insertText.value === '\\bigcup'))
         assert.ok(undefined === suggestions.items.find(item => item.label === '#8'))
     })
+
+    test.run('suggest base KOMAScript macros/envs in KOMAScript class', async (fixture: string) => {
+        await test.load(fixture, [
+            {src: 'intellisense/koma.tex', dst: 'main.tex'}
+        ])
+        const suggestions = test.suggest(0, 1)
+        // in class-scrartcl.cwl
+        assert.ok(suggestions.labels.includes('\\addpart{}'))
+        // in base
+        assert.ok(suggestions.labels.includes('\\addchap{}'))
+    })
 })