imdone-core 2.0.0 → 2.0.2

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

@@ -0,0 +1,101 @@
+import Plugin from 'imdone-api'
+import { getIsoDateWithOffset } from '../adapters/date-time.js'
+import path from 'path'
+
+const simpleTemplate = '\n<!--\ncreated:${timestamp}\n-->\n'
+
+const codeSpan = (value) => '`' + value + '`';
+const codeBlock = (value, language = '') => '```' + language + '\n' + value + '\n```';
+
+function flattenObject(object) {
+  return Object.keys(object).reduce((acc, key) => {
+    return { ...acc, [`template_${key}`]: object[key] };
+  }, {});
+}
+
+export default class DefaultBoardPropertiesPlugin extends Plugin {
+  constructor(project) {
+    super(project)
+    this.templates = {}
+  }
+
+  async onBeforeBoardUpdate() {
+    this.templates = await this.getTemplates()
+  }
+
+  async getBoardProperties() {
+    const templates = flattenObject(this.templates);
+    const clearFilterURL = this.getFilterURL('');
+    const getFilterURL = (filter) => this.getFilterURL(filter);
+    const getFilterLink = (filter) => `[Filter By: ${filter}](${this.getFilterURL(filter)})`;
+    // TODO Make board properties self documenting
+    // <!--
+    // #imdone-1.53.16
+    // #feature
+    // created:2025-02-14T16:54:22-05:00
+    // order:-185
+    // -->
+    // [Feature Description]
+    // ## :ballot_box_with_check: Tasks
+    // - [ ] Add tasks here
+    // ## :white_check_mark: DoD
+    // - [ ] Code complete (No Tech Debt)
+    // - [ ] Update tests
+    // - [ ] Automate what's working
+    // - [ ] Update tutorial project
+    // - [ ] Update documentation
+    // - [ ] Run like a new user and make the experience better
+    // - [ ] Make sure the first card is expanded by default or in view mode
+    // - [ ] Make sure global and default settings isn't modified when opened for the first time
+    return {
+      date: `${getIsoDateWithOffset(new Date()).substring(0, 10)}`,
+      timestamp: getIsoDateWithOffset(new Date()),
+      codeSpan,
+      codeBlock,  
+      clearFilterURL,
+      getFilterURL,
+      getFilterLink,
+      ...templates
+    }
+  }
+
+  getFilterURL(filter) {
+    filter = filter.replace(/\(/g, '%28').replace(/\)/g, '%29');
+    return encodeURI(`imdone://${this.project.path}?filter=${filter}`)
+  }
+
+
+  async getTemplates() {
+    const { preparePathForWriting, readdir, readFile, stat, exists } = this.project.fileGateway;
+    const templateDir = path.join(this.project.configDir, 'templates');
+    const githubDir = path.join(this.project.path, '.github');
+
+    await preparePathForWriting(templateDir, true);
+
+    const readMarkdownFiles = async (dir, prefix = '') => {
+      const files = await readdir(dir);
+      const readFilePromises = files.map(async (file) => {
+        const filePath = path.join(dir, file);
+        const fileStat = await stat(filePath);
+        if (fileStat && fileStat.isDirectory()) {
+          return readMarkdownFiles(filePath, `${prefix}${file}_`);
+        } else if (file.endsWith('.md')) {
+          const data = await readFile(filePath, 'utf-8');
+          const templateName = `${prefix}${file.replace('.md', '').replace(/[^a-zA-Z0-9]/g, '_')}`;
+          return { [templateName]: data };
+        }
+        return {};
+      });
+
+      const allTemplates = await Promise.all(readFilePromises);
+      return allTemplates.reduce((acc, template) => ({ ...acc, ...template }), {});
+    };
+
+    const templatesFromTemplateDir = await readMarkdownFiles(templateDir);
+    const templatesFromGithubDir = await exists(githubDir)
+      ? await readMarkdownFiles(githubDir, 'github_')
+      : {};
+
+    return { simple: simpleTemplate, ...templatesFromTemplateDir, ...templatesFromGithubDir };
+  }
+}

package/lib/plugins/default-plugins.js

@@ -0,0 +1,7 @@
+export * as ArchivePlugin from './archive-plugin.js'
+export * as DefaultBoardActionsPlugin from './default-board-actions-plugin.js'
+export * as DefaultBoardPropertiesPlugin from './default-board-properties-plugin.js'
+export * as EpicPlugin from './epic-plugin.js'
+export * as PersistTagsPlugin from './persist-tags-plugin.js'
+export * as ExtensionPlugin from './extension-plugin.js'
+

package/lib/plugins/epic-plugin.js

