imdone-core 1.50.3 → 1.51.0

package/devops/containers/setup-remote.sh

@@ -14,8 +14,11 @@ docker run \
 
 docker exec git-remote mkdir /home/git/authorized_keys
 
-# TODO: Generate a key in the container and use that instead of copying the key from the host
+# TODO Generate a key in the container and use that instead of copying the key from the host
 # Update to use `GIT_SSH_COMMAND="ssh -i ~/.ssh/id_rsa_example" git clone example`
+# <!--
+# order:0
+# -->
 
 
 docker cp ~/.ssh/id_rsa.pub git-remote:/home/git/authorized_keys

package/lib/adapters/markdown.js

@@ -1,32 +1,93 @@
 const checkbox = require('markdown-it-checkbox')
 const imageSize = require('markdown-it-imsize')
-const emoji = require('markdown-it-emoji') // used in taskEditor
+const emoji = require('markdown-it-emoji')
 const mark = require('markdown-it-mark')
-const removeMD = require('remove-markdown') // used in epic-plugins
+const removeMD = require('remove-markdown')
 const wikilinks = require('@kwvanderlinde/markdown-it-wikilinks')
+const path = require('path');
 
 const MarkdownIt = require('markdown-it')
-const md = new MarkdownIt({html: true, breaks: true})
-
-md.use(checkbox)
-.use(mark)
-.use(emoji)
-.use(imageSize)
-.use(wikilinks(
-  { 
-    linkPattern: /\[\[([\w\u00C0-\u017F\s\d-/]+)(\|([\w\u00C0-\u017F\s\d-/]+))?\]\]/,
-    uriSuffix: '.md',
-    postProcessPageName (pagename) {
-      return pagename.trim()
+let _platform = process.platform
+
+function extractWikilinkTopics(markdown) {
+  const wikilinkRegex = /\[\[([\w\s/]+)(\|([\w\s/]+))?\]\]/g; // Match [[Topic]] or [[Topic|Display Text]]
+  const topics = [];
+  let match;
+
+  // Use RegExp.exec to iterate through all matches
+  while ((match = wikilinkRegex.exec(markdown)) !== null) {
+    topics.push(match[1].trim()); // Extract the topic (first capture group) and trim whitespace
+  }
+
+  return topics;
+}
+
+function getRenderer(projectPath) {
+  const md = new MarkdownIt({html: true, breaks: true})
+
+  md.use(checkbox)
+  .use(mark)
+  .use(emoji)
+  .use(imageSize)
+  .use(wikilinks(
+    { 
+      linkPattern: /\[\[([\w\u00C0-\u017F\s\d-/]+)(\|([\w\u00C0-\u017F\s\d-/]+))?\]\]/,
+      uriSuffix: '.md',
+      postProcessPageName (pagename) {
+        return pagename.trim()
+      }
     }
+  ))
+  .use(replaceImagePaths(projectPath))
+  .validateLink = () => true
+
+  return md
+}
+
+function replaceImagePaths(projectPath) {
+
+  return function(md) {
+    const defaultRender = md.renderer.rules.image || function(tokens, idx, options, env, self) {
+      return self.renderToken(tokens, idx, options);
+    };
+
+    md.renderer.rules.image = function(tokens, idx, options, env, self) {
+      const token = tokens[idx];
+      const srcIndex = token.attrIndex('src');
+
+      if (srcIndex >= 0) {
+        const src = token.attrs[srcIndex][1];
+        if (!src.startsWith('http')) {
+          const filePath = projectPath ? path.join(projectPath, src) : path.resolve(src);
+          const fileUrl = pathToFileURL(filePath);
+          token.attrs[srcIndex][1] = fileUrl;
+        }
+      }
+
+      return defaultRender(tokens, idx, options, env, self);
+    };
   }
-))
-.validateLink = () => true
+}
+
+function pathToFileURL(absolutePath) {
+  if (_platform === 'win32') {
+    absolutePath = '/' + absolutePath.replace(/\\/g, '/');
+  }
+  return `file://${absolutePath}`;
+}
+
+function renderCancelledTasks(markdown) {
+  return markdown.replace(/- \[-\] (.+)/gm, '- :no_entry_sign: ~~$1~~');
+}
 
 module.exports = {
-  renderMarkdown (markdown) {
-    markdown = markdown.replace(/- \[-\] (.+)/gm, '- :no_entry_sign: ~~$1~~');
-    return md.render(markdown)
+  _setPlatform(platform) {
+    _platform = platform
+  },
+  renderMarkdown (markdown, projectPath) {
+    markdown = renderCancelledTasks(markdown)
+    return getRenderer(projectPath).render(markdown)
   },
+  extractWikilinkTopics,
   removeMD  
-}
+}

package/lib/adapters/parsers/file/LocalFileParserFactory.js

@@ -5,7 +5,8 @@ const languages = require('../../../languages')
 const ReadStreamCodeParser = require('./ReadStreamCodeParser')
 
 
-function getLang(languages, filePath) {
+function getLang(config, filePath) {
+  const languages = getLanguages(config)
   var lang = languages[path.extname(filePath)]
   return lang || { name: 'text', symbol: '' }
 }
@@ -15,13 +16,12 @@ function getLanguages(config) {
   return { ...languages, ...configLanguages }
 }
 
-
+module.exports.getLang = getLang
 module.exports.getFileParser = async function getFileParser (filePath, config, readStream) {
   if (!readStream) {
     readStream = createReadStream(filePath)
   }
-  const languages = getLanguages(config)
-  const lang = getLang(languages, filePath)
+  const lang = getLang(config, filePath)
   if (lang.name === 'text') {
     return new ReadStreamMarkdownParser(readStream, config)
   } else {

package/lib/adapters/parsers/file/ReadStreamCodeParser.js

@@ -18,6 +18,9 @@ module.exports = class ReadStreamCodeParser extends ReadStreamTaskParser {
   async init() {
     const code = await streamToString(this.readStream)
     // TODO Getting tokens from lists should be done higher up in the controller
+    // <!--
+    // order:-10
+    // -->
     const tokens = this.lists.filter(list => !list.filter).map(list => list.name)
     this.cards = this.parseCards(code, tokens)
   }
@@ -33,7 +36,10 @@ module.exports = class ReadStreamCodeParser extends ReadStreamTaskParser {
     Object.keys(comments).forEach((comment) => {
       const { begin, end, content } = comments[comment];
       const line = begin;
-      const lastLine = end - 1;
+      const lastLine = end; // DOING lastLine should not be - 1
+                            // <!--
+                            // order:0
+                            // -->
       const lines = content.split('\n');
   
       // Check if the comment contains "TODO"

package/lib/adapters/parsers/file/ReadStreamTaskParser.js

@@ -89,17 +89,12 @@ module.exports = class ReadStreamTaskParser {
 
   trimLinesToEndTask() {
     if (!this.task) return
-    if (
-      this.blankLines == blankLinesToEndTask
-    ) {
-      this.task.description.length = this.task.description.length - (this.blankLines - 1)
-    } else if (this.nextTask){
-      this.task.description.length = this.task.description.length - (this.blankLines + 1)
-    } else {
-      this.task.description.length = this.task.description.length - this.blankLines
-    }
 
-    this.task.lastLine = this.task.line + this.task.description.length - 1
+    // Remove the empty strings from the end of the task description
+    while (this.task.description[this.task.description.length - 1] === '') {
+      this.task.description.pop()
+    }
+    this.task.lastLine = this.task.line + this.task.description.length
   }
 
   close() {

package/lib/adapters/readers/FileSystemProjectReader.js

@@ -7,7 +7,9 @@ module.exports = class FileSystemProjectReader {
     // BACKLOG ## Load the config file
     // #adapter
     // [lib/adapters/readers/FileSystemProjectReader.js](lib/adapters/readers/FileSystemProjectReader.js)
-    // <!-- epic:"Release 2.0" -->
+    // <!-- epic:"Release 2.0"
+    // order:-590
+    // -->
     const files = await this.getFilesFromDirectory(projectPath)
 
     // BACKLOG ## Parse project files
@@ -18,7 +20,9 @@ module.exports = class FileSystemProjectReader {
     // - After tasks are parsed trim the description appropriately and look for Check style tasks in what's left of the description
     // #adapter
     // [lib/adapters/readers/FileSystemProjectReader.js](lib/adapters/readers/FileSystemProjectReader.js)
-    // <!-- epic:"Release 2.0" -->
+    // <!-- epic:"Release 2.0"
+    // order:-600
+    // -->
 
   }
 

package/lib/adapters/storage/config.js

@@ -38,7 +38,7 @@ async function getYamlConfig(filePath) {
     if (configLike.watcher) delete configLike.watcher
 
   } catch (e) {
-    /* noop */
+    console.error(`Error parsing config file: ${filePath}`)
   }
   return configLike
 }

package/lib/card.js

@@ -10,7 +10,7 @@ const eol = require('eol')
 const allEmoji = require('markdown-it-emoji/lib/data/full.json')
 const { getIsoDateWithOffset } = require('./adapters/date-time')
 
-const { removeMD, renderMarkdown } = require('./adapters/markdown')
+const { removeMD } = require('./adapters/markdown')
 
 const CONTENT_TOKEN = '__CONTENT__'
 const lf = String(eol.lf)
@@ -45,6 +45,7 @@ module.exports = function newCard(task, _project, dontParse) {
     }
 
     init(totals = project.totals) {
+      this.topics = project.extractWikilinkTopics(this.interpretedContent)
       this.updateLastLine()
       this.totals = totals
       this.onTaskUpdate()
@@ -58,6 +59,9 @@ module.exports = function newCard(task, _project, dontParse) {
     onTaskUpdate() {
       // TODO We should be mapping to the imdone-api task
       // #imdone-1.45.0
+      // <!--
+      // order:-20
+      // -->
       const interpretedContent = pluginManager.onTaskUpdate(this)
       if (interpretedContent && interpretedContent.length > 0) {
         this.interpretedContent = interpretedContent
@@ -126,11 +130,16 @@ module.exports = function newCard(task, _project, dontParse) {
           'projectPath',
           'relPath',
           'fullPath',
-          'totals'].sort()
+          'totals',
+          'topics'].sort()
         ),
       }
     }
 
+    // TODO Add isInCodeFile property to card
+    // <!--
+    // order:-115
+    // -->
     initData() {
       const props = { ...this.props, content: CONTENT_TOKEN }
       const computed = { ...this.computed }
@@ -250,7 +259,7 @@ module.exports = function newCard(task, _project, dontParse) {
         .replace(/%%[\s\S]*?%%/g, '')
         .replace(/<\!--\s*?-->/gs, '')
         .trim()
-      taskMD = this.replaceImagePaths(taskMD)
+      // taskMD = this.replaceImagePaths(taskMD)
       // - Split on eol and append lines until visible line count equals lines
       const displayContent = []
       const rawContent = []
@@ -271,28 +280,28 @@ module.exports = function newCard(task, _project, dontParse) {
       return { totalLines, markdown, rawMarkdown }
     }
 
-    replaceImagePaths(content) {
-      return content.replace(
-        /(!\[.*?\]\()(.*?)(\))/g,
-        (match, p1, imagePath, p3) => {
-          if (/^http/.test(imagePath)) return match
-          imagePath = _path.join(
-            _path.dirname(this.fullPath),
-            imagePath
-          ).replace(/ /g, '%20')
-          const imageURL = `file://${imagePath}`
-          return p1 + imageURL + p3
-        }
-      )
-    }
+    // replaceImagePaths(content) {
+    //   return content.replace(
+    //     /(!\[.*?\]\()(.*?)(\))/g,
+    //     (match, p1, imagePath, p3) => {
+    //       if (/^http/.test(imagePath)) return match
+    //       imagePath = _path.join(
+    //         _path.dirname(this.fullPath),
+    //         imagePath
+    //       ).replace(/ /g, '%20')
+    //       const imageURL = `file://${imagePath}`
+    //       return p1 + imageURL + p3
+    //     }
+    //   )
+    // }
 
     getHtml(content) {
-      const html = renderMarkdown(content)
+      const html = project.renderMarkdown(content)
       const mdArray = eol.split(content)
       let truncHtml = null
       if (mdArray.length > this.truncLines) {
         mdArray.length = this.truncLines
-        truncHtml = renderMarkdown(mdArray.join(eol.lf))
+        truncHtml = project.renderMarkdown(mdArray.join(eol.lf))
       }
       return { html, truncHtml }
     }

package/lib/config.js

@@ -6,16 +6,7 @@ const _get = require('lodash.get')
 const { 
   JOURNAL_TYPE, 
   DEFAULT_CONFIG,
-  CONFIG_FILE_YML,
-  CONFIG_DIR
 } = require('./constants')
-const _path = require('path')
-const findUp = require('find-up')
-const { loadYAML } = require('./adapters/yaml')
-const {
-  exists,
-  readFile,
-} = require('./adapters/file-gateway')
 
 /**
  * Description
@@ -185,7 +176,7 @@ class Config {
   }
 
   get archiveCompleted() {
-    return _get(this, 'settings.cards.archiveCompleted', false)
+    return _get(this, 'settings.cards.archiveCompleted')
   }
 
   get tokenPrefix() {

package/lib/default-settings.js

@@ -1,6 +1,7 @@
 const { loadYAML } = require('./adapters/yaml')
 
 const defaultSettingsString = `openIn: default #override
+openCodeIn: default #override
 journalType: New File
 journalPath: imdone-tasks #override
 appendNewCardsTo: imdone-tasks.md

package/lib/file.js

@@ -830,7 +830,10 @@ File.prototype.modifyDescription = function (task, config) {
   let description = task.description.map(
     (desc) => `${spaces}${descriptionStartsWith}${desc}`
   )
-  // BACKLOG:-30 Allow this to pad for code files as well
+  // BACKLOG Allow this to pad for code files as well
+  // <!--
+  // order:-620
+  // -->
   description = File.padDescription(description, task.beforeText).join(lineEnd)
   if (taskContentLines.length === 0 && description.length > 0) {
     beforeDescContent += description + lineEnd
@@ -885,7 +888,10 @@ File.prototype.extractTaskWithDescription = function ({
   var self = this
   const lang = this.getLang()
   let description = []
-  // BACKLOG:-230 ## add beforeText for code files
+  // BACKLOG ## add beforeText for code files
+  // <!--
+  // order:-630
+  // -->
   const beforeText = this.getBeforeText(line, pos)
   let { rawTaskContentLines, taskContentLines, isWrappedWithCardTag } = this.getTaskContent({
     config,
@@ -1100,7 +1106,7 @@ File.prototype.removeTask = function (task) {
 }
 
 File.prototype.ignoreCodeBlocks = function () {
-  // BACKLOG:-100 This is not used, but we need a way to ignore tasks in code blocks. Maybe save position ranges
+  // BACKLOG This is not used, but we need a way to ignore tasks in code blocks. Maybe save position ranges
   // ```javascript
   // var cleanContent = this.content
   // var replacer = function (block) {
@@ -1115,6 +1121,9 @@ File.prototype.ignoreCodeBlocks = function () {
   // }
   // return cleanContent
   // ```
+  // <!--
+  // order:-640
+  // -->
 }
 
 File.prototype.isMarkDownFile = function () {

package/lib/list.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const uniqid = require('uniqid')
-// BACKLOG:10 Create list groups to show and hide for projects/repos. gh:96 id:11
+// BACKLOG Create list groups to show and hide for projects/repos. gh:96 id:11
+// <!--
+// order:-610
+// -->
 
 /**
  * Description

package/lib/migrate-config.js

@@ -50,17 +50,17 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
         delete config.settings.defaultList
       }
 
-      if (!config.settings.cards.defaultList) {
+      if (config.settings.cards.defaultList === undefined) {
         config.settings.cards.defaultList = lists ? lists[0] : ''
       }
 
       // archiveCompleted
       if (config.settings.cards.archiveCompleted === undefined) {
-        config.settings.cards.archiveCompleted = false
+        config.settings.cards.archiveCompleted = true
       }
 
       // archiveFolder
-      if (!config.settings.cards.archiveFolder) {
+      if (config.settings.cards.archiveFolder === undefined) {
         config.settings.cards.archiveFolder = config.settings.journalPath ? _path.join(config.settings.journalPath, 'archive') : 'archive'
       }
 
@@ -106,11 +106,11 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
         delete config.settings.doneList
       }
       // Set up default doneList
-      if (!config.settings.cards.doneList) {
+      if (config.settings.cards.doneList === undefined) {
         config.settings.cards.doneList = lists ? lists[lists.length - 1] : ''
       }
       // Add name
-      if (!config.settings.name) {
+      if (config.settings.name === undefined) {
         config.settings.name = _path.basename(path)
       }
 
@@ -138,7 +138,7 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
       })
 
       // Make sure kudosProbability is set
-      if (!config.settings.kudosProbability && config.settings.kudosProbability !== 0) {
+      if (config.settings.kudosProbability === undefined) {
         config.settings.kudosProbability = 0.33
       }
 

package/lib/mixins/repo-fs-store.js

@@ -251,7 +251,10 @@ function mixin(repo, fs = require('fs')) {
   }
 
   repo.loadConfig = function (cb) {
-    // BACKLOG:-650 If a config is bad move it to config.json.bak and save a new one with defaults gh:2 id:9 +enhancement +standup +chore
+    // BACKLOG If a config is bad move it to config.json.bak and save a new one with defaults gh:2 id:9 +enhancement +standup +chore
+    // <!--
+    // order:-670
+    // -->
     cb = tools.cb(cb)
     repo.loadIgnore()
     // new

package/lib/mixins/repo-watched-fs-store.js

@@ -8,7 +8,10 @@ var fsStore = require('./repo-fs-store'),
 
 module.exports = mixin
 
-// BACKLOG:-280 Only emit file.update if the file checksum has changed
+// BACKLOG Only emit file.update if the file checksum has changed
+// <!--
+// order:-650
+// -->
 function mixin(repo, fs = require('fs')) {
   repo = fsStore(repo, fs)
   var _refresh = repo.refresh
@@ -150,6 +153,9 @@ function mixin(repo, fs = require('fs')) {
         const isFile = File.isFile(file)
         // BACKLOG ## Handle the case where the file is not in the repo
         // #urgent #1.12.0
+        // <!--
+        // order:-660
+        // -->
         if (isFile && stat.mtime <= file.getModifiedTime()) {
           // console.log("File update already applied.  Change ignored.")
           return

package/lib/plugins/epic-plugin.js

@@ -1,5 +1,3 @@
-// const removeMD = require('remove-markdown')
-const { renderMarkdown } = require('../adapters/markdown')
 const Plugin = require('imdone-api')
 
 function getIsEpicMeta(task) {
@@ -161,7 +159,7 @@ module.exports = class EpicPlugin extends Plugin {
         content += '<ul style="list-style: none;">'
         content += tasks
           .map((task) => {
-            const taskText = renderMarkdown(task.text).replaceAll(/<p>|<\/p>/ig, '') // removeMD(task.text)
+            const taskText = this.project.renderMarkdown(task.text).replaceAll(/<p>|<\/p>/ig, '') // removeMD(task.text)
             const checked =
               task.list === this.project.doneList ? ' checked="true"' : ''
             const taskFilePath = encodeURI(

package/lib/project.js

@@ -15,7 +15,7 @@ const exec = require('child_process').exec
 const fastSort = require('fast-sort/dist/sort.js')
 const Task = require('./task')
 const eol = require('eol')
-const { renderMarkdown } = require('./adapters/markdown')
+const { renderMarkdown, extractWikilinkTopics } = require('./adapters/markdown')
 
 function calculateTotals(lists) {
   const totals = {}
@@ -88,7 +88,10 @@ module.exports = class WorkerProject extends Project {
     if (!cb) return promise
   }
   
-  // HACK:-50 To handle circular dependency issue with file
+  // HACK To handle circular dependency issue with file
+  // <!--
+  // order:0
+  // -->
   toJSON() {
     return { path: this.path }
   }
@@ -787,6 +790,10 @@ module.exports = class WorkerProject extends Project {
   }
 
   renderMarkdown(content) {
-    return renderMarkdown(content)
+    return renderMarkdown(content, this.path)
+  }
+
+  extractWikilinkTopics(markdown) {
+    return extractWikilinkTopics(markdown)
   }
 }

package/lib/repository.js

@@ -629,7 +629,10 @@ Repository.prototype.readFile = function (file, cb) {
   if (!/\.\.(\/|\\)/.test(filePath)) {
     this.readFileContent(file, (err, file) => {
       if (err) return cb(new Error('Unable to read file:' + filePath))
-      // BACKLOG:-40 Allow user to assign a module for content transformation
+      // BACKLOG Allow user to assign a module for content transformation
+      // <!--
+      // order:-800
+      // -->
       file.checksum = checksum(file.getContent())
       file.updated = currentChecksum !== file.checksum
       if (file.updated)
@@ -914,7 +917,10 @@ Repository.prototype.moveTasksBetweenLists = function(oldName, newName, cb) {
     }
   })
 
-  // BACKLOG:-730 Let's use saveModifiedFiles here id:15 gh:100 +fix
+  // BACKLOG Let's use saveModifiedFiles here id:15 gh:100 +fix
+  // <!--
+  // order:-810
+  // -->
 
   this.moving = true
   if (modifyTasks.length > 0) {

package/lib/task.js

@@ -386,7 +386,10 @@ Task.prototype.getTagPrefix = function () {
 }
 
 Task.prototype.addToLastCommentInContent = Task.addToLastCommentInContent = function (content, toAdd, newLine) {
-  // BACKLOG:-220 respect padding of task prefix for list items
+  // BACKLOG respect padding of task prefix for list items
+  // <!--
+  // order:-680
+  // -->
   let prefix = newLine ? lineEnd : ' '
   const commentRegex = /<!--([\s\S]*?)-->/gm
   let result, lastIndex, index
@@ -523,7 +526,10 @@ Task.removeContext = function (text) {
 }
 
 Task.prototype.updateContext = function () {
-  // BACKLOG:-900 implement updateContext id:1 gh:124
+  // BACKLOG implement updateContext id:1 gh:124
+  // <!--
+  // order:-690
+  // -->
   var self = this
   if (this.context) {
     let text = Task.removeContext(this.text)
@@ -700,7 +706,10 @@ Task.prototype.getList = function () {
  * @method getText
  * @return text
  */
-// BACKLOG:-160 make this use config.getMetaSep
+// BACKLOG make this use config.getMetaSep
+// <!--
+// order:-700
+// -->
 Task.prototype.getText = function (opts, text) {
   if (text === undefined) text = this.text
   if (opts) {

package/lib/tools.js

@@ -4,7 +4,6 @@ var _isFunction = require('lodash.isfunction'),
   _noop = require('lodash.noop'),
   crypto = require('crypto'),
   _path = require('path'),
-  markdown = require('markdown-it')().use(require('markdown-it-checkbox')),
   fastSort = require('fast-sort/dist/sort.js'),
   eol = require('eol'),
   max_bytes = 512
@@ -89,18 +88,6 @@ function isBinaryCheck(bytes, size) {
 
 module.exports = {
   escapeRegExp: require('escape-string-regexp'),
-  marked: function (content) {
-    return markdown.render(content)
-  },
-  parseMD: function (content) {
-    return markdown.parse(content, {})
-  },
-
-  /**
-   * Description
-   * @method userHome
-   * @return LogicalExpression
-   */
   userHome: function () {
     return process.env.HOME || process.env.HOMEPATH || process.env.USERPROFILE
   },

package/lib/usecases/get-imdone-url.js

@@ -0,0 +1,6 @@
+// TODO Add a function that returns the imdone url for vscode and obsidian plugins
+// <!--
+// created:2025-01-11T20:20:08.348Z
+// sid:wmr_a0ikOY39kInkmudPa
+// order:-110
+// -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.50.3",
+  "version": "1.51.0",
   "description": "imdone-core",
   "main": "index.js",
   "scripts": {