From 5eff775a76b3a78e1801aa6f9d85e525fb3e2a5a Mon Sep 17 00:00:00 2001
From: Hsieh Chin Fan <pham@topo.tw>
Date: Sat, 7 Sep 2024 22:26:14 +0800
Subject: chore: Improve comments

---
 src/editor.mjs | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

(limited to 'src')

diff --git a/src/editor.mjs b/src/editor.mjs
index 8b0a6ac..c011c6b 100644
--- a/src/editor.mjs
+++ b/src/editor.mjs
@@ -8,7 +8,7 @@ const HtmlContainer = document.querySelector(".result-html")
 const mdeElement = document.querySelector("#tinymde")
 
 // Add Editor
-const defaultContent = '## Links\n\n- [Go to marker](geo:24,121?id=foo,leaflet&text=normal "Link Test")\n\n```map\nid: foo\nuse: maplibre\n```\n'
+const defaultContent = '## Links\n\n- [Go to marker](geo:24,121?id=foo,leaflet&text=normal "Link Test")\n\n```map\nid: foo\nuse: Maplibre\n```\n'
 const lastContent = localStorage.getItem('editorContent')
 const tinyEditor = new TinyMDE.Editor({
   element: 'tinymde',
@@ -158,7 +158,7 @@ const getLineWithRenderer = (element) => {
   return null
 }
 // }}}
-// FUNCTION: Add suggestions for current selection {{{
+// FUNCTION: Return suggestions for valid options {{{
 const getSuggestionsForOptions = (optionTyped, validOptions) => {
   let suggestOptions = []
 
@@ -177,7 +177,8 @@ const getSuggestionsForOptions = (optionTyped, validOptions) => {
       replace: `${o.valueOf()}: `,
     }))
 }
-
+// }}}
+// FUNCTION: Return suggestion for example of option value {{{
 const getSuggestionFromMapOption = (option) => {
   if (!option.example) return null
 
@@ -190,7 +191,8 @@ const getSuggestionFromMapOption = (option) => {
     replace: `${option.valueOf()}: ${option.example ?? ""}`,
   })
 }
-
+// }}}
+// FUNCTION: Return suggestions from aliases {{{
 const getSuggestionsFromAliases = (option) => Object.entries(aliasesForMapOptions[option.valueOf()] ?? {})
   ?.map(record => {
     const [alias, value] = record
@@ -201,8 +203,8 @@ const getSuggestionsFromAliases = (option) => Object.entries(aliasesForMapOption
     })
   })
   ?? []
-
-// Add HTML element for List of suggestions
+// }}}
+// FUNCTION: Add HTML element for List of suggestions {{{
 const addSuggestions = (currentLine, selection) => {
   const text = currentLine.textContent
   const markInputIsInvalid = (ele) => (ele ?? currentLine).classList.add('invalid-input')
@@ -327,7 +329,7 @@ const addSuggestions = (currentLine, selection) => {
   suggestionsEle.style.maxWidth = `calc(${window.innerWidth}px - ${rect.right}px - 2rem)`;
 }
 // }}}
-// Event: suggests for current selection {{{
+// EVENT: suggests for current selection {{{
 tinyEditor.addEventListener('selection', selection => {
   // To trigger click event on suggestions list, don't set suggestion list invisible
   if (suggestionsEle.querySelector('.container__suggestion.focus:hover') !== null) {
@@ -356,7 +358,7 @@ tinyEditor.addEventListener('selection', selection => {
   if (insideCodeblockForMap(element)) addSuggestions(element, selection)
 });
 // }}}
-// Key events for suggestions {{{
+// EVENT: keydown for suggestions {{{
 mdeElement.addEventListener('keydown', (e) => {
   // Only the following keys are used
   const keyForSuggestions = ['Tab', 'Enter', 'Escape'].includes(e.key)
-- 
cgit v1.2.3-70-g09d2