@@ -0,0 +1,177 @@
+import Plugin from 'imdone-api'
+import { logger } from '../adapters/logger.js'
+
+function getIsEpicMeta(task) {
+  return task.allMeta && task.allMeta['is-epic'] && task.allMeta['is-epic'][0]
+}
+
+function getEpicMeta(task) {
+  return task.allMeta && task.allMeta['epic'] && task.allMeta['epic'][0]
+}
+
+export default class EpicPlugin extends Plugin {
+  constructor(project) {
+    super(project)
+    this.epics = {}
+  }
+
+  async onBeforeBoardUpdate() {
+    this.epics = {}
+  }
+
+  onBoardUpdate(lists) {
+    // this html is getting initialized before onBoardUpdate
+    logger.log(
+      `${this.project.name} epics found:`,
+      Object.keys(this.epics).length
+    )
+    logger.time(`${this.project.name} Epic updates`)
+    this.updateCardMD(lists)
+    logger.timeEnd(`${this.project.name} Epic updates`)
+  }
+
+  onTaskUpdate(task) {
+    const isEpicMeta = getIsEpicMeta(task)
+    const epicMeta = getEpicMeta(task)
+    if (!isEpicMeta && !epicMeta) return
+
+    if (isEpicMeta && epicMeta) {
+      delete task.allMeta.epic
+      task.allMeta['is-epic'] = [epicMeta]
+      this.addEpic(epicMeta, task)
+    } else if (epicMeta) {
+      this.addEpicItem(epicMeta, task)
+    } else if (isEpicMeta) {
+      this.addEpic(isEpicMeta, task)
+    }
+  }
+
+  initEpic(name) {
+    if (!this.epics[name]) {
+      this.epics[name] = {
+        items: {},
+      }
+    }
+  }
+
+  addEpic(name, task) {
+    this.initEpic(name)
+    this.epics[name].epic = task
+  }
+
+  addEpicItem(name, task) {
+    const list = task.list
+    this.initEpic(name)
+    if (!this.getEpicItemsInList(name, list)) this.epics[name].items[list] = []
+    if (this.getEpicItemsInList(name, list).find((t) => t.id === task.id)) return
+    this.epics[name].items[list].push(task)
+  }
+
+  get epicNames() {
+    return Object.keys(this.epics)
+  }
+
+  getEpic(name) {
+    return this.epics[name].epic
+  }
+
+  getEpicItems(name) {
+    return this.epics[name].items
+  }
+
+  getEpicItemsInList(name, list) {
+    return this.epics[name].items[list]
+  }
+
+
+  getEpicLists(name) {
+    return Object.keys(this.getEpicItems(name))
+  }
+
+  isListHidden(name, lists) {
+    return lists.find((list) => list.name === name).hidden
+  }
+
+  isListIgnored(name, lists) {
+    return lists.find((list) => list.name === name).ignore
+  }
+
+  updateCardMD(lists) {
+    this.epicNames.forEach((epicId) => {
+      const epic = this.getEpic(epicId)
+      const epicLists = this.getEpicLists(epicId)
+      if (!epic) return
+      if (epicLists.length === 0) return
+      if (
+        epic.list === this.project.doneList &&
+        (this.isListHidden(epic.list, lists) ||
+          this.isListIgnored(epic.list, lists))
+      ) {
+        return
+      }
+
+      const epicText = epic.text // removeMD(epic.text)
+      const epicFilter = encodeURIComponent(
+        `(allMeta.epic="${epicId}" or allMeta.is-epic="${epicId}")`
+      )
+      const epicFilePath = encodeURI(
+        `${epic.source.repoId}/${epic.source.path}`.replace(/\\/g, '/')
+      )
+      const epicUrl = `imdone://${epicFilePath}?line=${epic.line}&filter=${epicFilter}`
+      const epicLink = `**Epic:** [${epicText}](${epicUrl})\n\n`
+
+      // Add epic link to epic tasks
+      epicLists.forEach((list) => {
+        this.getEpicItemsInList(epicId, list).forEach((task) => {
+          task.interpretedContent = epicLink + task.interpretedContent
+          task.init()
+        })
+      })
+
+      const taskList =
+        epicLists.length === 0
+          ? '*None*\n'
+          : '\n<div class="imdone-epic-items">\n\n' +
+            this.getTaskListMD(lists, epicFilter, epicUrl, epicId) +
+            '\n\n</div>\n'
+
+      if (epic.allMeta.epic && epic.allMeta.epic.includes(epicId)) {
+        const index = epic.allMeta.epic.findIndex((value) => value === epicId)
+        epic.allMeta.epic.splice(index, 1)
+      }
+      epic.interpretedContent =
+        epic.interpretedContent +
+        `\n----\n## [Epic items](${epicUrl})\n${taskList}`
+      epic.init()
+    })
+  }
+
+  getTaskListMD(lists, epicFilter, epicUrl, epicId) {
+    let content = ''
+
+    lists
+      .filter((list) => this.getEpicItemsInList(epicId, list.name))
+      .reverse()
+      .forEach((list) => {
+        const tasks = this.getEpicItemsInList(epicId, list.name)
+        const listUrl = epicUrl + encodeURIComponent(` and list=${list.name}`)
+        const listLink = `[${list.name}](${listUrl})`
+        content = content + '\n\n#### ' + listLink + '\n'
+        content += '<ul style="list-style: none;">'
+        content += tasks
+          .map((task) => {
+            const taskText = this.project.renderMarkdown(task.text, task.fullPath).replaceAll(/<p>|<\/p>/ig, '') // removeMD(task.text)
+            const checked =
+              task.list === this.project.doneList ? ' checked="true"' : ''
+            const taskFilePath = encodeURI(
+              `${task.source.repoId}/${task.source.path}`.replace(/\\/g, '/')
+            )
+            return `<li style="margin-left: 1rem; list-style: none;"><input type="checkbox" disabled="true"${checked}><a href="imdone://${taskFilePath}?line=${task.line}&filter=${epicFilter}" target="_blank">${taskText}</a></li>`
+          })
+          .join('\n')
+        content += '</ul>'
+      })
+
+    return content
+  }
+}

