imdone-core 1.54.10 → 2.0.1

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

@@ -1,194 +1,205 @@
-'use strict'
-
-var fsStore = require('./repo-fs-store'),
-  log = require('debug')('imdone-mixins:repo-watched-fs-store'),
-  File = require('../file'),
-  constants = require('../constants'),
-  sane = require('sane')
-
-module.exports = mixin
+import { fileSystemStoreMixin } from './repo-fs-store.js'
+import debug from 'debug'
+const log = debug('imdone-mixins:repo-watched-fs-store')
+import { File } from '../file.js'
+import { constants } from '../constants.js'
+import chokidar from 'chokidar'
+import realFs from 'fs'
+import { logger } from '../adapters/logger.js'
 
 // 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
-  var _destroy = repo.destroy
-  var _init = repo.init
-  var initializing = false
+export function watchedFileSystemStoreMixin(repo, fs = realFs) {
+  repo = fileSystemStoreMixin(repo, fs)
+  const _refresh = repo.refresh
+  const _destroy = repo.destroy
+  const _init = repo.init
+  let initializing = false
+  let refreshing = false
+
+  function ready() {
+    return !initializing && !refreshing
+  }
 
-  repo.init = function (cb) {
+  async function waitForReady() {
+    while (!ready()) {
+      logger.log('Waiting for repo to be ready:', repo.path)
+      await new Promise(resolve => setTimeout(resolve, 500))
+    }
+  }
+
+  // READY Refactor init to async/await
+  // #esm-migration #important
+  // <!--
+  // order:-310
+  // -->
+  repo.init = async function () {
     if (initializing) {
-      const err = new Error("Can't initialize repo while it's initializing.")
-      console.error(err.message)
-      return cb ? cb(err) : null
+      throw new Error("Can't initialize repo while it's initializing.")
     }
     log('Initializing repo:', repo.path)
     initializing = true
-    _init.call(repo, function (err, files) {
-      if (err) {
-        console.error(`Error initializing repo: ${err.message}`)
-        initializing = false
-        return cb ? cb(err) : null
-      }
-      repo.initWatcher(() => {
-        initializing = false
-        if (cb) cb(err, files)
-      })
-    })
+    try {
+      const files = await _init.call(repo)
+      await repo.initWatcher()
+      repo.emit('watching', { ok: true, lists: repo.getLists() })
+      initializing = false
+      return files
+    } catch (err) {
+      initializing = false
+      throw new Error(`Error initializing repo: ${repo.path}`, { cause: err })
+    }
   }
 
-  repo.destroy = function () {
-    if (repo.watcher) repo.watcher.close()
-    _destroy.apply(repo)
+  repo.destroy = async function () {
+    if (repo.watcher) await repo.watcher.close()
+    await _destroy.apply(repo)
   }
 
-  repo.refresh = function (cb) {
-    if (initializing) {
-      return cb ? cb('already initializing') : null
+  // READY Refactor refresh to async/await
+  // #esm-migration #important
+  // <!--
+  // order:-330
+  // -->
+  repo.refresh = async function () {
+    await waitForReady()
+    log('Refreshing repo:', repo.path)
+    refreshing = true
+    try {
+      const files = await _refresh.call(repo)
+      await repo.initWatcher()
+      refreshing = false
+      return files
+    } catch (err) {
+      refreshing = false
+      throw new Error(`Error refreshing repo: ${repo.path}`, { cause: err })
     }
-    console.info('Initializing repo:', repo.path)
-    initializing = true
-    if (repo.watcher) repo.watcher.close()
-    _refresh.call(repo, function (err, files) {
-      if (err) {
-        initializing = false
-        return cb ? cb(err) : null
-      }
-      repo.initWatcher(() => {
-        initializing = false
-        return cb ? cb(err, files) : null
-      })
-    })
+
   }
 
-  var _isImdoneConfig = function (path) {
+  function _isImdoneConfig(path) {
     return path === constants.CONFIG_FILE_YML
   }
 
-  var _isImdoneIgnore = function (path) {
+  function _isImdoneIgnore(path) {
     return path === constants.IGNORE_FILE
   }
 
-  const onConfigChange = function (file) {
-    console.info('Loading config.  Observed a change to:', file)
+  async function onConfigChange(file) {
+    logger.info('Loading config.  Observed a change to:', file)
     const label = `Refresh repo: ${repo.path}`
-    console.time(label)
-    repo.refresh((err, files) => {
-      if (err) console.error('Error refreshing repo', err)
-      console.timeEnd(label)
+    logger.time(label)
+    try {
+      await repo.refresh()
       repo.emitConfigUpdate(file, repo.config)
-    })
+    } finally {
+      logger.timeEnd(label)
+    }
   }
 
   const onIgnoreChange = onConfigChange
 
-  repo.initWatcher = function (cb) {
-    console.log('initializing watcher for:', repo.path)
-    repo.watcher = sane(repo.path, {
-      dot: true,
-      ignored(file) {
-        if (!initializing && _isImdoneConfig(file)) {
-          onConfigChange(file)
-        }
-
-        if (!initializing && _isImdoneIgnore(file)) {
-          onIgnoreChange(file)
-        }
-
-        const ignore = !repo.shouldInclude(file)
-        if (!ignore || /^.*\.(jpg|gif|pdf|png)$/i.test(file)) {
-          repo.addFilePath(file)
-        }
-        return ignore
-      },
-    })
-
-    repo.watcher
-      .on('error', (err) => {
-        console.error('Error in watcher')
-        console.error(err)
-        cb(err)
-      })
-      .on('ready', () => {
-        console.log('watcher ready for:', repo.path)
-        initializing = false
-        cb()
-      })
-      .on('add', function (path, root, stat) {
-        console.log('Watcher received add event for file: ' + path)
-        if (stat.isDirectory()) return
-        var file = repo.getFile(path)
-        if (file === undefined) {
-          log('Creating file: ' + path)
-          file = new File({
-            repoId: repo.getId(),
-            filePath: path,
-            languages: repo.languages,
-            project: repo.project,
-          })
+  // READY Refactor initWatcher to async/await
+  // #esm-migration #important
+  // <!--
+  // order:-320
+  // defer:2025-03-18
+  // -->
+  repo.initWatcher = async () => {
+    return new Promise(async (resolve, reject) => {
+      logger.log('initializing watcher for:', repo.path)
+      repo.watcher = chokidar.watch(repo.path, {
+        persistent: true,
+        usePolling: false,
+        alwaysStat: true,
+        awaitWriteFinish: true,
+        atomic: true,
+        ignoreInitial: true,
+        ignored: (file) => {
+          const ignored = !repo.shouldInclude(file)
+          if (ignored) logger.log('Ignoring file:', file)
+          return ignored
         }
+      }).on('error', (err) => {
+          logger.error('Error in watcher')
+          logger.error(err)
+          repo.emit('watch.error', err)
+          reject(err)
+        })
+        .on('ready', () => {
+          logger.log('watcher ready for:', repo.path)
+          initializing = false
+          resolve()
+        })
+        .on('add', async function (path, stat) {
+          logger.log('Watcher received add event for file: ' + path)
+          if (stat.isDirectory()) return
+          let file = repo.getFile(path)
+          if (file === undefined) {
+            log('Creating file: ' + path)
+            file = new File({
+              repoId: repo.getId(),
+              filePath: path,
+              languages: repo.languages,
+              project: repo.project,
+            })
+          }
 
-        repo.fileOK(file, function (err, stat) {
+          stat = await repo.fileOK()
           log('fileOK returned: ' + JSON.stringify(stat))
-          if (err || !stat) return
           if (stat.mtime <= file.getModifiedTime()) {
             return log('File update already applied.  Change ignored for file: ' + path)
           }
           log('Reading file: ' + path)
-          repo.readFile(file, function (err, file) {
-            repo.emitFileUpdate(file)
-          })
+          file = await repo.readFile(file)
+          repo.emi('watch.add', file)
+          repo.emitFileUpdate(file)
         })
-      })
-      .on('change', function (path, root, stat) {
-        console.log(
-          `Watcher received change event for file: ${path} repoPath: ${repo.path}`,
-          stat.mtime
-        )
-        if (!path || stat.isDirectory()) return
-        var file = repo.getFile(path) || path
-        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
-        }
-        if (_isImdoneConfig(path)) return onConfigChange(path)
-        if (_isImdoneIgnore(path)) return onIgnoreChange(path)
-
-        repo.fileOK((file && file.path) || path, function (err, ok) {
-          if (err) {
-            console.error('Error processing ignore on path: ', path, err)
+        .on('change', async function (path, stat) {
+          logger.log(
+            `Watcher received change event for file: ${path} repoPath: ${repo.path}`,
+            stat.mtime
+          )
+          if (!path || stat.isDirectory()) return
+          var file = repo.getFile(path) || path
+          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()) {
+            // logger.log("File update already applied.  Change ignored.")
             return
           }
+          if (_isImdoneConfig(path)) return onConfigChange(path)
+          if (_isImdoneIgnore(path)) return onIgnoreChange(path)
+
+          const ok = await repo.fileOK((file && file.path) || path)
           if (!ok) return
           log('Reading file: ' + path)
           if (!isFile) file = repo.getFile(path)
-          repo.readFile(file, function (err, file) {
-            repo.emitFileUpdate(file)
-          })
+          file = await repo.readFile(file)
+          repo.emit('watch.change', file)
+          repo.emitFileUpdate(file)
         })
-      })
-      .on('delete', function (path) {
-        log('Watcher received unlink event for file: ' + path)
-        repo.removeFilePath(path)
-        var file = new File({
-          repoId: repo.getId(),
-          filePath: path,
-          languages: repo.languages,
-          project: repo.project,
+        .on('delete', async function (path) {
+          log('Watcher received unlink event for file: ' + path)
+          repo.removeFilePath(path)
+          var file = new File({
+            repoId: repo.getId(),
+            filePath: path,
+            languages: repo.languages,
+            project: repo.project,
+          })
+          log('Removing file: ' + path)
+          repo.removeFile(file)
+          repo.emit('watch.delete', file)
+          repo.emitFileUpdate(file, true)
         })
-        log('Removing file: ' + path)
-        repo.removeFile(file)
-        repo.emitFileUpdate(file, true)
-      })
+    });
   }
 
   return repo

package/lib/plugins/archive-plugin.js

@@ -1,8 +1,8 @@
-const Plugin = require('imdone-api')
-const path = require('path')
-const { getRawTask } = require('../adapters/parsers/task/CardContentParser')
+import Plugin from 'imdone-api'
+import path from 'path'
+import { getRawTask } from '../adapters/parsers/task/CardContentParser.js'
 
-module.exports = class ArchivePlugin extends Plugin {
+export default class ArchivePlugin extends Plugin {
   constructor(project) {
     super(project)
   }
@@ -29,7 +29,9 @@ module.exports = class ArchivePlugin extends Plugin {
       if (messageUser) this.project.snackBar({message: `Archiving ${cards.length} card(s)...`})
     }
 
-    cards.forEach(card => this.archiveTask(card))
+    for (const card of cards) {
+      await this.archiveTask(card)
+    }
 
     if (messageUser) this.project.snackBar({message: ` Done archiving ${cards.length} card(s). Deleting original(s)...`})
     await this.project.deleteTasks(cards)
@@ -39,7 +41,7 @@ module.exports = class ArchivePlugin extends Plugin {
 
   }
 
-  archiveTask (task, config = this.config) {
+  async archiveTask (task, config = this.config) {
     const archiveFolder = config.archiveFolder
     const fileDir = path.dirname(task.relPath)
     
@@ -63,8 +65,8 @@ module.exports = class ArchivePlugin extends Plugin {
     const taskStart = getRawTask({tokenPrefix, beforeText, list, text: ''})
     const taskContent = `${taskStart} ${content}\n\n\n`
     
-    this.fileGateway.preparePathForWriting(newPath)
-    this.fileGateway.appendFileSync(newPath, taskContent)
+    await this.fileGateway.preparePathForWriting(newPath)
+    await this.fileGateway.appendFileSync(newPath, taskContent)
   }
 
 }

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

@@ -1,6 +1,6 @@
-const Plugin = require('imdone-api')
+import Plugin from 'imdone-api'
 
-module.exports = class DefaultBoardActionsPlugin extends Plugin {
+export default class DefaultBoardActionsPlugin extends Plugin {
   constructor(project) {
     super(project)
   }

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

@@ -1,6 +1,6 @@
-const Plugin = require('imdone-api')
-const {getIsoDateWithOffset} = require('../adapters/date-time')
-const path = require('path')
+import Plugin from 'imdone-api'
+import { getIsoDateWithOffset } from '../adapters/date-time.js'
+import path from 'path'
 
 const simpleTemplate = '\n<!--\ncreated:${timestamp}\n-->\n'
 
@@ -13,7 +13,7 @@ function flattenObject(object) {
   }, {});
 }
 
-module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
+export default class DefaultBoardPropertiesPlugin extends Plugin {
   constructor(project) {
     super(project)
     this.templates = {}
@@ -66,11 +66,11 @@ module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
 
 
   async getTemplates() {
-    const { preparePathForWriting, readdir, readFile, stat } = this.project.fileGateway;
+    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');
 
-    preparePathForWriting(templateDir);
+    await preparePathForWriting(templateDir, true);
 
     const readMarkdownFiles = async (dir, prefix = '') => {
       const files = await readdir(dir);
@@ -92,7 +92,7 @@ module.exports = class DefaultBoardPropertiesPlugin extends Plugin {
     };
 
     const templatesFromTemplateDir = await readMarkdownFiles(templateDir);
-    const templatesFromGithubDir = await stat(githubDir)
+    const templatesFromGithubDir = await exists(githubDir)
       ? await readMarkdownFiles(githubDir, 'github_')
       : {};
 

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

@@ -1,4 +1,5 @@
-const Plugin = require('imdone-api')
+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]
@@ -8,7 +9,7 @@ function getEpicMeta(task) {
   return task.allMeta && task.allMeta['epic'] && task.allMeta['epic'][0]
 }
 
-module.exports = class EpicPlugin extends Plugin {
+export default class EpicPlugin extends Plugin {
   constructor(project) {
     super(project)
     this.epics = {}
@@ -20,13 +21,13 @@ module.exports = class EpicPlugin extends Plugin {
 
   onBoardUpdate(lists) {
     // this html is getting initialized before onBoardUpdate
-    console.log(
+    logger.log(
       `${this.project.name} epics found:`,
       Object.keys(this.epics).length
     )
-    console.time(`${this.project.name} Epic updates`)
+    logger.time(`${this.project.name} Epic updates`)
     this.updateCardMD(lists)
-    console.timeEnd(`${this.project.name} Epic updates`)
+    logger.timeEnd(`${this.project.name} Epic updates`)
   }
 
   onTaskUpdate(task) {

package/lib/plugins/extension-plugin.js

@@ -1,31 +1,39 @@
-const Plugin = require('imdone-api')
-const _path = require('path')
-const { statSync } = require('fs')
+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';
 
-module.exports = class ExtensionPlugin extends Plugin {
+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)
-    console.log('loading extensions')
+    logger.log('loading extensions')
     this.configDir = _path.join(project.path, '.imdone')
+  }
 
-    this.cardActionsFunction = this.loadExtensionModule(
+  async init() {
+    this.cardActionsFunction = await this.loadExtensionModule(
       () => [],
       'actions',
       'card'
     )
-    this.boardActionsFunction = this.loadExtensionModule(
+    this.boardActionsFunction = await this.loadExtensionModule(
       () => [],
       'actions',
       'board'
     )
-    this.cardPropertiesFunction = this.loadExtensionModule(
+    this.cardPropertiesFunction = await this.loadExtensionModule(
       () => {
         return {}
       },
       'properties',
       'card'
     )
-    this.boardPropertiesFunction = this.loadExtensionModule(
+    this.boardPropertiesFunction = await this.loadExtensionModule(
       () => {
         return {}
       },
@@ -33,7 +41,6 @@ module.exports = class ExtensionPlugin extends Plugin {
       'board'
     )
   }
-
   getCardProperties(task) {
     return this.cardPropertiesFunction(task)
   }
@@ -57,26 +64,26 @@ module.exports = class ExtensionPlugin extends Plugin {
   }
 
   getConfigPath(relativePath) {
-    return _path.join(this.configDir, ...relativePath)
+    return _path.resolve(_path.join(this.configDir, ...relativePath) + '.js')
   }
 
-  loadExtensionModule(_default, ...path) {
+  async loadExtensionModule(_default, ...path) {
     let extension = _default
     const extensionPath = this.getConfigPath(path)
     try {
-      statSync(extensionPath + '.js')
-      delete require.cache[require.resolve(extensionPath)]
+      await exists(extensionPath)
+      delete require.cache[extensionPath]
       extension = require(extensionPath)
     } catch (e) {
       if (e.code === 'ENOENT') {
-        console.log('No extension found at:', extensionPath)
+        logger.log('No extension found at:', extensionPath)
       } else {
-        console.error(e)
+        logger.warn('Error loading extension:', e.message)
       }
     }
 
     if (typeof extension !== 'function') {
-      console.warn(
+      logger.warn(
         `${extensionPath} does not export a function. Using default empty function. ${_default.toString()}`
       )
       extension = _default

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

@@ -1,7 +1,8 @@
-const Plugin = require('imdone-api')
-const { save } = require('../adapters/storage/tags.js')
+import Plugin from 'imdone-api'
+import { save } from '../adapters/storage/tags.js'
 
-module.exports = class PersistTagsPlugin extends Plugin {
+export default class PersistTagsPlugin extends Plugin {
+  
   constructor(project) {
     super(project)
   }