imdone-core 1.54.10 → 2.0.1

package/lib/card.js

@@ -1,21 +1,23 @@
-const Task = require('./task')
-const _path = require('path')
-const template = require('lodash.template')
-const _pick = require('lodash.pick')
-const _isFunction = require('lodash.isfunction')
-const _isObject = require('lodash.isobject')
-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 { format, encodeMarkdownLinks } = require('./adapters/parsers/content-transformer')
-const { removeMD } = require('./adapters/markdown')
+import { Task } from './task.js'
+import _path from 'path'
+import _pick from 'lodash.pick'
+import _isFunction from 'lodash.isfunction'
+import _isObject from 'lodash.isobject'
+import _isEmpty from 'lodash.isempty'
+import eol from 'eol'
+import { getFunctionSignature } from './adapters/parsers/function-parser.js'
+import { format, encodeMarkdownLinks, interpolate } from './adapters/parsers/content-transformer.js'
+import { removeMD } from './adapters/markdown.js'
+import { createRequire } from 'node:module';
+import { logger } from './adapters/logger.js'
+
+const require = createRequire(import.meta.url);
+export const allEmoji = require("markdown-it-emoji/lib/data/full.json")
 
 const CONTENT_TOKEN = '__CONTENT__'
 const lf = String(eol.lf)
 
