imdone-core 1.53.7 → 1.53.9

package/README.md

@@ -1,6 +1,6 @@
 [![npm version](https://badge.fury.io/js/imdone-core.svg)](https://badge.fury.io/js/imdone-core)
 [![Downloads](https://img.shields.io/npm/dm/imdone-core.svg)](https://npmjs.org/package/imdone-core)
-[![Build Status](https://github.com/imdone/imdone-core/actions/workflows/ci.yml/badge.svg)
+![Build Status](https://github.com/imdone/imdone-core/actions/workflows/ci.yml/badge.svg)
 
 Imdone is text based kanban processor with a simple syntax that uses [comment tags like TODO and FIXME](https://en.wikipedia.org/wiki/Comment_%28computer_programming%29#Tags) and [todo.txt format](https://github.com/todotxt/todo.txt#todotxt-format). This model allows the user to create and modify tasks using the keyboard and automatically establishes a link between their tasks and work.  Get [imdone](https://imdone.io) or use the cli to see your projects board and this library in action.
 

package/lib/adapters/file-gateway.js

@@ -4,7 +4,20 @@ let fs = require('fs')
 const sanitize = require('sanitize-filename')
 
 
-module.exports = {
+function mkdirpSync(path) {
+  console.warn('sync call')
+  return require('mkdirp').sync(path, { fs })
+}
+
+function statSync(path) {
+  console.warn('sync call')
+  try {
+    return fs.statSync(path)
+  } catch {
+  }
+}
+
+const gateway = {
   init(fileSystem = fs) {
     fs = fileSystem
   },
@@ -53,10 +66,7 @@ module.exports = {
     return fs.unlinkSync.apply({}, args)
   },
 
-  mkdirpSync(path) {
-    console.warn('sync call')
-    return require('mkdirp').sync(path, { fs })
-  },
+  mkdirpSync,
 
   async mkdir(path) {
     return fs.promises.mkdir(path)
@@ -66,13 +76,7 @@ module.exports = {
     return fs.promises.readFile(path, 'utf8')
   },
 
-  statSync(path) {
-    console.warn('sync call')
-    try {
-      return fs.statSync(path)
-    } catch {
-    }
-  },
+  statSync,
 
   readdirSyncRecursive(path) {
     console.warn('sync call')
@@ -94,14 +98,14 @@ module.exports = {
   },
 
   preparePathForWriting(path) {
-    let stat = this.statSync(path)
+    let stat = statSync(path)
     if (!stat) {
       let { dir, ext } = _path.parse(path)
       if (!ext) {
         dir = path
       }
-      this.mkdirpSync(dir)
-      stat = this.statSync(path)
+      mkdirpSync(dir)
+      stat = statSync(path)
     }
     return {
       isFile: stat && stat.isFile(),
@@ -109,3 +113,5 @@ module.exports = {
     }
   }
 }
+
+module.exports = gateway

package/lib/adapters/parsers/function-parser.js

@@ -0,0 +1,29 @@
+module.exports = {
+  getFunctionSignature
+};
+
+function getFunctionSignature(fn) {
+  if (typeof fn !== "function") {
+    throw new TypeError("Expected a function");
+  }
+
+  const fnString = fn.toString().trim();
+  let name = fn.name || "anonymous";
+  let params = "";
+
+  // Match function parameters
+  const paramMatch = fnString.match(/\(([^)]*)\)/);
+  if (paramMatch) {
+    params = paramMatch[1].trim();
+  } else {
+    // Handle arrow functions without parentheses
+    const arrowMatch = fnString.match(/^(?:\S+\s+)?(\w+)?\s*=?\s*(?:async\s*)?\(?([^)=]*)\)?\s*=>/);
+    if (arrowMatch) {
+      name = name || arrowMatch[1] || "anonymous";
+      params = arrowMatch[2].trim();
+    }
+  }
+
+  return `${name}(${params})`;
+}
+

package/lib/card.js

@@ -8,6 +8,7 @@ const _isEmpty = require('lodash.isempty')
 const _get = require('lodash.get')
 const eol = require('eol')
 const allEmoji = require('markdown-it-emoji/lib/data/full.json')
+const { getFunctionSignature } = require('./adapters/parsers/function-parser')
 
 const { removeMD } = require('./adapters/markdown')
 
@@ -190,7 +191,7 @@ module.exports = function newCard(task, _project, dontParse) {
       const keys = Object.keys(data).map((key) => {
         const value = data[key]
         if (_isFunction(value)) {
-          key = key + '()'
+          key = getFunctionSignature(value)
         }
         return key
       })
@@ -237,7 +238,8 @@ module.exports = function newCard(task, _project, dontParse) {
     }
 
     format(content, mustache) {
-      const data = this.data
+      const projectData = project ? { ...project.data } : {}
+      const data = { ...this.data, ...projectData }
 
       const opts = { interpolate: /(?<![`\\])\${([\s\S]+?)}/g }
 

package/lib/config.js

@@ -71,8 +71,10 @@ class Config {
   }
 
   getDoingList() {
-    const lists = _cloneDeep(this.lists).reverse().filter((list) => !list.filter)
-    const defaultValue = lists && lists.length ? lists[1].name : undefined
+    const lists = _cloneDeep(this.lists).filter((list) => !list.filter)
+    .reverse().map(list => list.name)
+    const defaultValue = lists ? lists.find(list => /doing|progress/i.test(list.name)) :
+      lists[1].name || '';
     return _get(this, 'settings.cards.doingList', defaultValue)
   }
 

package/lib/constants.js

@@ -14,6 +14,7 @@ flow-typed
 .hs
 .npmignore
 .obsidian
+.imdone/templates
 `
 var DEFAULT_IGNORE_EXTS = `
 *.jpg

package/lib/file.js

@@ -1192,13 +1192,13 @@ File.prototype.getCodeCommentRegex = function () {
   // #BACKLOG:-460 Allow languages to have multiple block comment styles, like html gh:13 id:5
   var lang = this.getLang()
   var symbol = lang.symbol
-  var reString = escapeRegExp(symbol) + '[^{].*$'
+  var reString = '(?<!["\'`])' + escapeRegExp(symbol) + '[^{].*$'
 
   if (lang.block) {
     var start = escapeRegExp(lang.block.start)
     var end = escapeRegExp(lang.block.end)
     //
-    reString = reString + '|' + start + '(.|[\\r\\n])*?' + end
+    reString = reString + '|(?<!["\'`])' + start + '(.|[\\r\\n])*?' + end
   }
 
   return new RegExp(reString, 'gmi')

package/lib/list.js

@@ -13,7 +13,7 @@ const uniqid = require('uniqid')
  * @param {} hidden
  * @return
  */
-function List({name, hidden, ignore, filter, id = null}) {
+function List({ name, hidden, ignore, filter, id }) {
   this.name = name;
   this.hidden = hidden || false
   this.ignore = ignore || false

package/lib/migrate-config.js

@@ -51,7 +51,8 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
       }
 
       if (config.settings.cards.defaultList === undefined) {
-        config.settings.cards.defaultList = lists ? lists[0] : ''
+        config.settings.cards.defaultList = lists ? lists.find(list => /todo/i.test(list)) :
+        lists[0] || '';
       }
 
       // archiveCompleted
@@ -107,11 +108,13 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
       }
       // Set up default doneList
       if (config.settings.cards.doneList === undefined) {
-        config.settings.cards.doneList = lists ? lists[lists.length - 1] : ''
+        config.settings.cards.doneList = lists ? lists.find(list => /done/i.test(list)) :
+        lists[lists.length - 1] || '';
       }
       // Set up default doingList
       if (config.settings.cards.doingList === undefined) {
-        config.settings.cards.doingList = lists ? lists[lists.length - 1] : ''
+        config.settings.cards.doingList = lists ? lists.find(list => /doing|progress/i.test(list)) :
+        lists[lists.length - 2] || '';
       }
       // Add name
       if (config.settings.name === undefined) {

package/lib/plugins/default-board-properties-plugin.js

@@ -0,0 +1,54 @@
+const Plugin = require('imdone-api')
+const {getIsoDateWithOffset} = require('../adapters/date-time')
+const path = require('path')
+const simpleTemplate = '\n<!--\ncreated:${timestamp}\n-->\n'
+
+module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
+  constructor(project) {
+    super(project)
+    this.templates = {}
+  }
+
+  async onBeforeBoardUpdate() {
+    this.templates = await this.getTemplates()
+  }
+
+  getBoardProperties() {
+    const self = this;
+
+    return {
+      date: `${getIsoDateWithOffset(new Date()).substring(0, 10)}`,
+      timestamp: getIsoDateWithOffset(new Date()),
+      clearFilterURL: self.getFilterURL(''),
+      templates: this.templates,
+      getFilterURL: (filter) => self.getFilterURL(filter),
+      getFilterLink: (filter) => `[Filter By: ${filter}](${self.getFilterURL(filter)})`
+    }
+  }
+
+  getFilterURL(filter) {
+    return `imdone://${this.project.path}?filter=${filter}`
+  }
+
+  async getTemplates() {
+    const { preparePathForWriting, readdir, readFile } = this.project.fileGateway
+    const templateDir = path.join(this.project.configDir, 'templates');
+    preparePathForWriting(templateDir);
+    const files = await readdir(templateDir);
+    const readFilePromises = files.map((file) => {
+      return new Promise(async (resolve) => {
+        const data = await readFile(path.join(templateDir, file), 'utf-8');
+        const templateName = file.replace('.md', '').replace(/[^a-zA-Z0-9]/g, '_');
+        resolve({ [templateName]: data });
+      });
+    });
+
+    const allTemplates = await Promise.all(readFilePromises);
+
+    const templates = allTemplates.reduce((acc, template) => {
+      return { ...acc, ...template };
+    }, {});
+
+    return { simple: simpleTemplate, ...templates };
+  }
+}

package/lib/plugins/epic-plugin.js

@@ -14,7 +14,7 @@ module.exports = class EpicPlugin extends Plugin {
     this.epics = {}
   }
 
-  onBeforeBoardUpdate() {
+  async onBeforeBoardUpdate() {
     this.epics = {}
   }
 

package/lib/plugins/extension-plugin.js

@@ -25,10 +25,21 @@ module.exports = class ExtensionPlugin extends Plugin {
       'properties',
       'card'
     )
+    this.boardPropertiesFunction = this.loadExtensionModule(
+      () => {
+        return {}
+      },
+      'properties',
+      'board'
+    )
   }
 
   getCardProperties(task) {
-    return this.cardPropertiesFunction(task, this.project)
+    return this.cardPropertiesFunction(task)
+  }
+
+  getBoardProperties() {
+    return this.boardPropertiesFunction()
   }
 
   getCardActions(task) {

package/lib/plugins/plugin-manager.js

@@ -13,7 +13,7 @@ module.exports = class PluginManager extends Emitter {
     this.project = project
     this.defaultPlugins = [
       './persist-tags-plugin',
-      './default-card-properties-plugin',
+      './default-board-properties-plugin',
       './default-board-actions-plugin',
       './archive-plugin',
       './epic-plugin', 
@@ -229,7 +229,7 @@ module.exports = class PluginManager extends Emitter {
   }
 
   pluginError(method, pluginInstance, error) {
-    console.error(
+    console.warn(
       `Plugin: ${this.getPluginName(
         pluginInstance
       )} threw an error on ${method}: `,
@@ -239,7 +239,7 @@ module.exports = class PluginManager extends Emitter {
 
   async onBoardUpdate(lists) {
     if (!lists || lists.length == 0) return
-    this.eachPluginAsync(async ({ pluginInstance }) => {
+    await this.eachPluginAsync(async ({ pluginInstance }) => {
       // const timeLabel = `${this.getPluginName(pluginInstance)} onBoardUpdate time`
       // console.time(timeLabel)
       try {
@@ -252,10 +252,10 @@ module.exports = class PluginManager extends Emitter {
     return lists
   }
 
-  onBeforeBoardUpdate() {
-    this.eachPlugin(({ pluginInstance }) => {
+  async onBeforeBoardUpdate() {
+    await this.eachPluginAsync(async ({ pluginInstance }) => {
       try {
-        pluginInstance.onBeforeBoardUpdate()
+        await pluginInstance.onBeforeBoardUpdate()
       } catch (e) {
         this.pluginError('onBeforeBoardUpdate', pluginInstance, e)
       }
@@ -320,6 +320,19 @@ module.exports = class PluginManager extends Emitter {
     return cardProps
   }
 
+  getBoardProperties() {
+    let boardProps = {}
+    this.eachPlugin(({ pluginInstance }) => {
+      try {
+        const pluginProps = pluginInstance.getBoardProperties ? pluginInstance.getBoardProperties() : {}
+        boardProps = { ...boardProps, ...pluginProps }
+      } catch (e) {
+        this.pluginError('getBoardProperties', pluginInstance, e)
+      }
+    })
+    return boardProps
+  }
+
   getCardActions(task) {
     let cardLinks = []
     this.eachPlugin(({ pluginInstance }) => {

package/lib/project.js

@@ -3,7 +3,7 @@ const PluginManager = require('./plugins/plugin-manager')
 const Repository = require('./repository')
 const _cloneDeep = require('lodash.clonedeep')
 const newCard = require('./card')
-const { JOURNAL_TYPE } = require('./constants')
+const { JOURNAL_TYPE, CONFIG_DIR } = require('./constants')
 const _path = require('path')
 const moment = require('moment')
 const { getIsoDateWithOffset } = require('./adapters/date-time')
@@ -11,11 +11,13 @@ const fileGateway = require('./adapters/file-gateway')
 const matter = require('gray-matter')
 const _isObject = require('lodash.isobject')
 const _isString = require('lodash.isstring')
+const _isFunction = require('lodash.isfunction')
 const exec = require('child_process').exec
 const fastSort = require('fast-sort/dist/sort.js')
 const Task = require('./task')
 const eol = require('eol')
 const { renderMarkdown, extractWikilinkTopics } = require('./adapters/markdown')
+const { getFunctionSignature } = require('./adapters/parsers/function-parser')
 
 function calculateTotals(lists) {
   const totals = {}
@@ -97,6 +99,28 @@ module.exports = class WorkerProject extends Project {
     return { path: this.path }
   }
 
+  getListsForImdoneJSON(totals) {
+    return this.allLists.map((list) => {
+      list = { ...list }
+      list.tasks = list.tasks.map((card, index) => {
+        card.interpretedContent = ''
+        card.totals = totals
+        card.index = index
+        return card
+      })
+      return list
+    })
+  }
+
+  getInitializedCards(allLists, totals) {
+    return allLists
+    .map((list) => list.tasks)
+    .flat()
+    .map(
+      (card) => card.init(totals)
+    )
+  }
+
   async toImdoneJSON() {
     this.pluginManager.initDevMode()
     console.time('toJSON time')
@@ -106,26 +130,17 @@ module.exports = class WorkerProject extends Project {
         populateFiltered: true,
       })
     )
-    let allLists = this.allLists
-    allLists = allLists.map((list) => {
-      list.tasks = list.tasks.map((card, index) => {
-        card.interpretedContent = ''
-        card.totals = totals
-        card.index = index
-        return card
-      })
-      return list
-    })
+    const allLists = this.getListsForImdoneJSON(totals)
 
     console.time('plugin onBeforeBoardUpdate')
-    this.pluginManager.onBeforeBoardUpdate()
+    await this.pluginManager.onBeforeBoardUpdate()
     console.timeEnd('plugin onBeforeBoardUpdate')
 
+    const data = this.data = this.pluginManager.getBoardProperties()
+    const dataKeys = this.dataKays = this.getDataKeys(data)
+
     console.time('card init')
-    const cards = allLists
-      .map((list) => list.tasks)
-      .flat()
-      .map((card) => card.init(totals))
+    const cards = this.getInitializedCards(allLists, totals)
     console.timeEnd('card init')
 
     console.time('plugin onBoardUpdate')
@@ -140,6 +155,7 @@ module.exports = class WorkerProject extends Project {
       tasks: this.getCards(this.filter, cards),
       populateFiltered: true,
     })
+
     console.timeEnd('toJSON time')
     return {
       path: this.path,
@@ -156,6 +172,8 @@ module.exports = class WorkerProject extends Project {
       defaultFilter: this.defaultFilter,
       actions: this.boardActions,
       plugins: this.pluginManager.getPlugins(),
+      data,
+      dataKeys,
       queryProps: this.getQueryProps(cards),
     }
   }
@@ -171,6 +189,10 @@ module.exports = class WorkerProject extends Project {
     if (this.pluginManager) this.pluginManager.destroyPlugins()
   }
 
+  get configDir() {
+    return _path.join(this.path, CONFIG_DIR)
+  }
+
   get allTopics() {
     return [...this.repo.allTopics]
   }
@@ -209,6 +231,23 @@ module.exports = class WorkerProject extends Project {
     return this._updatedAt
   }
 
+  getDataKeys(data) {
+    const keys = Object.keys(data).map((key) => {
+      const value = data[key]
+      if (_isFunction(value)) {
+        key = getFunctionSignature(value)
+      }
+      return key
+    })
+    keys.forEach((key) => {
+      const value = data[key]
+      if (_isObject(value) && !Array.isArray(value)) {
+        keys.push(...Object.keys(value).map((k) => `${key}.${k}`))
+      }
+    })
+    return keys
+  }
+
   removeList(list) {
     this.repo.removeList(list)
   }
@@ -218,18 +257,18 @@ module.exports = class WorkerProject extends Project {
     return Repository.getTasksByList(this.repo, tasks, true, populateFiltered)
   } 
   
-  getTaskQueryProps(task) {
+  getTaskQueryProps(props) {
     const queryProps = []
-    if (task) {
+    if (props) {
       // add all properties of the task to the queryProps array
-      Object.keys(task).forEach((key) => {
+      Object.keys(props).forEach((key) => {
         if (key === 'data') return
         if (queryProps.includes(key)) return
         
         queryProps.push(key)
         
-        if (_isObject(task[key])) {
-          Object.keys(task[key]).forEach((subKey) => {
+        if (_isObject(props[key])) {
+          Object.keys(props[key]).forEach((subKey) => {
             if (!queryProps.includes(`${key}.${subKey}`))
               queryProps.push(`${key}.${subKey}`)
           })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.53.7",
+  "version": "1.53.9",
   "description": "imdone-core",
   "main": "index.js",
   "scripts": {
@@ -57,7 +57,7 @@
     "find-up": "^5.0.0",
     "gray-matter": "^4.0.2",
     "ignore": "^5.2.0",
-    "imdone-api": "^1.52.2",
+    "imdone-api": "^1.53.0",
     "isbinaryfile": "^3.0.2",
     "js-yaml": "^3.14.1",
     "json-fns": "^1.0.0",

package/lib/plugins/default-card-properties-plugin.js

@@ -1,25 +0,0 @@
-const Plugin = require('imdone-api')
-const {getIsoDateWithOffset} = require('../adapters/date-time')
-
-module.exports = class DefaultCardPropertiesPlugin extends Plugin {
-  constructor(project) {
-    super(project)
-  }
-
-  getCardProperties() {
-    const self = this;
-
-    return {
-      date: `${getIsoDateWithOffset(new Date()).substring(0, 10)}`,
-      timestamp: getIsoDateWithOffset(new Date()),
-      clearFilterURL: self.getFilterURL(''),
-      getFilterURL: (filter) => self.getFilterURL(filter),
-      getFilterLink: (filter) => `[Filter By: ${filter}](${self.getFilterURL(filter)})`
-    }
-  }
-
-  getFilterURL(filter) {
-    return `imdone://${this.project.path}?filter=${filter}`
-  }
-  
-}