package/lib/plugins/extension-plugin.js

@@ -0,0 +1,94 @@
+import Plugin from 'imdone-api'
+import _path from 'path'
+import { exists } from '../adapters/file-gateway.js'
+import { createRequire } from 'node:module';
+import { logger } from '../adapters/logger.js';
+
+const require = createRequire(import.meta.url);
+const url = new URL(import.meta.url)
+const __dirname = _path.dirname(url.pathname)
+
+export default class ExtensionPlugin extends Plugin {
+  constructor(project) {
+    super(project)
+    logger.log('loading extensions')
+    this.configDir = _path.join(project.path, '.imdone')
+  }
+
+  async init() {
+    this.cardActionsFunction = await this.loadExtensionModule(
+      () => [],
+      'actions',
+      'card'
+    )
+    this.boardActionsFunction = await this.loadExtensionModule(
+      () => [],
+      'actions',
+      'board'
+    )
+    this.cardPropertiesFunction = await this.loadExtensionModule(
+      () => {
+        return {}
+      },
+      'properties',
+      'card'
+    )
+    this.boardPropertiesFunction = await this.loadExtensionModule(
+      () => {
+        return {}
+      },
+      'properties',
+      'board'
+    )
+  }
+  getCardProperties(task) {
+    return this.cardPropertiesFunction(task)
+  }
+
+  async getBoardProperties() {
+    return await this.boardPropertiesFunction()
+  }
+
+  getCardActions(task) {
+    return this.cardActionsFunction(task)
+  }
+
+  getBoardActions() {
+    return this.boardActionsFunction().map(({ title, action, keys, icon }) => ({
+      title,
+      name: title,
+      action,
+      keys,
+      icon
+    }))
+  }
+
+  getConfigPath(relativePath) {
+    return _path.resolve(_path.join(this.configDir, ...relativePath) + '.js')
+  }
+
+  async loadExtensionModule(_default, ...path) {
+    let extension = _default
+    const extensionPath = this.getConfigPath(path)
+    try {
+      await exists(extensionPath)
+      delete require.cache[extensionPath]
+      extension = require(extensionPath)
+    } catch (e) {
+      if (e.code === 'ENOENT') {
+        logger.log('No extension found at:', extensionPath)
+      } else {
+        logger.warn('Error loading extension:', e.message)
+      }
+    }
+
+    if (typeof extension !== 'function') {
+      logger.warn(
+        `${extensionPath} does not export a function. Using default empty function. ${_default.toString()}`
+      )
+      extension = _default
+    }
+
+    return extension
+  }
+}

package/lib/plugins/index.js

@@ -0,0 +1,9 @@
+export * from './archive-plugin.js';
+export * from './default-board-actions-plugin.js';
+export * from './default-board-properties-plugin.js';
+export * from './default-plugins.js';
+export * from './epic-plugin.js';
+export * from './extension-plugin.js';
+export * from './persist-tags-plugin.js';
+export * from './plugin-manager.js';
+export * from './plugin-registry.js';

package/lib/plugins/persist-tags-plugin.js

@@ -0,0 +1,14 @@
+import Plugin from 'imdone-api'
+import { save } from '../adapters/storage/tags.js'
+
+export default class PersistTagsPlugin extends Plugin {
+  
+  constructor(project) {
+    super(project)
+  }
+
+  async onBoardUpdate() {
+    await save(this.project.allTags.sort(), this.project.path)
+  }
+  
+}