@pretextbook/markdown-style-pretext 0.1.5 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @pretextbook/markdown-style-pretext
 
-Editor intelligence for **Markdown-style PreTeXt** — CommonMark + GFM plus
+Editor intelligence for **Markdown-style PreTeXt** — CommonMark + GFM tables plus
 [remark-directive](https://github.com/remarkjs/remark-directive) extensions that convert to
 PreTeXt via [`@pretextbook/remark-pretext`](../remark-pretext).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/markdown-style-pretext",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Editor intelligence (completions + validation) for Markdown-style PreTeXt documents",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "vscode-languageserver-types": "^3.17.5"
   },
   "devDependencies": {
-    "@pretextbook/remark-pretext": "^0.3.0"
+    "@pretextbook/remark-pretext": "^0.4.0"
   },
   "publishConfig": {
     "access": "public"

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

@@ -23,6 +23,13 @@ describe("container directive completions", () => {
     expect(item?.textEdit?.newText).toBe("theorem\n\t$0\n:::");
   });
 
+  it("gives :::table a title placeholder and a pipe-table body", () => {
+    const item = byLabel(complete(":::tab|"), "table");
+    expect(item?.textEdit?.newText).toBe(
+      "table[${1:Title}]\n| ${2:Header} | ${3:Header} |\n| --- | --- |\n| $4 | $0 |\n:::",
+    );
+  });
+
   it("seeds a nested :::task for task-bearing directives", () => {
     const item = byLabel(complete(":::exerc|"), "exercise");
     expect(item?.textEdit?.newText).toContain(":::task");

package/src/completions/snippets.ts

@@ -11,11 +11,17 @@ import type { DirectiveSpec } from "../types";
  * nested tasks seed a first `:::task` child so the structure is discoverable.
  */
 export function containerInsertText(spec: DirectiveSpec): string {
-  if (spec.snippet) return `${spec.name}\n${spec.snippet}\n:::`;
+  const head = nameLine(spec);
+  if (spec.snippet) return `${head}\n${spec.snippet}\n:::`;
   if (spec.hasNestedTasks) {
-    return `${spec.name}\n:::task\n\t$0\n:::\n:::`;
+    return `${head}\n:::task\n\t$0\n:::\n:::`;
   }
-  return `${spec.name}\n\t$0\n:::`;
+  return `${head}\n\t$0\n:::`;
+}
+
+/** The directive name, plus a title placeholder when it needs one. */
+function nameLine(spec: DirectiveSpec): string {
+  return spec.titled ? `${spec.name}[\${1:Title}]` : spec.name;
 }
 
 /** The bare closing fence, offered when a container directive is open. */
@@ -31,10 +37,15 @@ export function closeInsertText(): string {
  * Task-bearing directives seed a nested `task:` child.
  */
 export function pythonInsertText(spec: DirectiveSpec): string {
+  const head = `${nameLine(spec)}:`;
+  if (spec.snippet) {
+    const body = spec.snippet.split("\n").map((line) => `\t${line}`);
+    return [head, ...body].join("\n");
+  }
   if (spec.hasNestedTasks) {
-    return `${spec.name}:\n\ttask:\n\t\t$0`;
+    return `${head}\n\ttask:\n\t\t$0`;
   }
-  return `${spec.name}:\n\t$0`;
+  return `${head}\n\t$0`;
 }
 
 /**

package/src/data/directives.ts

@@ -23,6 +23,8 @@ type ContainerSeed = {
   requiresStatement: boolean;
   hasNestedTasks?: boolean;
   documentation?: string;
+  snippet?: string;
+  titled?: boolean;
 };
 
 const CONTAINER_SEEDS: Record<string, ContainerSeed> = {
@@ -82,6 +84,17 @@ const CONTAINER_SEEDS: Record<string, ContainerSeed> = {
   solution: { category: "solution-like", requiresStatement: false },
   hint: { category: "solution-like", requiresStatement: false },
   answer: { category: "solution-like", requiresStatement: false },
+
+  // figure-like (a titled wrapper around one piece of content)
+  table: {
+    category: "figure-like",
+    requiresStatement: false,
+    titled: true,
+    snippet: "| ${2:Header} | ${3:Header} |\n| --- | --- |\n| $4 | $0 |",
+    documentation:
+      "A numbered, titled `<table>` around a pipe table (`<tabular>`). " +
+      "A pipe table on its own, outside `:::table`, is a bare `<tabular>`.",
+  },
 };
 
 /**
@@ -125,6 +138,8 @@ function seedToSpec(name: string, seed: ContainerSeed): DirectiveSpec {
     hasNestedTasks: seed.hasNestedTasks,
     childDirectives: children.length > 0 ? children : undefined,
     documentation: seed.documentation,
+    snippet: seed.snippet,
+    titled: seed.titled,
   };
 }
 

package/src/lint/get-diagnostics.spec.ts

@@ -23,6 +23,15 @@ describe("directive fence matching", () => {
     expect(diags[0].message).toContain("no matching open");
   });
 
+  it("accepts pipe tables, bare and in a :::table", () => {
+    expect(
+      getMarkdownDiagnostics(
+        "| A | $|x|$ |\n| - | - |\n| 1 | 2 |\n\n" +
+          ":::table[Results]{#tbl-res}\n| A |\n| - |\n| 1 |\n:::\n",
+      ),
+    ).toEqual([]);
+  });
+
   it("accepts nested containers written with flexible equal colons", () => {
     expect(
       getMarkdownDiagnostics(":::exercise\n:::task\nx\n:::\n:::\n"),

package/src/types.ts

@@ -34,7 +34,8 @@ export type DirectiveCategory =
   | "example-like"
   | "project-like"
   | "exercise-like"
-  | "solution-like";
+  | "solution-like"
+  | "figure-like";
 
 /**
  * Curated specification for a container directive. The direct analogue of the
@@ -68,8 +69,14 @@ export interface DirectiveSpec {
   /**
    * Override the auto-generated snippet body (LSP snippet syntax). The
    * generator always supplies the `name` line and the closing `:::` fence, so
-   * this is the inner body only.
+   * this is the inner body only. Number its tab stops from `$2` when the
+   * spec is `titled`, since the title placeholder takes `$1`.
    */
   snippet?: string;
+  /**
+   * The PreTeXt element needs a `<title>` (e.g. `table`), so the generated
+   * name line carries a `[Title]` placeholder.
+   */
+  titled?: boolean;
   documentation?: string;
 }