imdone-core 2.0.11 → 2.0.13

package/.env

@@ -0,0 +1,6 @@
+
+# Jira environment variables
+
+# JIRA_AUTH_BASIC=true # Set to false to use Bearer token auth.
+# JIRA_USERNAME="<your jira username>" # e.g. your email address. Not needed if using Bearer token auth.
+# JIRA_TOKEN="<your personal access token>"

package/.imdoneignore

@@ -11,3 +11,4 @@ imdone-export.json
 .imdone/templates
 .imdone
 notes/archive
+_lib

package/lib/adapters/logger.js

@@ -1,5 +1,3 @@
-import { info, error as consoleError, warn as consoleWarn } from 'console'
-
 // Log levels with numeric values for comparison
 const LogLevel = {
   ERROR: 0,
@@ -10,7 +8,7 @@ const LogLevel = {
   NONE: -1  // Use this to disable all logging
 }
 
-function getCallerInfo() {
+export function getCallerInfo() {
   const err = new Error();
   const stack = err.stack?.split('\n');
 
@@ -47,10 +45,13 @@ function getCallerInfo() {
   return {};
 }
 
+const DEFAULT_LOG_LEVEL = LogLevel.WARN;
+const DEFAULT_LOG_LEVEL_NAME = Object.keys(LogLevel).find(key => LogLevel[key] === DEFAULT_LOG_LEVEL);
+
 class Logger {
   constructor() {
     // Default log level
-    this.level = LogLevel.INFO
+    this.level = DEFAULT_LOG_LEVEL
   }
 
   // Setter for log level
@@ -60,7 +61,8 @@ class Logger {
     } else if (typeof level === 'number' && level >= -1 && level <= 4) {
       this.level = level
     } else {
-      consoleWarn(`Invalid log level: ${level}. Using default INFO level.`)
+      this.level = DEFAULT_LOG_LEVEL
+      console.warn(`Invalid log level: ${level}. Using default ${DEFAULT_LOG_LEVEL_NAME} level.`)
     }
     return this
   }
@@ -85,37 +87,37 @@ class Logger {
 
   log(...args) {
     if (this.shouldLog(LogLevel.INFO)) {
-      info(...this.formatMessage(args));
+      console.log(...this.formatMessage(args));
     }
   }
 
   error(...args) {
     if (this.shouldLog(LogLevel.ERROR)) {
-      consoleError(...this.formatMessage(args));
+      console.error(...this.formatMessage(args));
     }
   }
 
   warn(...args) {
     if (this.shouldLog(LogLevel.WARN)) {
-      consoleWarn(...this.formatMessage(args));
+      console.warn(...this.formatMessage(args));
     }
   }
 
   info(...args) {
     if (this.shouldLog(LogLevel.INFO)) {
-      info(...this.formatMessage(args));
+      console.info(...this.formatMessage(args));
     }
   }
 
   debug(...args) {
     if (this.shouldLog(LogLevel.DEBUG)) {
-      info(`[DEBUG]`, ...this.formatMessage(args));
+      console.debug(`[DEBUG]`, ...this.formatMessage(args));
     }
   }
 
   trace(...args) {
     if (this.shouldLog(LogLevel.TRACE)) {
-      info(`[TRACE]`, ...this.formatMessage(args));
+      console.trace(`[TRACE]`, ...this.formatMessage(args));
     }
   }
 

package/lib/config.js

@@ -141,6 +141,10 @@ export class Config {
     return this?.cards?.tagPrefix ?? '+'
   }
 
+  getCommentTagsOnly() {
+    return this?.cards?.commentTagsOnly ?? false
+  }
+
   getTaskPrefix() {
     return this?.cards?.taskPrefix ?? '##'
   }

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

@@ -18,6 +18,7 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
   const _init = repo.init
   let initializing = false
   let refreshing = false
+  let watcherPaused = false
 
   function ready() {
     return !initializing && !refreshing
@@ -30,6 +31,30 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
     }
   }
 
+  // Add function to pause the watcher
+  repo.pauseWatcher = async function() {
+    if (repo.watcher && !watcherPaused) {
+      logger.info('Pausing file watcher for:', repo.path)
+      await repo.watcher.close()
+      watcherPaused = true
+      repo.emit('watcher.paused')
+      return true
+    }
+    return false
+  }
+
+  // Add function to unpause the watcher
+  repo.unpauseWatcher = async function() {
+    if (watcherPaused) {
+      logger.info('Unpausing file watcher for:', repo.path)
+      await repo.initWatcher()
+      watcherPaused = false
+      repo.emit('watcher.resumed')
+      return true
+    }
+    return false
+  }
+
   // READY Refactor init to async/await
   // #esm-migration #important
   // <!--
@@ -69,7 +94,10 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
     refreshing = true
     try {
       const files = await _refresh.call(repo)
-      await repo.initWatcher()
+      // Only initialize watcher if it's not paused
+      if (!watcherPaused) {
+        await repo.initWatcher()
+      }
       refreshing = false
       return files
     } catch (err) {
@@ -108,6 +136,11 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
   // defer:2025-03-18
   // -->
   repo.initWatcher = async () => {
+    // Close existing watcher if it exists
+    if (repo.watcher) {
+      await repo.watcher.close()
+    }
+
     return new Promise(async (resolve, reject) => {
       logger.log('initializing watcher for:', repo.path)
       repo.watcher = chokidar.watch(repo.path, {

package/lib/plugins/index.js

@@ -1,7 +1,6 @@
 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';

package/lib/task.js

@@ -188,6 +188,10 @@ export class Task {
   getTagPrefix () {
     return this.config?.getTagPrefix()
   }
+
+  getCommentTagsOnly () {
+    return this.config?.getCommentTagsOnly()
+  }
   
   static addToLastCommentInContent (content, toAdd, newLine) {
     // BACKLOG respect padding of task prefix for list items
@@ -315,14 +319,16 @@ export class Task {
       'gmiu'
     )
   }
-  static getTags (text, prefix = '+') {
+  static getTags (text, prefix = '+', commentTagsOnly = false) {
     const tags = [];
     const codePositions = Task.getMarkdownCodePositions(text);
     const linkLabelPositions = Task.getMarkdownLinkLabelPositions(text);
+    const commentPositions = Task.getCommentPositions(text);
     let result;
     const re = Task.getTagRegexp(prefix);
 
     while ((result = re.exec(text)) !== null) {
+      if (commentTagsOnly && !Task.isResultInComment(commentPositions, result.index)) continue;
       if (Task.isResultInMarkdownCode(codePositions, result.index)) continue;
       if (Task.isResultInMarkdownLinkLabel(linkLabelPositions, result.index)) continue;
       const tag = result[2];
@@ -349,6 +355,22 @@ export class Task {
     return linkLabelPositions.some(pos => index >= pos.start && index < pos.end);
   };
 
+  static getCommentPositions (text) {
+    const positions = [];
+    const re = /<!--[\s\S]*?-->/g;
+    let match;
+
+    while ((match = re.exec(text)) !== null) {
+      positions.push({ start: match.index, end: re.lastIndex });
+    }
+
+    return positions;
+  }
+
+  static isResultInComment (commentPositions, index) {
+    return commentPositions.some(pos => index >= pos.start && index < pos.end);
+  }
+
   static ContextRegExp = new RegExp(
     `(^|\\s)@([${Task.AnyLanguageGroup}${Task.EmojiGroup}]+)`,
     'gmiu'
@@ -567,7 +589,7 @@ export class Task {
   }
 
   parseTodoTxt () {
-    this.tags = Task.getTags(this.getRawTextAndDescription(), this.getTagPrefix())
+    this.tags = Task.getTags(this.getRawTextAndDescription(), this.getTagPrefix(), this.getCommentTagsOnly())
     this.context = Task.getContext(this.getRawTextAndDescription())
     this.meta = Task.getMetaData(this.config, this)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "description": "imdone-core",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "coverage": "vitest --run --coverage",
     "link": "npm link ../imdone-api",
     "pre-commit": "npm run build:docs && npm run build:docs:index && npm run build:index && npm run build:types",
-    "test": "vitest --run",
+    "test": "npm run coverage",
     "test-ci": "vitest --run",
     "serve": "npx docsify-cli serve",
     "prepare": "husky"

package/types/adapters/logger.d.ts

@@ -1,3 +1,14 @@
+export function getCallerInfo(): {
+    functionName?: undefined;
+    file?: undefined;
+    line?: undefined;
+    column?: undefined;
+} | {
+    functionName: string;
+    file: string;
+    line: number;
+    column: number;
+};
 export const logger: Logger;
 declare class Logger {
     level: number;

package/types/card.d.ts

@@ -158,6 +158,7 @@ export function newCard(task: any, _project: any, dontParse: any): {
         expand: boolean;
     };
     getTagPrefix(): any;
+    getCommentTagsOnly(): any;
     addToLastCommentInContent(content: any, toAdd: any, newLine: any): string;
     getCheckedData(): {
         pad: number;

package/types/config.d.ts

@@ -32,6 +32,7 @@ export class Config {
     getNewCardSyntax(): any;
     isMetaNewLine(): any;
     getTagPrefix(): any;
+    getCommentTagsOnly(): any;
     getTaskPrefix(): any;
     isAddCheckBoxTasks(): any;
     isAddCompletedMeta(): any;

package/types/file.d.ts

@@ -256,6 +256,7 @@ export class File extends Emitter<[never]> {
             expand: boolean;
         };
         getTagPrefix(): any;
+        getCommentTagsOnly(): any;
         addToLastCommentInContent(content: any, toAdd: any, newLine: any): string;
         getCheckedData(): {
             pad: number;

package/types/plugins/index.d.ts

@@ -1,7 +1,6 @@
 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";

package/types/task.d.ts

@@ -18,12 +18,17 @@ export class Task {
     static AnyLanguageGroup: string;
     static EmojiGroup: string;
     static getTagRegexp(prefix?: string): RegExp;
-    static getTags(text: any, prefix?: string): string[];
+    static getTags(text: any, prefix?: string, commentTagsOnly?: boolean): string[];
     static getMarkdownLinkLabelPositions(text: any): {
         start: number;
         end: number;
     }[];
     static isResultInMarkdownLinkLabel(linkLabelPositions: any, index: any): any;
+    static getCommentPositions(text: any): {
+        start: number;
+        end: number;
+    }[];
+    static isResultInComment(commentPositions: any, index: any): any;
     static ContextRegExp: RegExp;
     static getContext(text: any): string[];
     static MetaRegExp: RegExp;
@@ -124,6 +129,7 @@ export class Task {
         expand: boolean;
     };
     getTagPrefix(): any;
+    getCommentTagsOnly(): any;
     addToLastCommentInContent(content: any, toAdd: any, newLine: any): string;
     getCheckedData(): {
         pad: number;

package/vitest.config.js

@@ -8,6 +8,8 @@ export default defineConfig({
       reporter: ["text"], // Ensure text output is included
       clean: false,
       reportOnFailure: true,
+      include: ['lib'], // Only include files from src/
+      exclude: ['_lib', 'lib/**/index.*']
     },
   },
 });

package/lib/plugins/default-plugins.js

@@ -1,7 +0,0 @@
-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'
-