imdone-core 2.5.3 → 2.6.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.6.1
+
+- Preserve repeated and whitespace-only blank lines during Markdown/text task write-back when EOF task ending is enabled, including file-watcher transformations after an editor save. Default cleanup and code-file behavior are unchanged.
+
+## 2.6.0
+
+- Add opt-in `settings.cards.endTaskAtEndOfFile` for Markdown/text tasks to retain blank lines through EOF, while preserving next-task and explicit termination boundaries. Existing blank-line behavior remains the default; code-file parsing is unchanged.
+
 ## 2.5.3
 
 - Reorder configured lists atomically with `repository.moveList`, preserving every list field and unrelated configuration, rolling back failed saves, and emitting `list.modified` only after persistence succeeds.

package/README.md

@@ -83,6 +83,18 @@ Task descriptions are captured from the lines that follow a task.  In code files
 -->
 
 ### todo.txt syntax examples
+For Markdown and text tasks that should retain all blank lines through the end of their file, opt into EOF task ending in `.imdone/config.yml`:
+
+```yaml
+settings:
+  cards:
+    endTaskAtEndOfFile: true
+```
+
+This ignores blank-line termination regardless of blank-line counts. A following task, custom text terminator, list boundary or explicit `</card>` still ends the task. Code-file parsing is unchanged. The setting defaults to `false`, preserving the existing two-blank-line behavior.
+
+In 2.6.1 and newer, EOF mode also preserves repeated and whitespace-only blank lines during task write-back and file-watcher transformations.
+
 Imdone uses todo.txt +project/tag @context and meta:data
 
 #### Create date

package/lib/adapters/parsers/file/ReadStreamMarkdownParser.js

@@ -32,6 +32,13 @@ export class ReadStreamMarkdownParser extends ReadStreamTaskParser {
     this.updateCodeFenceState(line)
   }
 
