imdone-core 1.54.1 → 1.54.3

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve imdone
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser (If imdone web site) [e.g. chrome, safari]
+ - Imdone Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
+
+**DoD**
+- [ ] Issue is understood
+- [ ] Fix is implemented and tested
+- [ ] Fix is deployed in the current release

package/cli.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const ora = require('ora')
+const chalk = require('chalk')
+const package = require('./package.json')
+const { createFileSystemProject } = require('./lib/project-factory.js')
+// const { log } = hideLogs()
+const spinner = ora('Loading unicorns')
+
+setTimeout(() => {
+	spinner.color = 'yellow';
+	spinner.text = 'Loading rainbows';
+}, 1000);
+
+function actionCancelled() {
+  log(chalk.bgRed('Action canceled'))
+}
+
+const mainCmd = program
+.version(package.version, '-v, --version', 'output the current version')
+
+mainCmd
+.command('action <pluginName> <actionTitle>')
+.option('-t, --task <task>', 'Task filePath:line')
+.description('Run a board action')
+.action(async function (plugin, title, options) {
+  spinner.start()
+  const action = {plugin, title}
+  const [filePath, line] = options.task ? options.task.split(':') : []
+  try {
+    const project = createFileSystemProject({path:  process.env.PWD})
+    await project.init()
+    await project.toImdoneJSON()
+    chalk.bgGreen('Project loaded')
+    const file = filePath && project.getFile(filePath)
+    const task = file && line > -1 && file.getTaskAtLine(line)
+    await project.performBoardAction(action, task)
+  } catch (e) {
+    console.error(e)
+    actionCancelled()
+  } finally {
+    spinner.stop()
+    process.exit(0)
+  }
+})
+
+
+program.parse();
+
+function hideLogs() {
+  const log = console.log
+  const info = console.info
+  const warn = console.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}
+}
+
+function actionCancelled() {
+  log(chalk.bgRed('Action canceled'))
+}

package/lib/adapters/file-gateway.js

@@ -38,6 +38,15 @@ const gateway = {
     }
   },
 
