mdif.test.js

import { describe, test, expect } from 'vitest'
import { promises as fs } from 'fs'
import { textToId, getASTInfo, getConversations, getAllSections, getSection, getDialog, runDialog } from './index.js'

const md = (await fs.readFile('example.md'))

describe('mdif', () => {
  // this tests that ID function can handle any arbitrary header-text
  describe('textToId', () => {
    test(`I'm Here`, () => {
      expect(textToId(`I'm Here`)).toEqual("im_here")
    })
    
    test(`Cool. Story. Bro!`, () => {
      expect(textToId(`Cool. Story. Bro!`)).toEqual("cool_story_bro")
    })
    
    test(`What Do You Mean?`, () => {
      expect(textToId(`What Do You Mean?`)).toEqual("what_do_you_mean")
    })
    
    test(`EPIC`, () => {
      expect(textToId(`EPIC`)).toEqual("epic")
    })

    test(`spaces  should     collapse`, () => {
      expect(textToId(`spaces  should     collapse`)).toEqual("spaces_should_collapse")
    })

    test(`Lot's of [WeIrD]!@$#!!**.,??(ok)`, () => {
      expect(textToId(`Lot's of [WeIrD]!@$#!!**.,??(ok)`)).toEqual("lots_of_weird_ok")
    })
  })

  // this tests internal parsing functions to make sure they are working right
  describe('parsing', () => {
    test('get meta-info', () => {
      expect(getASTInfo(md).info).toEqual({
        "description": "A land of rolling hills rising to low mountains in the south. It is predominantly forested except for marshlands in the north. The country is bordered on the east by the Eastern Ocean, on the west by a great mountain range, on the north by the River Shribble, and on the south by Archenland.",
        "name": "Narnia",
      })
    })
    
    test('get all conversaton IDs', () => {
      expect(getConversations(md)).toEqual([
        "start",
        "thats_my_name",
        "no_promises",
        "scare_konsumer",
        "lie_about_name",
        "take_sword",
        "goodbye",
      ])
    })

    test('get a single section AST, by ID', () => {
      const section = getSection(md, 'start')
      expect(section.id).toBe('start')
      expect(section.children.length).toBe(7)
      expect(section.children.map(c => c.type)).toEqual([
        "paragraph",
        "blockquote",
        "paragraph",
        "paragraph",
        "blockquote",
        "list",
        "paragraph",
      ])
    })

    test('suggest a nice ID for bad input', () => {
      expect(() => {
        const section = getSection(md, 'statr')
      }).toThrow('Dialog ID "statr" not found. Did you mean "start"?')

      expect(() => {
        const section = getSection(md, 'No Promises')
      }).toThrow('Dialog ID "No Promises" not found. Did you mean "no_promises"?')
    })

    test('get a complete dialog by ID', () => {
      const dialog = getDialog(md, 'start', {  player: { name: 'Lucy' } })
      expect(Object.keys(dialog)).toEqual(['code', 'conversation', 'options'])
      expect(dialog.conversation[0].text).toBe('Hi, yer name is Lucy, right?')
      expect(dialog.conversation[0].who).toBe('konsumer')
    })
  })

  // this illustrates more typical usage
  describe('usage', () => {
    test('konsumer is not scared', () => {
      const variables = {
        player: { name: 'Peter' },
        konsumer: { scared: false }
      }
    
      // get the first screen
      let screen = runDialog(md, 'start', variables)
      expect(Array.isArray(screen)).toBe(false)
      expect(screen.who).toBe('konsumer')
      expect(screen.text).toBe('Hi, yer name is Peter, right?')

      // simulate user pressing "next" button: return options
      screen = runDialog(md, 'start', variables, 1)
      expect(Array.isArray(screen)).toBe(true)
      expect(screen.length).toBe(4)
      expect(screen[0].dialog).toBe('#start')
    })

    test('konsumer is scared', () => {
      const variables = {
        player: { name: 'Peter' },
        konsumer: { scared: true }
      }
    
      // get the first screen
      const screen = runDialog(md, 'start', variables)
      expect(Array.isArray(screen)).toBe(false)
      expect(screen.text).toBe("I'm not talking to you, you're going to sword me!")
    })

    test('run code', () => {
      const variables = {
        player: { name: 'Peter' },
        konsumer: { scared: false }
      }
    
      // get the first screen
      const screen = runDialog(md, 'scare_konsumer', variables)
      expect(Array.isArray(screen)).toBe(false)
      expect(variables.konsumer.scared).toBe(true)
      expect(screen.who).toBe('konsumer')
      expect(screen.text).toBe('Ok, color me scared. I will avoid you in the future.')
      expect(screen.ending).toBe('end')
    })
  })
})