+  isEndOfTask(line) {
+    const terminator = this.config?.customCardTerminator
+    if (this.task && this.config?.endTaskAtEndOfFile &&
+      typeof terminator === 'string' && terminator.trim() && line.trim() === terminator) return true
+    return super.isEndOfTask(line)
+  }
+
   shouldParseTaskLine() {
     return !this.ignoredByFrontmatter &&
       !this.currentLineIsFrontmatter &&

package/lib/adapters/parsers/file/ReadStreamTaskParser.js

@@ -4,8 +4,9 @@ import { logger } from '../../logger.js';
 const blankLinesToEndTask = 2
 
 export class ReadStreamTaskParser {
-  constructor(readStream) {
+  constructor(readStream, config) {
     this.readStream = readStream
+    this.config = config
     this.task = null
     this.line = null
     this.taskParsers = []
@@ -78,7 +79,7 @@ export class ReadStreamTaskParser {
 
     this.nextTask = this.getTaskFromLine(line)
     
-    if (this.blankLines > blankLinesToEndTask - 1) {
+    if (!this.config?.endTaskAtEndOfFile && this.blankLines > blankLinesToEndTask - 1) {
       this.nextTask = undefined
       return true
     }
@@ -111,7 +112,7 @@ export class ReadStreamTaskParser {
     if (!this.task) return
 
     // Remove the empty strings from the end of the task description
-    while (this.task.description[this.task.description.length - 1] === '') {
+    while (!this.config?.endTaskAtEndOfFile && this.task.description[this.task.description.length - 1] === '') {
       this.task.description.pop()
     }
     this.task.lastLine = this.task.line + this.task.description.length

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

@@ -56,7 +56,7 @@ function getContentLines(content) {
 }
 
 function isCustomCardTerminator(config, line) {
-  return config.customCardTerminator 
+  return typeof config.customCardTerminator === 'string'
     && config.customCardTerminator.trim() 
     && line 
     && line.trim() === config.customCardTerminator
@@ -290,7 +290,7 @@ function getTextFileTaskContent ({
 
     const thisLineBlank = line.trim() === ''
 
-    if (thisLineBlank && lastLineBlank) {
+    if (!config.endTaskAtEndOfFile && thisLineBlank && lastLineBlank) {
       endsWithDoubleBlank = true
       break
     }
@@ -298,8 +298,10 @@ function getTextFileTaskContent ({
     lastLineBlank = thisLineBlank  
   }
 
-  if (endsWithDoubleBlank) trailingBlankLines = 2
-  else if (lastLineBlank) trailingBlankLines = 1
+  if (!config.endTaskAtEndOfFile) {
+    if (endsWithDoubleBlank) trailingBlankLines = 2
+    else if (lastLineBlank) trailingBlankLines = 1
+  }
 
   // Remove extra block comment tokens
   if (
@@ -364,4 +366,4 @@ export function toNumber(value) {
   if (value == null || value == undefined) return undefined; // Convert null or undefined to undefined
   const num = Number(value);
   return isNaN(num) ? undefined : num; // Return 0 if conversion fails, otherwise return the number
-}
+}

package/lib/config.js

@@ -174,6 +174,10 @@ export class Config {
     return this?.cards?.customCardTerminator
   }
 
+  get endTaskAtEndOfFile() {
+    return this?.cards?.endTaskAtEndOfFile === true
+  }
+
   set customCardTerminator(terminator) {
     this.settings.cards.customCardTerminator = terminator
   }

package/lib/file.js

@@ -899,8 +899,9 @@ export class File extends Emitter {
   }
 
   modifyTaskFromContent (task, content, config) {
-    content = trimBlankLines(content, this.isCodeFile())
-    task.updateFromContent(content)
+    const preserveBlankLines = config.endTaskAtEndOfFile && !this.isCodeFile()
+    if (!preserveBlankLines) content = trimBlankLines(content, this.isCodeFile())
+    task.updateFromContent(content, { preserveBlankLines })
     this.modifyTask(task, config)
   }
 
@@ -950,6 +951,11 @@ export class File extends Emitter {
       beforeDescContent += description + lineEnd
     } else {
       let rawTaskContent = rawTaskContentLines.join(lineEnd)
+      if (config.endTaskAtEndOfFile && !this.isCodeFile() && !isWrappedWithCardTag) {
+        // Blank lines belong to the task in EOF mode; retain its existing boundary.
+        const boundary = rawTaskContent.match(/(?:\n[\t ]*)+$/)?.[0] || ''
+        if (!description.endsWith(lineEnd)) description += boundary
+      }
       // Add card terminator to description
       if (
         this.isMarkDownFile() &&

package/lib/task.js

@@ -165,12 +165,11 @@ export class Task {
     this.content = this.text + lineEnd + this.descriptionString
   }
 
-  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')
+  updateFromContent(content, { preserveBlankLines = false } = {}) {
+    if (!preserveBlankLines) content = content.replace(/\n\s*\n\s*\n/g, '\n\n')
     let lines = eol.split(content)
     this.text = lines.shift().trimStart()
-    if (lines && lines.length > 1 && lines[lines.length - 1].trim() === '') lines.pop()
+    if (!preserveBlankLines && lines.length > 1 && lines[lines.length - 1].trim() === '') lines.pop()
     this.description = lines
     this.parse()
   }
@@ -913,4 +912,4 @@ export class Task {
       task.getId() == this.getId()
     )
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "2.5.3",
+  "version": "2.6.1",
   "description": "imdone-core",
   "repository": {
     "type": "git",

package/types/adapters/parsers/file/ReadStreamMarkdownParser.d.ts

@@ -1,5 +1,4 @@
 export class ReadStreamMarkdownParser extends ReadStreamTaskParser {
-    constructor(readStream: any, config: any);
     frontmatterLines: any[];
     collectingFrontmatter: boolean;
     frontmatterClosed: boolean;

package/types/adapters/parsers/file/ReadStreamTaskParser.d.ts

@@ -1,6 +1,7 @@
 export class ReadStreamTaskParser {
-    constructor(readStream: any);
+    constructor(readStream: any, config: any);
     readStream: any;
+    config: any;
     task: any;
     line: IteratorResult<string, any> | null;
     taskParsers: any[];

package/types/card.d.ts

@@ -151,7 +151,9 @@ export function newCard(task: any, _project: any, dontParse: any): {
     };
     getContent(): any;
     updateContent(): void;
-    updateFromContent(content: any): void;
+    updateFromContent(content: any, { preserveBlankLines }?: {
+        preserveBlankLines?: boolean | undefined;
+    }): void;
     toJSON(): /*elided*/ any & {
         allTags: any;
         allContext: any;

package/types/config.d.ts

@@ -41,6 +41,7 @@ export class Config {
     isAddCompletedMeta(): any;
     set customCardTerminator(terminator: any);
     get customCardTerminator(): any;
+    get endTaskAtEndOfFile(): boolean;
     get markdownOnly(): any;
     get views(): any;
     get appendNewCardsTo(): any;

package/types/file.d.ts

@@ -249,7 +249,9 @@ export class File extends Emitter<[never]> {
         };
         getContent(): any;
         updateContent(): void;
-        updateFromContent(content: any): void;
+        updateFromContent(content: any, { preserveBlankLines }?: {
+            preserveBlankLines?: boolean | undefined;
+        }): void;
         toJSON(): /*elided*/ any & {
             allTags: any;
             allContext: any;

package/types/task.d.ts

@@ -128,7 +128,9 @@ export class Task {
     };
     getContent(): any;
     updateContent(): void;
-    updateFromContent(content: any): void;
+    updateFromContent(content: any, { preserveBlankLines }?: {
+        preserveBlankLines?: boolean | undefined;
+    }): void;
     toJSON(): this & {
         allTags: any;
         allContext: any;