+  async stat(path, opts) {
+    try {
+      return await fs.promises.stat(path, opts)
+    }
+    catch {
+      return false
+    }
+  },
+
   readFileSync(...args) {
     console.warn('sync call')
     return fs.readFileSync.apply({}, args)

package/lib/adapters/parsers/content-transformer.js

@@ -3,6 +3,7 @@ const uniqid = require('uniqid');
 
 module.exports = {
   format,
+  encodeMarkdownLinks
 }
 
 function removeDisplayComments(description) {
@@ -59,6 +60,16 @@ function interpolate(content, data, opts) {
   return { content, hasInterpolation, errorTokens };
 }
 
+function encodeMarkdownLinks(content) {
+  return content.replace(/(?<!!)\[(.*?)\]\((.*?)( ".*?")?\)/g, (match, p1, p2, p3) => {
+    // URI encode file links
+    const title = p3 || '';
+    const encodedUrl = p2.replace(/\s/g, '%20').replace(/\)/g, '%29').replace(/\(/g, '%28');
+    const link = `[${p1}](${encodedUrl}${title})`;
+    return link.replace(/%20(".*?"\))$/, ' $1');
+  });
+}
+
 function format(content, data, mustache) {
   const opts = { interpolate: /(?<![`\\])\${([\s\S]+?)}/g };
   const errorTokens = {};

package/lib/card.js

@@ -9,7 +9,7 @@ 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 } = require('./adapters/parsers/content-transformer')
+const { format, encodeMarkdownLinks } = require('./adapters/parsers/content-transformer')
 const { removeMD } = require('./adapters/markdown')
 
 const CONTENT_TOKEN = '__CONTENT__'
@@ -218,14 +218,8 @@ module.exports = function newCard(task, _project, dontParse) {
       })
       const encodedText = encodeURIComponent(plainDescription)
       const encodedMD = encodeURIComponent(content)
-      content = content
-        .replace(CONTENT_TOKEN, encodedText)
-        .replace(/(?<!!)\[(.*?)\]\((.*?)( ".*?")?\)/g, (match, p1, p2, p3) => {
-          // URI encode file links
-          const title = p3 || ''
-          const link = `[${p1}](${p2.replace(/\s/g, '%20')}${title})`
-          return link.replace(/%20(".*?"\))$/, ' $1')
-        })
+      content = content.replace(CONTENT_TOKEN, encodedText)
+      content = encodeMarkdownLinks(content)
       return { encodedMD, encodedText, content }
     }
 

package/lib/file.js

@@ -324,7 +324,7 @@ File.prototype.transformTasks = function (config, modify) {
 
 // TODO Blank lines should be allowed in code tasks
 // <!--
-// #imdone-1.49.0
+// #imdone-1.54.0
 // #feature
 // order:-105
 // -->
@@ -338,7 +338,7 @@ File.prototype.extractCodeStyleTasks = function (config, pos, content) {
   while ((result = codeStyleRegex.exec(content)) !== null) {
     var posInContent = pos + result.index
     var line = this.getLineNumber(posInContent)
-    if (self.hasTaskAtLine(line)) continue
+    if (self.getTaskAtLine(line)) continue
     var charBeforeList = this.getContent().substring(
       posInContent - 1,
       posInContent
@@ -391,7 +391,7 @@ File.prototype.extractHashStyleTasks = function (config, pos, content) {
     if (this.isWithinCodeSpanOrBlock(result.index, content)) continue
     
     const line = this.getLineNumber(posInContent)
-    if (this.hasTaskAtLine(line)) continue
+    if (this.getTaskAtLine(line)) continue
 
     if (lang.block) {
       const blockEndPos = text.indexOf(lang.block.end)
@@ -427,7 +427,7 @@ File.prototype.extractLinkStyleTasks = function (config, pos, content) {
     const posInContent = result.index + pos + beforeLength
     if (this.isWithinCodeSpanOrBlock(result.index, content)) continue
     var line = this.getLineNumber(posInContent)
-    if (self.hasTaskAtLine(line)) continue
+    if (self.getTaskAtLine(line)) continue
     if (!config.listExists(list)) continue
     log = require('debug')('extractLinkStyleTasks')
     log('*********************************************************')
@@ -462,7 +462,7 @@ File.prototype.extractCheckboxTasks = function (config, pos, content) {
   let tasks = []
   const hasTaskAtLine = (line) => {
     return (
-      this.hasTaskAtLine(line) ||
+      this.getTaskAtLine(line) ||
       tasks.find((task) => {
         return line >= task.line && line <= task.lastLine
       })
@@ -493,7 +493,7 @@ File.prototype.extractCheckboxTasks = function (config, pos, content) {
   if (tasks) {
     const hasTaskAtLine = (line) => {
       return (
-        this.hasTaskAtLine(line) ||
+        this.getTaskAtLine(line) ||
         tasks.find((task) => {
           return line > task.line && line <= task.lastLine
         })
@@ -541,6 +541,9 @@ File.prototype.extractAndTransformTasks = function (config) {
   this.transformTasks(config)
 }
 
+// TODO Extract functions should be moved to another file
+// Only pass the needed config values to the functions
+// #imdone-1.54.0
 File.prototype.extractTasksInCodeFile = function (config) {
   var self = this
   var commentRegex = this.getCodeCommentRegex()
@@ -1002,7 +1005,7 @@ File.prototype.tasksMatch = function (config, task, line, taskText) {
   )
 }
 
-File.prototype.hasTaskAtLine = function (line) {
+File.prototype.getTaskAtLine = function (line) {
   return this.getTasks().find((task) => {
     return line >= task.line && line <= task.lastLine
   })

package/lib/migrate-config.js

@@ -135,7 +135,7 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
       }
 
       // Remove settings.filteredLists
-      if (config.settings.filteredLists && config.settings.filteredLists.length > 0) {
+      if (config.settings.filteredLists) {
         delete config.settings.filteredLists
       }
 

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

@@ -8,6 +8,7 @@ module.exports = class DefaultBoardActionsPlugin extends Plugin {
   getBoardActions() {
     const project = this.project
     const isWindows = process.platform === 'win32'
+    const openIn = isWindows ? 'Explorer' : 'Finder'
 
     return [
       {
@@ -42,7 +43,7 @@ module.exports = class DefaultBoardActionsPlugin extends Plugin {
         },
       },
       {
-        title: `Open in ${isWindows ? 'Explorer' : 'Finder'}`,
+        title: `Open in ${openIn}`,
         keys: ['alt+shift+o'],
         icon: "folder",
         async action () {

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

@@ -28,11 +28,12 @@ module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
     const clearFilterURL = this.getFilterURL('');
     const getFilterURL = (filter) => this.getFilterURL(filter);
     const getFilterLink = (filter) => `[Filter By: ${filter}](${this.getFilterURL(filter)})`;
-    // DOING Make board properties self documenting
+    // 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
@@ -59,28 +60,43 @@ module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
   }
 
   getFilterURL(filter) {
-    return `imdone://${this.project.path}?filter=${filter}`
+    filter = filter.replace(/\(/g, '%28').replace(/\)/g, '%29');
+    return encodeURI(`imdone://${this.project.path}?filter=${filter}`)
   }
 
+  // READY Also include templates (md files) in .github and it's subdirs 
+  // <!--
+  // order:0
+  // -->
   async getTemplates() {
-    const { preparePathForWriting, readdir, readFile } = this.project.fileGateway
+    const { preparePathForWriting, readdir, readFile, stat } = this.project.fileGateway;
     const templateDir = path.join(this.project.configDir, 'templates');
+    const githubDir = path.join(this.project.path, '.github');
+
     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 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);
+      const allTemplates = await Promise.all(readFilePromises);
+      return allTemplates.reduce((acc, template) => ({ ...acc, ...template }), {});
+    };
 
-    const templates = allTemplates.reduce((acc, template) => {
-      return { ...acc, ...template };
-    }, {});
+    const templatesFromTemplateDir = await readMarkdownFiles(templateDir);
+    const templatesFromGithubDir = await readMarkdownFiles(githubDir, 'github_');
 
-    return { simple: simpleTemplate, ...templates };
+    return { simple: simpleTemplate, ...templatesFromTemplateDir, ...templatesFromGithubDir };
   }
 }

package/lib/plugins/plugin-manager.js

@@ -216,7 +216,9 @@ module.exports = class PluginManager extends Emitter {
   }
 
   getPluginInstance(name) {
-    return this.getPlugin(name).pluginInstance
+    const plugin = this.getPlugin(name)
+    if (!plugin) throw new Error(`Plugin ${name} not found`)
+    return plugin.pluginInstance
   }
 
   getPlugin(name) {
@@ -392,12 +394,12 @@ module.exports = class PluginManager extends Emitter {
     }
   }
 
-  performBoardAction(action, task) {
+  async performBoardAction(action, task) {
     const plugin = this.getPluginInstance(action.plugin)
     try {
       return action.index 
-      ? plugin.getBoardActions()[action.index].action(task)
-      : plugin.getBoardActions().find(a => a.title === action.title).action(task)
+      ? await plugin.getBoardActions()[action.index].action(task)
+      : await plugin.getBoardActions().find(a => a.title === action.title).action(task)
     } catch (e) {
       this.pluginError('getBoardActions', plugin, e)
     }

package/lib/project.js

@@ -174,10 +174,9 @@ module.exports = class WorkerProject extends Project {
     console.timeEnd('getTags time')
 
     console.time('getLists time')
-    const lists = this.filter ? this.getLists({
-      tasks: this.getCards(this.filter, cards),
-      populateFiltered: true,
-    }) : allLists
+    const lists = this.filter
+    ? this.getRequestedLists(cards)
+    : allLists
     console.timeEnd('getLists time')
 
     console.timeEnd('toJSON time')
@@ -202,6 +201,20 @@ module.exports = class WorkerProject extends Project {
     }
   }
 
+  getRequestedLists(cards) {
+    return this.getLists({
+      tasks: this.getCards(this.filter, cards),
+      populateFiltered: true,
+    }).map(list => {
+      const configList = this.config.lists.find(l => l.name === list.name)
+      list.hidden = configList && configList.hidden
+      if (this.hideLists.includes(list.name)) {
+        list.hidden = true
+      }
+      return list
+    })
+  }
+
   emit() {} // This is implemented in imdone UI worker
 
   emitUpdate() {
@@ -350,9 +363,12 @@ module.exports = class WorkerProject extends Project {
   }
 
   filterCards(cards, filter) {
+    this.hideLists = []
     const {
       result,
+      hideLists
     } = Repository.filterCards(cards, filter)
+    this.hideLists = hideLists
     return result
   }
 
@@ -457,6 +473,10 @@ module.exports = class WorkerProject extends Project {
     })
   }
 
+  getFile(filePath) {
+    return this.repo.getFile(filePath)
+  }
+
   getFileForTask(task) {
     return this.repo.getFileForTask(task)
   }
@@ -503,6 +523,12 @@ module.exports = class WorkerProject extends Project {
     this.emit('project.openUrl', url)
   }
 
+  // TODO For methods that emit, they should still do the thing without imdone UI
+  // <!--
+  // #urgent
+  // #important
+  // order:-195
+  // -->
   async openPath(path) {
     this.emit('project.openPath', path)
   }
@@ -760,6 +786,11 @@ module.exports = class WorkerProject extends Project {
     if (action.plugin) return this.pluginManager.performCardAction(action, task)
 
     const actionFunction = task.getCardActions()[action.index].action
+    // TODO These card actions should be removed
+    // #imdone-1.54.0
+    // <!--
+    // order:-175
+    // -->
     const actions = {
       filter: (filter) => {
         this.setFilter(filter)

package/lib/repository.js

@@ -33,11 +33,11 @@ var _isFunction = require('lodash.isfunction'),
   Task = require('./task'),
   newCard = require('./card'),
   { replaceDateLanguage } = require('./adapters/parsers/DateLanguageParser'),
-  { getRawTask, isNumber } = require('./adapters/parsers/task/CardContentParser')
-
+  { getRawTask, isNumber, LIST_NAME_PATTERN } = require('./adapters/parsers/task/CardContentParser'),
+  XRegExp = require('xregexp'),
+  promisify = require('util').promisify
 
 const appContext = require('./context/ApplicationContext')
-const get = require('lodash.get')
 
 var ERRORS = constants.ERRORS,
   DEFAULT_FILE_PATTERN = constants.DEFAULT_FILE_PATTERN,
@@ -210,24 +210,28 @@ Repository.prototype.addAllMeta = function (meta) {
  * @param {} list
  * @return
  */
-Repository.prototype.addList = function (list, cb) {
-  cb = tools.cb(cb)
-  if (this.listExists(list.name)) return cb()
-  var self = this
-  var fn = function (err) {
-    if (!err) self.emit('list.modified', list)
-    cb(err)
-  }
-  list = _omit(list, 'tasks')
-  this.config.lists.push(new List(list))
-  if (!list.filter && !/[a-z]/.test(list.name)) {
-    const codeList = list.name.replace(/\s+/g, '-').toUpperCase()
-    if (!this.config.code.include_lists.find((name) => name === codeList)) {
-      this.config.code.include_lists.push(codeList)
+Repository.prototype.addList = async function (list, cb) {
+  cb = tools.cb(cb);
+  if (this.listExists(list.name)) return cb();
+
+  try {
+    list = _omit(list, 'tasks');
+    this.config.lists.push(new List(list));
+
+    if (!list.filter && !/[a-z]/.test(list.name)) {
+      const codeList = list.name.replace(/\s+/g, '-').toUpperCase();
+      if (!this.config.code.include_lists.find((name) => name === codeList)) {
+        this.config.code.include_lists.push(codeList);
+      }
     }
+
+    await promisify(this.saveConfig).bind(this)();
+    this.emit('list.modified', list);
+    cb();
+  } catch (err) {
+    cb(err);
   }
-  this.saveConfig(fn)
-}
+};
 
 Repository.prototype.removeList = function (list, cb) {
   return new Promise((resolve, reject) => {
@@ -271,7 +275,7 @@ Repository.prototype.getConfig = function () {
  * @return MemberExpression
  */
 Repository.prototype.getLists = function () {
-  return this.getConfig().lists
+  return this.getConfig().lists.map(obj => ({...obj}));
 }
 
 Repository.prototype.getVisibleLists = function () {
@@ -503,6 +507,7 @@ Repository.prototype.removeFile = function (file) {
  * @return CallExpression
  */
 Repository.prototype.getFile = function (path) {
+  path = this.getRelativePath(path)
   return this.files.find((file) => file.path === path)
 }
 
@@ -768,8 +773,8 @@ Repository.prototype.getList = function (name) {
 }
 
 
-Repository.prototype.getListById = function(id) {
-  return this.getLists().find((list) => list.id === id)
+Repository.prototype.getListById = function(id, lists = this.getLists()) {
+  return lists.find((list) => list.id === id)
 }
 
 Repository.prototype.hideList = function (name, cb) {
@@ -864,11 +869,11 @@ Repository.prototype.updateList = function(id, {name, filter}) {
     if (!filter && this.listExists(name)) return resolve()
 
     const lists = this.getLists()
-    const list = this.getListById(id)
+    const list = this.getListById(id, lists)
     const oldName = list.name
     const oldFilter = list.filter
     list.name = name
-     if (oldFilter) list.filter = filter
+    if (oldFilter) list.filter = filter
     this.setLists(lists)
 
     if (oldName === name || oldFilter) {
@@ -1627,6 +1632,25 @@ Repository.regexQuery = function (tasks, queryString) {
 };
 
 
+Repository.parseHideListsFromQueryString = function (queryString) {
+  const hideLists = []
+  const regex = `hide:(\\s*((${LIST_NAME_PATTERN},?\\s?)+))?`
+  queryString = queryString.replaceAll(
+    // hide lists example `hide: list1, list2`
+    new XRegExp(regex, 'g'),
+    (match, allLists, lists) => {
+      lists && lists.split(',').forEach((list) => {
+        hideLists.push(list.trim())
+      })
+      return ''
+    }
+  ).trim()
+  return {
+    hideLists,
+    queryString,
+  }
+}
+
 Repository.parseSortFromQueryString = function (queryString) {
   const sort = []
   queryString = queryString.replace(
@@ -1663,7 +1687,10 @@ Repository.sortByQuery = function (tasks, queryString = '') {
 Repository.filterCards = function (tasks, _queryString = '') {
   let query
   _queryString = replaceDateLanguage(_queryString)
-  let { sort, queryString } = Repository.parseSortFromQueryString(_queryString)
+  let { sort, queryString } = Repository.parseSortFromQueryString(_queryString);
+  const hideListsQuery = Repository.parseHideListsFromQueryString(queryString);
+  queryString = hideListsQuery.queryString;
+  const hideLists = hideListsQuery.hideLists;
   try {
     query = monquery(queryString)
   } catch (e) {
@@ -1679,7 +1706,8 @@ Repository.filterCards = function (tasks, _queryString = '') {
   return {
     result,
     query,
-    sort
+    sort,
+    hideLists
   }
 }
 

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "imdone-core",
-  "version": "1.54.1",
+  "version": "1.54.3",
   "description": "imdone-core",
   "main": "index.js",
+  "bin": {
+    "imdone-cli": "./cli.js"
+  },
   "scripts": {
     "build": "doctoc --github --notitle README.md && npm test",
     "coverage": "nyc --reporter=lcov --reporter=text --reporter=html mocha --exit",
@@ -48,7 +51,7 @@
     "cheerio": "^1.0.0-rc.10",
     "chrono-node": "^2.6.4",
     "command-exists": "^1.2.9",
-    "commander": "^11.0.0",
+    "commander": "^11.1.0",
     "debug": ">=4.3.4",
     "download": "^8.0.0",
     "eol": "^0.9.1",