refactor(content): maps

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
flex-development · Feb 10, 2024 · 4fdb553 · 4fdb553
1 parent 144bd25
commit 4fdb553
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 18 deletions.
diff --git a/src/content/__tests__/block-tag.spec-d.ts b/src/content/__tests__/block-tag.spec-d.ts
@@ -4,6 +4,7 @@
  */
 
 import type { TypeExpression } from '#src/nodes'
+import type mdast from 'mdast'
 import type * as TestSubject from '../block-tag'
 import type { PhrasingContentMap } from '../phrasing'
 
@@ -14,6 +15,12 @@ describe('unit-d:content/BlockTag', () => {
         .toMatchTypeOf<PhrasingContentMap>()
     })
 
+    it('should match [code: mdast.Code]', () => {
+      expectTypeOf<TestSubject.BlockTagContentMap>()
+        .toHaveProperty('code')
+        .toEqualTypeOf<mdast.Code>
+    })
+
     it('should match [typeExpression: TypeExpression]', () => {
       expectTypeOf<TestSubject.BlockTagContentMap>()
         .toHaveProperty('typeExpression')

diff --git a/src/content/__tests__/description.spec-d.ts b/src/content/__tests__/description.spec-d.ts
@@ -20,6 +20,12 @@ describe('unit-d:content/Description', () => {
         .toEqualTypeOf<mdast.Blockquote>
     })
 
+    it('should match [code: mdast.Code]', () => {
+      expectTypeOf<TestSubject.DescriptionContentMap>()
+        .toHaveProperty('code')
+        .toEqualTypeOf<mdast.Code>
+    })
+
     it('should match [definition: mdast.Definition]', () => {
       expectTypeOf<TestSubject.DescriptionContentMap>()
         .toHaveProperty('definition')
@@ -44,18 +50,24 @@ describe('unit-d:content/Description', () => {
         .toEqualTypeOf<mdast.ListItem>
     })
 
-    it('should match [paragraph: mdast.Paragraph]', () => {
-      expectTypeOf<TestSubject.DescriptionContentMap>()
-        .toHaveProperty('paragraph')
-        .toEqualTypeOf<mdast.Paragraph>
-    })
-
     it('should match [table: mdast.Table]', () => {
       expectTypeOf<TestSubject.DescriptionContentMap>()
         .toHaveProperty('table')
         .toEqualTypeOf<mdast.Table>
     })
 
+    it('should match [tableCell: mdast.TableCell]', () => {
+      expectTypeOf<TestSubject.DescriptionContentMap>()
+        .toHaveProperty('tableCell')
+        .toEqualTypeOf<mdast.TableCell>
+    })
+
+    it('should match [tableRow: mdast.TableRow]', () => {
+      expectTypeOf<TestSubject.DescriptionContentMap>()
+        .toHaveProperty('tableRow')
+        .toEqualTypeOf<mdast.TableRow>
+    })
+
     it('should match [thematicBreak: mdast.ThematicBreak]', () => {
       expectTypeOf<TestSubject.DescriptionContentMap>()
         .toHaveProperty('thematicBreak')

diff --git a/src/content/__tests__/phrasing.spec-d.ts b/src/content/__tests__/phrasing.spec-d.ts
@@ -9,17 +9,11 @@ import type * as TestSubject from '../phrasing'
 
 describe('unit-d:content/Phrasing', () => {
   describe('PhrasingContentMap', () => {
-    it('should extend <mdast.PhrasingContentMap', () => {
+    it('should extend mdast.PhrasingContentMap', () => {
       expectTypeOf<TestSubject.PhrasingContentMap>()
         .toMatchTypeOf<mdast.PhrasingContentMap>()
     })
 
-    it('should match [code: mdast.Code]', () => {
-      expectTypeOf<TestSubject.PhrasingContentMap>()
-        .toHaveProperty('code')
-        .toEqualTypeOf<mdast.Code>
-    })
-
     it('should match [inlineTag: InlineTag]', () => {
       expectTypeOf<TestSubject.PhrasingContentMap>()
         .toHaveProperty('inlineTag')

diff --git a/src/content/block-tag.ts b/src/content/block-tag.ts
@@ -4,6 +4,7 @@
  */
 
 import type { TypeExpression } from '#src/nodes'
+import type mdast from 'mdast'
 import type { PhrasingContentMap } from './phrasing'
 
 /**
@@ -31,6 +32,7 @@ type BlockTagContent = BlockTagContentMap[keyof BlockTagContentMap]
  * @extends {PhrasingContentMap}
  */
 interface BlockTagContentMap extends PhrasingContentMap {
+  code: mdast.Code
   typeExpression: TypeExpression
 }
 

diff --git a/src/content/description.ts b/src/content/description.ts
@@ -3,9 +3,24 @@
  * @module docast/content/Description
  */
 
+import type { InlineTag } from '#src/nodes'
 import type mdast from 'mdast'
 import type { PhrasingContentMap } from './phrasing'
 
+declare module 'mdast' {
+  interface BlockContentMap {
+    inlineTag: InlineTag
+  }
+
+  interface DefinitionContentMap {
+    inlineTag: InlineTag
+  }
+
+  interface RootContentMap {
+    inlineTag: InlineTag
+  }
+}
+
 /**
  * Union of registered docast nodes that can occur where description content is
  * expected.
@@ -32,12 +47,14 @@ type DescriptionContent = DescriptionContentMap[keyof DescriptionContentMap]
  */
 interface DescriptionContentMap extends PhrasingContentMap {
   blockquote: mdast.Blockquote
+  code: mdast.Code
   definition: mdast.Definition
   footnoteDefinition: mdast.FootnoteDefinition
   list: mdast.List
   listItem: mdast.ListItem
-  paragraph: mdast.Paragraph
   table: mdast.Table
+  tableCell: mdast.TableCell
+  tableRow: mdast.TableRow
   thematicBreak: mdast.ThematicBreak
 }
 

diff --git a/src/content/phrasing.ts b/src/content/phrasing.ts
@@ -6,6 +6,12 @@
 import type { InlineTag } from '#src/nodes'
 import type mdast from 'mdast'
 
+declare module 'mdast' {
+  interface PhrasingContentMap {
+    inlineTag: InlineTag
+  }
+}
+
 /**
  * Union of registered docast nodes that can occur where phrasing content is
  * expected.
@@ -30,9 +36,6 @@ type PhrasingContent = PhrasingContentMap[keyof PhrasingContentMap]
  *
  * @extends {mdast.PhrasingContentMap}
  */
-interface PhrasingContentMap extends mdast.PhrasingContentMap {
-  code: mdast.Code
-  inlineTag: InlineTag
-}
+interface PhrasingContentMap extends mdast.PhrasingContentMap {}
 
 export type { PhrasingContent, PhrasingContentMap }