imdone-core 1.54.11 → 1.54.13

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm test:*)",
+      "Bash(node test-debug.js:*)"
+    ]
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.54.13
+
+- **Enhancement**: `customCardTerminator` now accepts numeric values to specify the number of consecutive blank lines needed to terminate a card (e.g., `customCardTerminator: 3` requires 3 blank lines)
+- **Enhancement**: `repo.resume()` now automatically calls `refresh()` to pick up file changes that occurred while the repository was paused
+- **Enhancement**: `File.trimBlankLines()` now respects the `customCardTerminator` config setting, preserving the appropriate number of blank lines in card content
+- **Fix**: `Task.updateFromContent()` now respects the `customCardTerminator` config setting when collapsing consecutive blank lines, ensuring consistency across all content operations
+- **Tests**: Added comprehensive test coverage for numeric `customCardTerminator` values, `trimBlankLines` behavior, `updateFromContent` behavior, and `resume()` refresh functionality
+- **Refactor**: Improved code readability by replacing comments with self-documenting function names and descriptive constants
+
 ## 1.28.8
 - Allow Card and Board actions to return a value
 

package/lib/adapters/parsers/task/CardContentParser.js

@@ -55,10 +55,28 @@ function getContentLines(content) {
 }
 
 function isCustomCardTerminator(config, line) {
-  return config.customCardTerminator 
-    && config.customCardTerminator.trim() 
-    && line 
-    && line.trim() === config.customCardTerminator
+  if (!config.customCardTerminator) return false
+
+  const isStringTerminator = typeof config.customCardTerminator === 'string'
+    && config.customCardTerminator.trim()
+
+  if (isStringTerminator) {
+    const terminatorMatches = line && line.trim() === config.customCardTerminator.trim()
+    return terminatorMatches
+  }
+
+  return false
+}
+
+const DEFAULT_BLANK_LINE_TERMINATOR_COUNT = 2
+
+function getBlankLineTerminatorCount(config) {
+  const hasNumericTerminator = typeof config.customCardTerminator === 'number'
+    && config.customCardTerminator > 0
+
+  return hasNumericTerminator
+    ? config.customCardTerminator
+    : DEFAULT_BLANK_LINE_TERMINATOR_COUNT
 }
 
 function isCheckBoxTask (config, line, beforeText) {
@@ -256,8 +274,8 @@ function getTextFileTaskContent ({
   const isTaskInList = isMarkDownFile && isBeforeTextMarkdownList(beforeText)
   let openBlockCommentTokens = 0
   let closeBlockCommentTokens = 0
-  let lastLineBlank = false
-  let endsWithDoubleBlank = false
+  const blankLineTerminatorCount = getBlankLineTerminatorCount(config)
+  let consecutiveBlankLines = 0
   let trailingBlankLines = 0
   const rawTaskContentLines = []
   const taskContentLines = []
@@ -277,7 +295,7 @@ function getTextFileTaskContent ({
     if (isCheckBoxTask(config, line, beforeText)) break
     if (isTaskInList && isLineOutsideMarkdownList(line, beforeText)) break
     if (isCustomCardTerminator(config, line)) break
-    
+
     rawTaskContentLines.push(line)
     taskContentLines.push(`${line}`)
 
@@ -285,20 +303,28 @@ function getTextFileTaskContent ({
     if (isMarkDownFile && line.trim().indexOf('<!--') > -1)
       openBlockCommentTokens++
     if (isMarkDownFile && line.trim().indexOf('-->') > -1)
-      closeBlockCommentTokens++  
+      closeBlockCommentTokens++
 
     const thisLineBlank = line.trim() === ''
 
-    if (thisLineBlank && lastLineBlank) {
-      endsWithDoubleBlank = true
-      break
+    if (thisLineBlank) {
+      consecutiveBlankLines++
+      if (consecutiveBlankLines >= blankLineTerminatorCount) {
+        trailingBlankLines = blankLineTerminatorCount
+        break
+      }
+    } else {
+      consecutiveBlankLines = 0
     }
-
-    lastLineBlank = thisLineBlank  
   }
 
-  if (endsWithDoubleBlank) trailingBlankLines = 2
-  else if (lastLineBlank) trailingBlankLines = 1
+  const reachedEndNaturally = trailingBlankLines === 0
+  const hasTrailingBlankLines = consecutiveBlankLines > 0
+  const isUsingDefaultTerminator = blankLineTerminatorCount === DEFAULT_BLANK_LINE_TERMINATOR_COUNT
+
+  if (reachedEndNaturally && hasTrailingBlankLines && isUsingDefaultTerminator) {
+    trailingBlankLines = consecutiveBlankLines
+  }
 
   // Remove extra block comment tokens
   if (

package/lib/constants.js

@@ -50,13 +50,14 @@ module.exports = {
   SORT_FILE: path.join(CONFIG_DIR, 'sort.json'),
   TEMPLATES_DIR: path.join(CONFIG_DIR, 'templates'),
   IGNORE_FILE: '.imdoneignore',
+  PAUSE_FILE: '.imdonepause',
   DEFAULT_FILE_PATTERN: '^(readme\\.md|home\\.md|readme\\.w+|home\\.w+)$',
   DEFAULT_IGNORE,
   DEFAULT_IGNORE_DIRS,
   DEFAULT_IGNORE_EXTS,
   ERRORS: {
     NOT_A_FILE: 'file must be of type File',
-    CALLBACK_REQUIRED: 'Last paramter must be a callback function',
+    CALLBACK_REQUIRED: 'Last parameter must be a callback function',
     NO_CONTENT: 'File has no content',
     LIST_NOT_FOUND: 'List not found',
     TASK_NOT_FOUND: 'Task not found',

package/lib/file.js

@@ -820,17 +820,51 @@ File.prototype.modifyTaskFromHtml = function (task, html) {
 }
 
 File.prototype.modifyTaskFromContent = function (task, content, config) {
-  content = trimBlankLines(content, this.isCodeFile())
+  content = trimBlankLines(content, this.isCodeFile(), config)
   task.updateFromContent(content)
   this.modifyTask(task, config)
 }
 
-const trimBlankLines = File.trimBlankLines = function (content, isCodeFile) {
+const DEFAULT_BLANK_LINE_TERMINATOR_COUNT = 2
+const CODE_FILE_BLANK_LINE_PATTERN = /\n\s*\n/g
+const CODE_FILE_BLANK_LINE_REPLACEMENT = '\n'
+
+function getBlankLineTerminatorCountFromConfig(config) {
+  const hasNumericTerminator = config
+    && typeof config.customCardTerminator === 'number'
+    && config.customCardTerminator > 0
+
+  return hasNumericTerminator
+    ? config.customCardTerminator
+    : DEFAULT_BLANK_LINE_TERMINATOR_COUNT
+}
+
+function buildExcessiveBlankLinePattern(terminatorCount) {
+  const minNewlinesToTrim = terminatorCount + 1
+  const patternParts = Array(minNewlinesToTrim).fill('\\n\\s*')
+  return new RegExp(patternParts.join(''), 'g')
+}
+
+function calculateMaxPreservedBlankLines(terminatorCount) {
+  return terminatorCount - 1
+}
+
+function buildBlankLineReplacement(maxBlankLines) {
+  const newlineCount = maxBlankLines + 1
+  return '\n'.repeat(newlineCount)
+}
+
+const trimBlankLines = File.trimBlankLines = function (content, isCodeFile, config) {
   if (isCodeFile) {
-    // replace all occurrences of two empty lines in a row with a single empty line
-    return content.replace(/\n\s*\n/g, '\n')
-  } 
-  return content.replace(/\n\s*\n\s*\n/g, '\n\n')
+    return content.replace(CODE_FILE_BLANK_LINE_PATTERN, CODE_FILE_BLANK_LINE_REPLACEMENT)
+  }
+
+  const terminatorCount = getBlankLineTerminatorCountFromConfig(config)
+  const excessiveBlankLinePattern = buildExcessiveBlankLinePattern(terminatorCount)
+  const maxBlankLines = calculateMaxPreservedBlankLines(terminatorCount)
+  const replacement = buildBlankLineReplacement(maxBlankLines)
+
+  return content.replace(excessiveBlankLinePattern, replacement)
 }
 
 File.prototype.modifyDescription = function (task, config) {

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

@@ -4,7 +4,8 @@ var fsStore = require('./repo-fs-store'),
   log = require('debug')('imdone-mixins:repo-watched-fs-store'),
   File = require('../file'),
   constants = require('../constants'),
-  sane = require('sane')
+  sane = require('sane'),
+  path = require('path')
 
 module.exports = mixin
 
@@ -18,6 +19,7 @@ function mixin(repo, fs = require('fs')) {
   var _destroy = repo.destroy
   var _init = repo.init
   var initializing = false
+  var paused = false
 
   repo.init = function (cb) {
     if (initializing) {
@@ -33,9 +35,17 @@ function mixin(repo, fs = require('fs')) {
         initializing = false
         return cb ? cb(err) : null
       }
-      repo.initWatcher(() => {
-        initializing = false
-        if (cb) cb(err, files)
+      // Check if pause file exists on init
+      const pauseFilePath = path.join(repo.path, constants.PAUSE_FILE)
+      fs.access(pauseFilePath, fs.constants.F_OK, (accessErr) => {
+        if (!accessErr) {
+          log('Pause file detected on init. Pausing repository.')
+          paused = true
+        }
+        repo.initWatcher(() => {
+          initializing = false
+          if (cb) cb(err, files)
+        })
       })
     })
   }
@@ -57,9 +67,19 @@ function mixin(repo, fs = require('fs')) {
         initializing = false
         return cb ? cb(err) : null
       }
-      repo.initWatcher(() => {
-        initializing = false
-        return cb ? cb(err, files) : null
+      // Check if pause file exists on refresh
+      const pauseFilePath = path.join(repo.path, constants.PAUSE_FILE)
+      fs.access(pauseFilePath, fs.constants.F_OK, (accessErr) => {
+        if (!accessErr) {
+          log('Pause file detected on refresh. Pausing repository.')
+          paused = true
+        } else {
+          paused = false
+        }
+        repo.initWatcher(() => {
+          initializing = false
+          return cb ? cb(err, files) : null
+        })
       })
     })
   }
@@ -72,6 +92,10 @@ function mixin(repo, fs = require('fs')) {
     return path === constants.IGNORE_FILE
   }
 
+  var _isImdonePause = function (path) {
+    return path === constants.PAUSE_FILE
+  }
+
   const onConfigChange = function (file) {
     console.info('Loading config.  Observed a change to:', file)
     const label = `Refresh repo: ${repo.path}`
@@ -85,6 +109,30 @@ function mixin(repo, fs = require('fs')) {
 
   const onIgnoreChange = onConfigChange
 
+  repo.pause = async function () {
+    log('Pausing watcher for:', repo.path)
+    paused = true
+    return Promise.resolve()
+  }
+
+  repo.resume = async function () {
+    log('Resuming watcher for:', repo.path)
+    paused = false
+    return new Promise((resolve, reject) => {
+      repo.refresh((err, files) => {
+        if (err) {
+          console.error('Error refreshing repo on resume', err)
+          return reject(err)
+        }
+        resolve(files)
+      })
+    })
+  }
+
+  repo.isPaused = function () {
+    return paused
+  }
+
   repo.initWatcher = function (cb) {
     console.log('initializing watcher for:', repo.path)
     repo.watcher = sane(repo.path, {
@@ -98,6 +146,11 @@ function mixin(repo, fs = require('fs')) {
           onIgnoreChange(file)
         }
 
+        // Don't ignore the pause file so we can detect it
+        if (_isImdonePause(file)) {
+          return false
+        }
+
         const ignore = !repo.shouldInclude(file)
         if (!ignore || /^.*\.(jpg|gif|pdf|png)$/i.test(file)) {
           repo.addFilePath(file)
@@ -119,6 +172,11 @@ function mixin(repo, fs = require('fs')) {
       })
       .on('add', function (path, root, stat) {
         console.log('Watcher received add event for file: ' + path)
+        if (_isImdonePause(path)) {
+          console.log('Pause file detected. Pausing repository.')
+          return repo.pause()
+        }
+        if (paused) return log('Watcher is paused. Ignoring add event for: ' + path)
         if (stat.isDirectory()) return
         var file = repo.getFile(path)
         if (file === undefined) {
@@ -148,6 +206,8 @@ function mixin(repo, fs = require('fs')) {
           `Watcher received change event for file: ${path} repoPath: ${repo.path}`,
           stat.mtime
         )
+        if (_isImdonePause(path)) return log('Ignoring change to pause file')
+        if (paused) return log('Watcher is paused. Ignoring change event for: ' + path)
         if (!path || stat.isDirectory()) return
         var file = repo.getFile(path) || path
         const isFile = File.isFile(file)
@@ -178,6 +238,11 @@ function mixin(repo, fs = require('fs')) {
       })
       .on('delete', function (path) {
         log('Watcher received unlink event for file: ' + path)
+        if (_isImdonePause(path)) {
+          console.log('Pause file deleted. Resuming repository.')
+          return repo.resume()
+        }
+        if (paused) return log('Watcher is paused. Ignoring delete event for: ' + path)
         repo.removeFilePath(path)
         var file = new File({
           repoId: repo.getId(),

package/lib/repository.js

@@ -624,6 +624,33 @@ Repository.prototype.readFileContent = function (file, cb) {
   inMixinsNoop(cb)
 }
 
+/**
+ * Pause file watching (Implemented in mixins)
+ * @method pause
+ * @return Promise
+ */
+Repository.prototype.pause = async function () {
+  return Promise.resolve()
+}
+
+/**
+ * Resume file watching (Implemented in mixins)
+ * @method resume
+ * @return Promise
+ */
+Repository.prototype.resume = async function () {
+  return Promise.resolve()
+}
+
+/**
+ * Check if file watching is paused (Implemented in mixins)
+ * @method isPaused
+ * @return Boolean
+ */
+Repository.prototype.isPaused = function () {
+  return false
+}
+
 /**
  * Description
  * @method readFile
@@ -1129,7 +1156,9 @@ Repository.prototype.appendTask = function({file, content, list}, cb) {
   : description.join(eol.lf)
 
   let appendContent = File.trimBlankLines(
-    `${taskPrefix}${rawTask}${eol.lf}${taskContent}`
+    `${taskPrefix}${rawTask}${eol.lf}${taskContent}`,
+    file.isCodeFile(),
+    config
   )
   
   fileContent = `${fileContent}${sep}`

package/lib/task.js

@@ -14,7 +14,7 @@ var _clone = require('lodash.clone'),
   { escapeRegExp } = require('./tools'),
   { extractWikilinkTopics } = require('./adapters/markdown');
 
-const { 
+const {
   CHECK_REGEX,
   TASK_TYPES,
   getCheckedData,
@@ -22,6 +22,33 @@ const {
   isNumber
 } = require('./adapters/parsers/task/CardContentParser.js')
 
+const DEFAULT_BLANK_LINE_TERMINATOR_COUNT = 2
+
+function getBlankLineTerminatorCountFromConfig(config) {
+  const hasNumericTerminator = config
+    && typeof config.customCardTerminator === 'number'
+    && config.customCardTerminator > 0
+
+  return hasNumericTerminator
+    ? config.customCardTerminator
+    : DEFAULT_BLANK_LINE_TERMINATOR_COUNT
+}
+
+function buildExcessiveBlankLinePattern(terminatorCount) {
+  const minNewlinesToTrim = terminatorCount + 1
+  const patternParts = Array(minNewlinesToTrim).fill('\\n\\s*')
+  return new RegExp(patternParts.join(''), 'g')
+}
+
+function calculateMaxPreservedBlankLines(terminatorCount) {
+  return terminatorCount - 1
+}
+
+function buildBlankLineReplacement(maxBlankLines) {
+  const newlineCount = maxBlankLines + 1
+  return '\n'.repeat(newlineCount)
+}
+
 /**
  * Description
  * @method Task
@@ -177,8 +204,12 @@ class Task {
   }
 
   updateFromContent(content) {
-    // replace all occurrences of two empty lines in a row with a single empty line
-    content = content.replace(/\n\s*\n\s*\n/g, '\n\n')
+    const terminatorCount = getBlankLineTerminatorCountFromConfig(this.config)
+    const excessiveBlankLinePattern = buildExcessiveBlankLinePattern(terminatorCount)
+    const maxBlankLines = calculateMaxPreservedBlankLines(terminatorCount)
+    const replacement = buildBlankLineReplacement(maxBlankLines)
+
+    content = content.replace(excessiveBlankLinePattern, replacement)
     let lines = eol.split(content)
     this.text = lines.shift().trimStart()
     if (lines && lines.length > 1 && lines[lines.length - 1].trim() === '') lines.pop()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.54.11",
+  "version": "1.54.13",
   "description": "imdone-core",
   "main": "index.js",
   "bin": {