vault backup: 2025-04-11 14:41:26

.obsidian/plugins/obsidian-automatic-table-of-contents-main/test/options.test.js

@@ -0,0 +1,102 @@
+const { parseOptionsFromSourceText } = require('../main.js')
+
+describe('Options', () => {
+  test('Returns default options if none are specified', () => {
+    const options = parseOptionsFromSourceText('')
+    expect(options).toEqual({
+      title: '',
+      style: 'nestedList',
+      includeLinks: true,
+      minLevel: 0,
+      maxLevel: 0,
+      hideWhenEmpty: false,
+      debugInConsole: false,
+    })
+  })
+
+  test('Returns custom options if specified', () => {
+    const optionsText = `
+      title: # Some title
+      style: inlineFirstLevel # Some comment
+      minLevel: 1
+      maxLevel:  2   # Some other comment
+      includeLinks: false
+      hideWhenEmpty: true
+      debugInConsole: true
+    `
+    const options = parseOptionsFromSourceText(optionsText)
+    expect(options).toEqual({
+      title: '# Some title',
+      style: 'inlineFirstLevel',
+      includeLinks: false,
+      minLevel: 1,
+      maxLevel: 2,
+      hideWhenEmpty: true,
+      debugInConsole: true,
+    })
+  })
+
+  test('Accepts comments in options', () => {
+    const options = parseOptionsFromSourceText('maxLevel: 5 # some comment')
+    expect(options.maxLevel).toEqual(5)
+  })
+
+  test('Ignores unknown options', () => {
+    const options = parseOptionsFromSourceText(`
+      maxLevel:    5
+      someOption:  someValue
+    `)
+    expect(options.maxLevel).toEqual(5)
+  })
+
+  describe('Throw an error if the option value is invalid', () => {
+    test('On style', () => {
+      try {
+        const options = parseOptionsFromSourceText('style: someInvalidStyle')
+        expect(options.style).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+    test('On minLevel', () => {
+      try {
+        const options = parseOptionsFromSourceText('minLevel: -1')
+        expect(options.minLevel).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+    test('On maxLevel', () => {
+      try {
+        const options = parseOptionsFromSourceText('maxLevel: -1')
+        expect(options.maxLevel).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+    test('On includeLinks', () => {
+      try {
+        const options = parseOptionsFromSourceText('includeLinks: no')
+        expect(options.includeLinks).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+    test('On hideWhenEmpty', () => {
+      try {
+        const options = parseOptionsFromSourceText('hideWhenEmpty: maybe')
+        expect(options.hideWhenEmpty).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+    test('On debugInConsole', () => {
+      try {
+        const options = parseOptionsFromSourceText('debugInConsole: yes')
+        expect(options.debugInConsole).toEqual('Should have thrown')
+      } catch(error) {
+        expect(error.message).toContain('Invalid value')
+      }
+    })
+  })
+})