Merge pull request #208 from orgapp/editor

tidy up orga types

Author: xiaoxinghu

packages/orga/src/parse/context.ts

@@ -1,9 +1,8 @@
-import assert from 'assert'
-import type { Node, Point } from 'unist'
+import type { Node, Point, Parent } from 'unist'
 import { not, test } from './index.js'
 import type { Predicate } from './index.js'
 import type { Lexer } from '../tokenize/index.js'
-import { Attributes, Document, isSection, Parent } from '../types.js'
+import { Attributes, Document, isSection } from '../types.js'
 
 interface Snapshot {
   stack: Parent[]
@@ -73,7 +72,9 @@ export function createContext(lexer: Lexer): Context {
       lexer.peek(-1)?.position?.end || { line: 1, column: 1, offset: 0 }
     node.position.end = point(end)
 
-    assert(node, 'unexpected empty stack')
+    if (!node) {
+      throw new Error('unexpected empty stack')
+    }
     // attach to tree
     if (stack.length > 0) {
       push(node)
@@ -87,14 +88,15 @@ export function createContext(lexer: Lexer): Context {
     if (test(last, predicate)) {
       return pop()
     }
-    assert(
-      !strict,
-      `
+    if (strict) {
+      throw new Error(
+        `
 can not strictly exit ${predicate},
 actual: ${last.type}
 location: line: ${last.position.start.line}, column: ${last.position.start.column}
 `.trim()
-    )
+      )
+    }
   }
 
   const exitTo = (predicate: Predicate) => {
@@ -121,7 +123,9 @@ location: line: ${last.position.start.line}, column: ${last.position.start.colum
 
   const push = (node: Node) => {
     if (!node) return
-    assert(stack.length > 0, 'unexpected empty stack')
+    if (stack.length === 0) {
+      throw new Error('unexpected empty stack')
+    }
     const parent = stack[stack.length - 1]
     parent.children.push(node)
     // node.parent = parent

packages/orga/src/parse/index.ts

@@ -1,4 +1,3 @@
-import assert from 'assert'
 import { Lexer } from '../tokenize'
 import { Node } from 'unist'
 import { Document, Parent, Token } from '../types.js'
@@ -114,7 +113,9 @@ export const parse = (lexer: Lexer): Document => {
 
   outter: while (handler()) {
     // prevent infinit loop
-    assert(maxStaleIterations > 0, `it's stuck. \n${context.state}`)
+    if (maxStaleIterations === 0) {
+      throw new Error(`it's stuck. \n${context.state}`)
+    }
 
     let nothingMatches = true
 
@@ -159,7 +160,9 @@ export const parse = (lexer: Lexer): Document => {
       maxStaleIterations = 10
     }
   }
-  assert(!lexer.peek(), `not all tokens processed`)
+  if (lexer.peek()) {
+    throw new Error(`not all tokens processed`)
+  }
 
   context.exitTo('document')
   context.exit('document')

packages/orga/src/parse/paragraph.ts

@@ -1,11 +1,11 @@
 import { Action } from './index.js'
-import { Opening, Token } from '../types.js'
+import { Opening, isParagraph, PhrasingContent } from '../types.js'
 import { clone, isPhrasingContent } from '../utils.js'
 import { Context } from './context.js'
 import phrasingContent from './phrasing.js'
 import { isImage } from './_utils.js'
 
-const isWhitespaces = (node: Token) => {
+const isWhitespaces = (node: PhrasingContent) => {
   return (
     (node.type === 'text' && node.value.trim().length === 0) ||
     node.type === 'newline' ||
@@ -28,7 +28,7 @@ const paragraph: Action = () => {
 
   const exitPragraph = (context: Context) => {
     const paragraph = context.getParent()
-    if (paragraph.type !== 'paragraph') return
+    if (!isParagraph(paragraph)) return
     if (
       paragraph.children.length === 0 ||
       paragraph.children.every(isWhitespaces)

packages/orga/src/types.ts

@@ -1,10 +1,16 @@
-import type { Literal as UnistLiteral, Node, Parent } from 'unist'
+import type {
+  Literal as UnistLiteral,
+  Node,
+  Parent as UnistParent,
+} from 'unist'
 
 export interface Literal extends UnistLiteral {
   value: string
 }
 
-export { Parent }
+export interface Parent extends UnistParent {
+  children: Content[]
+}
 
 export type Primitive = string | number | boolean
 
@@ -37,9 +43,8 @@ export interface Section extends Parent {
   children: Content[]
 }
 
-type TopLevelContent = Content | Keyword | Footnote
-
-type Content =
+// --- content types ----
+export type BlockContent =
   | Section
   | Paragraph
   | Block
@@ -52,6 +57,16 @@ type Content =
   | HTML
   | JSX
 
+type TopLevelContent = BlockContent | Keyword | Footnote
+
+export type Content =
+  | TopLevelContent
+  | TableContent
+  | TableRow
+  | TableCell
+  | ListContent
+  | PhrasingContent
+
 export interface Footnote extends Parent {
   type: 'footnote'
   label: string
@@ -79,11 +94,13 @@ export interface Planning extends Node {
   timestamp: Timestamp
 }
 
+type ListContent = ListItem | List
+
 export interface List extends Parent, Attributed {
   type: 'list'
   indent: number
   ordered: boolean
-  children: (List | ListItem)[]
+  children: ListContent[]
 }
 
 type TableContent = TableRow | TableRule
@@ -107,6 +124,7 @@ export interface ListItem extends Parent {
   type: 'list.item'
   indent: number
   tag?: string
+  children: PhrasingContent[]
 }
 
 export interface Headline extends Parent {
@@ -116,6 +134,7 @@ export interface Headline extends Parent {
   actionable: boolean
   priority?: string
   tags?: string[]
+  children: PhrasingContent[]
 }
 
 export interface Paragraph extends Parent, Attributed {
@@ -161,7 +180,14 @@ export type Token =
   | Closing
   | LinkPath
 
-export type PhrasingContent = Text | Link | FootnoteReference | Newline
+export type PhrasingContent =
+  | Text
+  | Link
+  | FootnoteReference
+  | Newline
+  | EmptyLine
+  | HTML
+  | JSX
 
 export interface HorizontalRule extends Node {
   type: 'hr'
@@ -342,6 +368,10 @@ export function isSection(node: Node): node is Section {
   return node.type === 'section'
 }
 
+export function isParagraph(node: Node): node is Paragraph {
+  return node.type === 'paragraph'
+}
+
 export function isLink(node: Node): node is Link {
   return node.type === 'link'
 }