@pretextbook/markdown-style-pretext 0.0.1 → 0.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/markdown-style-pretext",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Editor intelligence (completions + validation) for Markdown-style PreTeXt documents",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -34,11 +34,11 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@pretextbook/latex-style-pretext": "^0.0.1",
+    "@pretextbook/latex-style-pretext": "^0.1.0",
     "vscode-languageserver-types": "^3.17.5"
   },
   "devDependencies": {
-    "@pretextbook/remark-pretext": "^0.0.11"
+    "@pretextbook/remark-pretext": "^0.0.12"
   },
   "publishConfig": {
     "access": "public"

package/src/completions/get-completions.spec.ts

@@ -76,6 +76,20 @@ describe("leaf directive completions", () => {
     // `proof` is a container directive; it must not appear in leaf context.
     expect(labels(complete("::pro|"))).not.toContain("proof");
   });
+
+  it("offers the full plus include vocabulary shared with \\plus", () => {
+    const names = labels(complete("::|"));
+    expect(names).toContain("appendix");
+    expect(names).toContain("worksheet");
+    expect(names).toContain("latex-image");
+    expect(names).toContain("sageplot");
+  });
+
+  it("sorts divisions ahead of assets", () => {
+    const items = complete("::|");
+    expect(byLabel(items, "chapter")?.sortText?.startsWith("0")).toBe(true);
+    expect(byLabel(items, "image")?.sortText?.startsWith("1")).toBe(true);
+  });
 });
 
 describe("math completions", () => {

package/src/completions/get-completions.ts

@@ -7,6 +7,7 @@ import {
 import type { GetCompletionsParams } from "../types";
 import { scanDocument, contextAt } from "../scan/scan-document";
 import { CONTAINER_DIRECTIVES, LEAF_DIRECTIVES } from "../data/directives";
+import { PLUS_TYPE_KIND } from "@pretextbook/latex-style-pretext";
 import { KATEX_MACROS, EXTRA_MATH_MACROS } from "../data/math";
 import { rangeFromOffsets } from "../util/position";
 import {
@@ -179,6 +180,8 @@ function leafItems(
   const items: CompletionItem[] = [];
   for (const spec of LEAF_DIRECTIVES) {
     if (prefix && !spec.name.startsWith(prefix)) continue;
+    // Divisions sort ahead of assets, matching the LaTeX flavor's `\plus{`.
+    const isDivision = PLUS_TYPE_KIND.get(spec.name) === "division";
     items.push(
       makeItem({
         text,
@@ -188,6 +191,7 @@ function leafItems(
         detail: "include · plus:" + spec.name,
         documentation: spec.documentation,
         insert: leafInsertText(spec),
+        sortText: `${isDivision ? "0" : "1"}${spec.name}`,
       }),
     );
   }

package/src/data/data.spec.ts

@@ -6,6 +6,7 @@ import {
   isKnownContainerDirective,
 } from "./directives";
 import { isKnownMathMacro, isKnownMathEnvironment } from "./math";
+import { PLUS_TYPES } from "@pretextbook/latex-style-pretext";
 
 describe("container directive table", () => {
   it("resolves canonical directive names", () => {
@@ -54,6 +55,26 @@ describe("leaf (include) directives", () => {
     // Leaf names are includes: they are not container directives.
     expect(isKnownContainerDirective("image")).toBe(false);
   });
+
+  it("offers the same include vocabulary as the LaTeX flavor's \\plus", () => {
+    const names = LEAF_DIRECTIVES.map((d) => d.name);
+    expect(names).toEqual(expect.arrayContaining([...PLUS_TYPES]));
+    // Kinds the converter's `defaultPlusTypes` omits stay markdown-only.
+    expect(names).toContain("figure");
+    expect(PLUS_TYPES).not.toContain("figure");
+  });
+
+  it("describes divisions and assets differently", () => {
+    const byName = (name: string) =>
+      LEAF_DIRECTIVES.find((d) => d.name === name);
+    expect(byName("chapter")?.documentation).toContain("division");
+    expect(byName("image")?.documentation).toContain("asset");
+  });
+
+  it("has no duplicate include names", () => {
+    const names = LEAF_DIRECTIVES.map((d) => d.name);
+    expect(new Set(names).size).toBe(names.length);
+  });
 });
 
 describe("shared math support", () => {

package/src/data/directives.ts

@@ -14,6 +14,7 @@
 //   - TEXT directives (`:name[…]`) have no converter handler yet (they become
 //     `<TODO>` placeholders), so this package neither completes nor lints them.
 
+import { PLUS_TYPES, PLUS_TYPE_KIND } from "@pretextbook/latex-style-pretext";
 import type { DirectiveSpec, DirectiveCategory } from "../types";
 
 /** The mirror of `DIRECTIVE_SPEC_TABLE`, minus fields we derive below. */
@@ -132,29 +133,47 @@ export const CONTAINER_DIRECTIVES: DirectiveSpec[] = Object.entries(
   CONTAINER_SEEDS,
 ).map(([name, seed]) => seedToSpec(name, seed));
 
+/**
+ * Include kinds offered by this flavor but absent from the LaTeX converter's
+ * `defaultPlusTypes`. Harmless here (any leaf name converts), but the LaTeX
+ * flavor validates `\plus{type}` against that list, so `::figure{ref="x"}`
+ * completes while `\plus{figure}{x}` warns. Resolve by adding them upstream in
+ * `unified-latex/.../pre-conversion-subs/plus-subs.ts` if PreTeXt Plus really
+ * includes figures and tables by reference.
+ */
+const MARKDOWN_ONLY_TYPES = ["figure", "table"];
+
+function leafDocumentation(name: string): string {
+  switch (PLUS_TYPE_KIND.get(name)) {
+    case "division":
+      return `Include the modular \`${name}\` division stored under \`ref\`.`;
+    case "asset":
+      return `Include the \`${name}\` asset by \`ref\`.`;
+    default:
+      return `Include the \`${name}\` element by \`ref\`.`;
+  }
+}
+
 /**
  * Convenience completion list for leaf directives (`::name{…}`). These are the
  * PreTeXt Plus *include* syntax — a reference expanded by a later assembly step
  * (`::section{ref="ch-intro"}` → `<plus:section ref="ch-intro"/>`). Any name is
  * valid, so this list is offered as suggestions but never used for validation.
+ *
+ * The kinds come from `@pretextbook/latex-style-pretext` so the two flavors
+ * suggest one vocabulary; that package mirrors (and drift-tests against) the
+ * converter's `defaultPlusTypes`.
  */
 export const LEAF_DIRECTIVES: DirectiveSpec[] = [
-  ["part", "Include a modular part."],
-  ["chapter", "Include a modular chapter."],
-  ["section", "Include a modular section."],
-  ["subsection", "Include a modular subsection."],
-  ["subsubsection", "Include a modular subsubsection."],
-  ["image", "Include an image asset by `ref`."],
-  ["listing", "Include a code listing by `ref`."],
-  ["figure", "Include a figure by `ref`."],
-  ["table", "Include a table by `ref`."],
-].map(([name, documentation]) => ({
+  ...PLUS_TYPES,
+  ...MARKDOWN_ONLY_TYPES,
+].map((name) => ({
   name,
   type: name,
   category: "remark-like" as DirectiveCategory,
   kind: "leaf" as const,
   requiresStatement: false,
-  documentation,
+  documentation: leafDocumentation(name),
 }));
 
 /** Lookup from a container directive name to its spec. */