-module.exports = function newCard(task, _project, dontParse) {
+export function newCard(task, _project, dontParse) {
   const project = _project
   const pluginManager = _project && _project.pluginManager
 
@@ -68,14 +70,14 @@ module.exports = function newCard(task, _project, dontParse) {
     }
 
     initProps() {
-      const props = _get(this.settings, 'cards.props', {}) || {}
+      const props = this?.settings?.cards?.props ?? {}
       this.props = this.frontMatter.props
         ? { ...props, ...this.frontMatter.props }
         : { ...props }
     }
 
     initComputed() {
-      const computed = _get(this.settings, 'cards.computed', {}) || {}
+      const computed = this?.settings?.cards?.computed ?? {}
       this.computed = this.frontMatter.computed
         ? { ...computed, ...this.frontMatter.computed }
         : { ...computed }
@@ -92,11 +94,11 @@ module.exports = function newCard(task, _project, dontParse) {
     }
 
     get relPath() {
-      return this.source ? this.source.path : null
+      return this.source ? this.source.path : undefined
     }
 
     get fullPath() {
-      return this.source ? _path.join(project.path, this.source.path) : null
+      return this.source ? _path.join(project.path, this.source.path) : undefined
     }
 
     get defaultData() {
@@ -152,7 +154,7 @@ module.exports = function newCard(task, _project, dontParse) {
               // Call the computed function for a value
               computedValue = value.call(computedProps)
             } catch (e) {
-              console.info(
+              logger.info(
                 `Unable to compute key: ${key} with value: ${computedValue}`,
                 e.message
               )
@@ -160,9 +162,9 @@ module.exports = function newCard(task, _project, dontParse) {
           } else {
             try {
               // Use template for the computed value
-              computedValue = template(value)(computedProps)
+              computedValue = interpolate(value, computedProps, { tags: ['${', '}'] })
             } catch (e) {
-              console.info(
+              logger.info(
                 `Unable to compute key: ${key} with value: ${computedValue}`,
                 e.message
               )
@@ -171,7 +173,7 @@ module.exports = function newCard(task, _project, dontParse) {
           computed[key] = computedValue
         }
       } catch (e) {
-        console.error(e)
+        logger.error(e)
       }
 
       const pluginData = pluginManager
@@ -234,13 +236,10 @@ module.exports = function newCard(task, _project, dontParse) {
     }
 
     getCardMarkdown() {
-      // - eliminate <!--[ ]--> wrappers
       let taskMD = this.interpretedContent
         .replace(/%%[\s\S]*?%%/g, '')
         .replace(/<\!--\s*?-->/gs, '')
         .trim()
-      // taskMD = this.replaceImagePaths(taskMD)
-      // - Split on eol and append lines until visible line count equals lines
       const displayContent = []
       const rawContent = []
       const mdArray = eol.split(taskMD)
@@ -263,7 +262,7 @@ module.exports = function newCard(task, _project, dontParse) {
     getHtml(content) {
       const html = project.renderMarkdown(content, this.fullPath)
       const mdArray = eol.split(content)
-      let truncHtml = null
+      let truncHtml
       if (mdArray.length > this.truncLines) {
         mdArray.length = this.truncLines
         truncHtml = project.renderMarkdown(mdArray.join(eol.lf), this.fullPath)

package/lib/checksum.js

@@ -0,0 +1,22 @@
+import { createHash } from 'crypto';
+import { readFile } from 'fs/promises';
+
+/**
+ * Compute a checksum for a given string or file.
+ * @param {string} input - The string or file path to hash.
+ * @param {string} algorithm - The hash algorithm to use (default: 'sha1').
+ * @param {boolean} isFile - Whether the input is a file path.
+ * @returns {Promise<string>} The computed checksum.
+ */
+export async function computeChecksum(input, algorithm = 'sha1', isFile = false) {
+  const hash = createHash(algorithm);
+
+  if (isFile) {
+    const fileBuffer = await readFile(input);
+    hash.update(fileBuffer);
+  } else {
+    hash.update(input);
+  }
+
+  return hash.digest('hex');
+}

package/lib/cli.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+
+// DOING Modernize cli to esm
+// <!--
+// order:-40
+// -->
+import { Command } from 'commander';
+import ora from 'ora';
+import chalk from 'chalk';
+import * as fs from 'node:fs/promises'; // Use fs/promises for async read
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import { executeBoardAction, listAvailableActions } from './usecases/actions.js';
+import { logger } from './adapters/logger.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function getPackageJson() {
+  try {
+    const data = await fs.readFile(path.join(__dirname, '..', 'package.json'), 'utf8');
+    return JSON.parse(data);
+  } catch (error) {
+    logger.error("Error reading package.json:", error);
+    return null;
+  }
+}
+
+const _package = await getPackageJson();
+// const { log } = hideLogs();
+const spinner = ora('Loading unicorns');
+
+setTimeout(() => {
+  spinner.color = 'yellow';
+  spinner.text = 'Loading rainbows';
+}, 1000);
+
+function actionCancelled() {
+  logger.log(chalk.bgRed('Action canceled'));
+}
+
+const program = new Command();
+program.version(_package.version, '-v, --version', 'output the current version');
+
+const actionCmd = program.command('action')
+  .description('Manage board actions');
+
+actionCmd
+  .command('run <title>')
+  .option('-p, --plugin <plugin>', 'Plugin name', 'ExtensionPlugin')
+  .option('-t, --task <task>', 'Task filePath:line')
+  .option('-w, --working-dir <workingDir>', 'Working directory', '.')
+  .option('-c, --config <configPath>', 'Config file path', path.join('.imdone', 'config.yml'))
+  .description('Run a board action')
+  .action(async (title, {
+    plugin = 'ExtensionPlugin',
+    task, 
+    workingDir, 
+    configPath
+  }) => {
+    spinner.start();
+    const action = { plugin, title };
+    const [filePath, line] = task ? task.split(':') : [];
+    // DOING: Move this CLI command to a usecase
+    try {
+      await executeBoardAction({
+        projectPath: workingDir,
+        configPath,
+        task: filePath && line && { filePath, line },
+        action
+      });
+    } catch (e) {
+      logger.error(e);
+      actionCancelled();
+    } finally {
+      spinner.stop();
+      process.exit(0);
+    }
+  });
+
+actionCmd
+  .command('list')
+  .option('-p, --plugin <plugin>', 'Plugin name', 'ExtensionPlugin')
+  .option('-w, --working-dir <workingDir>', 'Working directory')
+  .option('-c, --config <configPath>', 'Config file path')
+  .description('List available actions')
+  .action(async ({ workingDir = path.resolve('.'), configPath, plugin}) => {
+    spinner.start();
+    try {
+      await listAvailableActions(workingDir, configPath, plugin);
+    } catch (e) {
+    logger.error(e);
+    actionCancelled();
+    } finally {
+      spinner.stop();
+      process.exit(0);
+    }
+  });
+
+program.parse();
+
+function hideLogs() {
+  const log = logger.log;
+  const info = logger.info;
+  const warn = logger.warn;
+  const logQueue = { warn: [], info: [], log: [] };
+  if (!process.env.DEBUG) {
+    Object.keys(logQueue).forEach((key) => {
+      console[key] = function(...args) {
+        logQueue[key].push(args);
+      };
+    });
+  }
+  return { log, info, warn, logQueue };
+}

package/lib/config.js

@@ -1,13 +1,3 @@
-'use strict'
-
-const _cloneDeep = require('lodash.clonedeep')
-const _assign = require('lodash.assign')
-const _get = require('lodash.get')
-const { 
-  JOURNAL_TYPE, 
-  DEFAULT_CONFIG,
-} = require('./constants')
-
 /**
  * Description
  * @method Config
@@ -18,16 +8,75 @@ const COLON = ':'
 const DOUBLE_COLON = '::'
 const META_SEPS = [COLON, DOUBLE_COLON]
 
-class Config {
+const JOURNAL_TYPE = {
+  SINGLE_FILE: 'Single File',
+  FOLDER: 'Folder',
+  NEW_FILE: 'New File',
+}
+
+const DEFAULT_CONFIG = {
+  keepEmptyPriority: false,
+  code: {
+    include_lists: [
+      'TODO',
+      'DOING',
+      'DONE',
+      'PLANNING',
+      'FIXME',
+      'ARCHIVE',
+      'HACK',
+      'CHANGED',
+      'XXX',
+      'IDEA',
+      'NOTE',
+      'REVIEW',
+    ],
+  },
+  lists: [
+    {
+      hidden: false,
+      name: 'TODO',
+    },
+    {
+      hidden: false,
+      name: 'DOING',
+    },
+    {
+      hidden: false,
+      name: 'DONE',
+    },
+  ],
+}
+
+export class Config {
   constructor(opts) {
-    _assign(this, opts)
+    Object.assign(this, opts)
     if (!this.settings) this.settings = {}
     if (!this.settings.views) this.settings.views = []
     if (!this.settings.cards) this.settings.cards = {}
   }
 
+  static DEFAULT_CONFIG = DEFAULT_CONFIG
+  static JOURNAL_TYPE = JOURNAL_TYPE
+  
+  static newDefaultConfig(config = {}) {
+    return new Config(
+      {
+        ...DEFAULT_CONFIG, 
+        lists: [
+          ...DEFAULT_CONFIG.lists
+        ],
+        ...config
+      }
+    )
+  } 
+
+  get cards () {
+    return this?.settings?.cards
+  }
+
   get defaultFilter() {
-    return _get(this, 'settings.defaultFilter', '')
+    return this?.settings?.defaultFilter ?? ''
   }
 
   set defaultFilter(filter) {
@@ -35,7 +84,7 @@ class Config {
   }
 
   get name() {
-    _get(this, 'settings.name', '')
+    return this?.settings?.name ?? ''
   }
 
   set name(name) {
@@ -43,71 +92,69 @@ class Config {
   }
 
   includeList(name) {
-    return (
-      this.code &&
-      this.code.include_lists &&
-      this.code.include_lists.slice &&
-      this.code.include_lists.includes(name)
-    )
+    return this?.code?.include_lists?.includes(name)
   }
 
   ignoreList(name) {
-    const list = this.lists.find((list) => name === list.name)
+    const list = this?.lists?.find((list) => name === list.name)
     return !list || (list && list.ignore)
   }
 
   listExists(name) {
-    return this.lists.findIndex((list) => list.name === name) > -1
+    return this?.lists?.findIndex((list) => list.name === name) > -1
   }
 
   getDefaultList() {
-    return _get(this, 'settings.cards.defaultList', this.lists[0].name)
+    return  this?.cards?.defaultList ?? this.lists[0].name
   }
 
   getDoneList() {
-    const lists = _cloneDeep(this.lists).reverse().filter((list) => !list.filter)
-    const defaultValue = lists && lists.length ? lists[0].name : undefined
-    return _get(this, 'settings.cards.doneList', defaultValue)
-  }
+    const lists = structuredClone(this.lists).reverse().filter((list) => !list.filter)
+    return this?.cards?.doneList
+    || lists?.find(list => /dene|completed|finished/i.test(list?.name ?? ''))?.name 
+    || lists[0]?.name
+    || ''
+}
 
   getDoingList() {
-    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)
+    const lists = structuredClone(this.lists).filter((list) => !list.filter)
+    .reverse()
+    return this?.cards?.doingList 
+      || lists?.find(list => /doing|progress/i.test(list?.name ?? ''))?.name 
+      || lists[1]?.name
+      || ''
   }
 
   isAddNewCardsToTop() {
-    return _get(this, 'settings.cards.addNewCardsToTop', false)
+    return this?.cards?.addNewCardsToTop ?? false
   }
 
   getNewCardSyntax() {
-    return _get(this, 'settings.newCardSyntax', 'MARKDOWN')
+    return this?.settings?.newCardSyntax?? 'MARKDOWN'
   }
 
   isMetaNewLine() {
-    return _get(this, 'settings.cards.metaNewLine', false)
+    return this?.cards?.metaNewLine ?? false
   }
 
   getTagPrefix() {
-    return _get(this, 'settings.cards.tagPrefix', '+')
+    return this?.cards?.tagPrefix ?? '+'
   }
 
   getTaskPrefix() {
-    return _get(this, 'settings.cards.taskPrefix', '')
+    return this?.cards?.taskPrefix ?? '##'
   }
 
   isAddCheckBoxTasks() {
-    return _get(this, 'settings.cards.addCheckBoxTasks', false)
+    return this?.cards?.addCheckBoxTasks ?? false
   }
 
   isAddCompletedMeta() {
-    return _get(this, 'settings.cards.addCompletedMeta', false)
+    return this?.cards?.addCompletedMeta ?? false
   }
 
   get customCardTerminator() {
-    return _get(this, 'settings.cards.customCardTerminator')
+    return this?.cards?.customCardTerminator
   }
 
   set customCardTerminator(terminator) {
@@ -115,27 +162,27 @@ class Config {
   }
 
   get markdownOnly() {
-    return this.settings.markdownOnly
+    return this?.settings?.markdownOnly
   }
 
   get views() {
-    return this.settings.views
+    return this?.settings?.views
   }
 
   get appendNewCardsTo() {
-    return _get(this, 'settings.appendNewCardsTo', false)
+    return this?.settings?.appendNewCardsTo ?? false
   }
 
   get ignoreFrontMatter() {
-    return _get(this, 'settings.ignoreFrontMatter', false)
+    return this?.settings?.ignoreFrontMatter ?? false
   }
 
   get ignoreFrontMatterTags() {
-    return _get(this, 'settings.ignoreFrontMatterTags', false)
+    return this?.settings?.ignoreFrontMatterTags ?? false
   }
 
   get journalPath() {
-    return _get(this, 'settings.journalPath', '')
+    return this?.settings?.journalPath ?? ''
   }
 
   set journalPath(path) {
@@ -143,52 +190,52 @@ class Config {
   }
 
   get journalTemplate() {
-    const template = _get(this, 'settings.journalTemplate', '')
+    const template = this?.settings?.journalTemplate ?? ''
     return template === 'null' ? '' : template || ''
   }
 
   get journalType() {
-    return _get(this, 'settings.journalType', JOURNAL_TYPE.FOLDER)
+    return this?.settings?.journalType ?? JOURNAL_TYPE.FOLDER
   }
 
   get journalFilePrefix() {
-    return _get(this, 'settings.journalFilePrefix', '')
+    return this?.settings?.journalFilePrefix ?? ''
   }
 
   get journalFileSuffix() {
-    return _get(this, 'settings.journalFileSuffix', '')
+    return this?.settings?.journalFileSuffix ?? ''
   }
 
   get replaceSpacesWith() {
-    return _get(this, 'settings.replaceSpacesWith')
+    return this?.settings?.replaceSpacesWith
   }
 
   get devMode() {
-    return _get(this, 'settings.plugins.devMode', false)
+    return this?.settings?.plugins?.devMode ?? false
   }
 
   get plugins() {
-    return _get(this, 'settings.plugins', { devMode: false })
+    return this?.settings?.plugins ?? { devMode: this.devMode }
   }
 
   get orderMeta() {
-    return _get(this, 'settings.cards.orderMeta', false)
+    return this?.cards?.orderMeta ?? false
   }
 
   get maxLines() {
-    return _get(this, 'settings.cards.maxLines', 1)
+    return this?.cards?.maxLines ?? 1
   }
 
   get archiveFolder() {
-    return _get(this, 'settings.cards.archiveFolder', '')
+    return this?.cards?.archiveFolder ?? 'archive'
   }
 
   get archiveCompleted() {
-    return _get(this, 'settings.cards.archiveCompleted')
+    return this?.cards?.archiveCompleted ?? false
   }
 
   get tokenPrefix() {
-    return _get(this, 'settings.cards.tokenPrefix', '#')
+    return this?.cards?.tokenPrefix ?? '#'
   }
 
   get doneList() {
@@ -196,19 +243,7 @@ class Config {
   }
 
   getMetaSep() {
-    const metaSep = _get(this, 'settings.cards.metaSep', COLON)
+    const metaSep = this?.cards?.metaSep ?? COLON
     return META_SEPS.includes(metaSep) ? metaSep : COLON
   }
 }
-
-Config.newDefaultConfig = (config = {}) => new Config(
-  {
-    ...DEFAULT_CONFIG, 
-    lists: [
-      ...DEFAULT_CONFIG.lists
-    ],
-    ...config
-  }
-)
-
-module.exports = Config

package/lib/constants.js

@@ -1,7 +1,7 @@
-'use strict'
-var path = require('path')
+import path from 'path'
+import { Config } from './config.js'
 
-var DEFAULT_IGNORE_DIRS = `
+var DEFAULT_IGNORE_PATHS = `
 node_modules
 bower_components
 target
@@ -15,6 +15,7 @@ flow-typed
 .npmignore
 .obsidian
 .imdone/templates
+.imdone/tags.yml
 `
 var DEFAULT_IGNORE_EXTS = `
 *.jpg
@@ -32,27 +33,29 @@ var DEFAULT_IGNORE_EXTS = `
 *.pot*
 `
 
-var DEFAULT_IGNORE = `
-${DEFAULT_IGNORE_DIRS}
+const DEFAULT_IGNORE = `
+${DEFAULT_IGNORE_PATHS}
 ${DEFAULT_IGNORE_EXTS}
 `
-var CONFIG_DIR = '.imdone'
-module.exports = {
-  JOURNAL_TYPE: {
-    SINGLE_FILE: 'Single File',
-    FOLDER: 'Folder',
-    NEW_FILE: 'New File',
-  },
+const CONFIG_DIR = '.imdone'
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json')
+const CONFIG_FILE_YML = path.join(CONFIG_DIR, 'config.yml')
+const SORT_FILE = path.join(CONFIG_DIR, 'sort.json')
+const TEMPLATES_DIR = path.join(CONFIG_DIR, 'templates')
+const { JOURNAL_TYPE, DEFAULT_CONFIG } = Config
+
+export const constants = {
+  JOURNAL_TYPE,
   ASYNC_LIMIT: 512,
   CONFIG_DIR,
-  CONFIG_FILE: path.join(CONFIG_DIR, 'config.json'),
-  CONFIG_FILE_YML: path.join(CONFIG_DIR, 'config.yml'),
-  SORT_FILE: path.join(CONFIG_DIR, 'sort.json'),
-  TEMPLATES_DIR: path.join(CONFIG_DIR, 'templates'),
+  CONFIG_FILE,
+  CONFIG_FILE_YML,
+  SORT_FILE,
+  TEMPLATES_DIR,
   IGNORE_FILE: '.imdoneignore',
   DEFAULT_FILE_PATTERN: '^(readme\\.md|home\\.md|readme\\.w+|home\\.w+)$',
   DEFAULT_IGNORE,
-  DEFAULT_IGNORE_DIRS,
+  DEFAULT_IGNORE_PATHS,
   DEFAULT_IGNORE_EXTS,
   ERRORS: {
     NOT_A_FILE: 'file must be of type File',
@@ -61,37 +64,5 @@ module.exports = {
     LIST_NOT_FOUND: 'List not found',
     TASK_NOT_FOUND: 'Task not found',
   },
-  DEFAULT_CONFIG: {
-    keepEmptyPriority: false,
-    code: {
-      include_lists: [
-        'TODO',
-        'DOING',
-        'DONE',
-        'PLANNING',
-        'FIXME',
-        'ARCHIVE',
-        'HACK',
-        'CHANGED',
-        'XXX',
-        'IDEA',
-        'NOTE',
-        'REVIEW',
-      ],
-    },
-    lists: [
-      {
-        hidden: false,
-        name: 'TODO',
-      },
-      {
-        hidden: false,
-        name: 'DOING',
-      },
-      {
-        hidden: false,
-        name: 'DONE',
-      },
-    ],
-  },
+  DEFAULT_CONFIG,
 }