imdone-core 2.0.8 → 2.0.10

package/.husky/pre-commit

@@ -0,0 +1,7 @@
+npm run pre-commit
+
+if ! git diff --quiet; then
+  echo "❌ Commit blocked: Files were modified. Please stage and commit again."
+  exit 1
+fi
+echo "✅ Commit allowed: No files were modified."

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.10
+- Use static `get pluginName()` method to get the plugin name
+
+## 2.0.0
+- Refactor to esm
+
 ## 1.28.8
 - Allow Card and Board actions to return a value
 

package/lib/adapters/storage/config.js

@@ -7,6 +7,7 @@ import { Config } from '../../config.js'
 import { logger } from '../logger.js'
 
 const { CONFIG_DIR, CONFIG_FILE_YML } = constants
+
 export async function load(projectPath, configPath = _path.join(projectPath, CONFIG_FILE_YML)) {
   const configLike = await loadYamlConfig(configPath)
   return configLike && new Config(configLike)

package/lib/card.js

@@ -1,6 +1,5 @@
 import { Task } from './task.js'
 import _path from 'path'
-import _pick from 'lodash.pick'
 import _isFunction from 'lodash.isfunction'
 import _isObject from 'lodash.isobject'
 import _isEmpty from 'lodash.isempty'
@@ -100,39 +99,69 @@ export function newCard(task, _project, dontParse) {
     }
 
     get defaultData() {
+      // Extract all required properties in alphabetical order with destructuring
+      const {
+        allContext,
+        allMeta,
+        allTags,
+        beforeText,
+        completed,
+        content,
+        context,
+        created,
+        due,
+        filteredListName,
+        fullPath,
+        id,
+        interpretedContent,
+        lastLine,
+        line,
+        list,
+        meta,
+        metaKeys,
+        progress,
+        projectPath,
+        rawTask,
+        relPath,
+        source,
+        started,
+        tags,
+        text,
+        topics,
+        totals
+      } = this;
+      
+      // Return a new object with all the extracted properties
       return {
-        ..._pick(
-          this,
-          ...['beforeText',
-          'rawTask',
-          'id',
-          'text',
-          'progress',
-          'line',
-          'lastLine',
-          'list',
-          'source',
-          'due',
-          'created',
-          'started',
-          'completed',
-          'tags',
-          'context',
-          'meta',
-          'allTags',
-          'allContext',
-          'allMeta',
-          'metaKeys',
-          'content',
-          'filteredListName',
-          'interpretedContent',
-          'projectPath',
-          'relPath',
-          'fullPath',
-          'totals',
-          'topics'].sort()
-        ),
-      }
+        allContext,
+        allMeta,
+        allTags,
+        beforeText,
+        completed,
+        content,
+        context,
+        created,
+        due,
+        filteredListName,
+        fullPath,
+        id,
+        interpretedContent,
+        lastLine,
+        line,
+        list,
+        meta,
+        metaKeys,
+        progress,
+        projectPath,
+        rawTask,
+        relPath,
+        source,
+        started,
+        tags,
+        text,
+        topics,
+        totals
+      };
     }
 
     // TODO Add isInCodeFile property to card

package/lib/clone.js

@@ -0,0 +1,36 @@
+export function cloneDeep(obj, seen = new WeakMap()) {
+  if (obj === null || typeof obj !== 'object') return obj
+
+  if (seen.has(obj)) return seen.get(obj)
+
+  if (typeof obj === 'function') return obj
+
+  if (obj instanceof Date) return new Date(obj)
+  if (obj instanceof RegExp) return new RegExp(obj)
+  if (obj instanceof Map) {
+    const result = new Map()
+    seen.set(obj, result)
+    for (const [key, value] of obj.entries()) {
+      result.set(cloneDeep(key, seen), cloneDeep(value, seen))
+    }
+    return result
+  }
+
+  if (obj instanceof Set) {
+    const result = new Set()
+    seen.set(obj, result)
+    for (const value of obj.values()) {
+      result.add(cloneDeep(value, seen))
+    }
+    return result
+  }
+
+  const result = Array.isArray(obj) ? [] : {}
+  seen.set(obj, result)
+
+  for (const key of Object.keys(obj)) {
+    result[key] = cloneDeep(obj[key], seen)
+  }
+
+  return result
+}

package/lib/file.js

@@ -1,7 +1,6 @@
 import _isObject from 'lodash.isobject'
 import _assign from 'lodash.assign'
-import _omit from 'lodash.omit'
-import _get from 'lodash.get'
+import { omit } from './omit.js'
 import crypto from 'crypto'
 import Emitter from 'events'
 import path from 'path'
@@ -278,7 +277,7 @@ export class File extends Emitter {
       beforeTextModified = trackMarkdownChecklistChanges({task, config, modify})
       
       if (
-        _get(config, 'settings.cards.trackChanges') &&
+        config?.settings?.cards?.trackChanges &&
         task.hasListChanged(lists)
       ) {
         const list = task.list
@@ -1016,7 +1015,7 @@ export class File extends Emitter {
   }
 
   toJSON () {
-    return _omit(this, ['domain', '_events', '_maxListeners'])
+    return omit(this, ['domain', '_events', '_maxListeners'])
   }
 
   getRepoId () {

package/lib/index.js

@@ -2,6 +2,7 @@ export * from './FileProjectContext.js';
 export * from './ProjectContext.js';
 export * from './card.js';
 export * from './checksum.js';
+export * from './clone.js';
 export * from './config.js';
 export * from './constants.js';
 export * from './default-settings.js';
@@ -10,6 +11,7 @@ export * from './get-tasks-to-modify.js';
 export * from './languages.js';
 export * from './list.js';
 export * from './migrate-config.js';
+export * from './omit.js';
 export * from './project-factory.js';
 export * from './project.js';
 export * from './repository.js';

package/lib/migrate-config.js

@@ -1,7 +1,7 @@
-import _cloneDeep from 'lodash.clonedeep'
 import _path from 'path'
 import uniqid from 'uniqid'
 import { defaultSettings as _defaultSettings } from './default-settings.js'
+import { cloneDeep } from './clone.js'
 
 export function buildMigrateConfig (repo, defaultSettings = _defaultSettings) {
   const path = repo.path
@@ -149,8 +149,8 @@ export function buildMigrateConfig (repo, defaultSettings = _defaultSettings) {
         config.settings.kudosProbability = 0.33
       }
 
-      const defaultCardsSettings = _cloneDeep(defaultSettings.cards)
-      const cardsSettings = _cloneDeep(config.settings.cards)
+      const defaultCardsSettings = cloneDeep(defaultSettings.cards)
+      const cardsSettings = cloneDeep(config.settings.cards)
 
       delete defaultSettings.cards
       delete config.settings.cards

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

@@ -1,5 +1,4 @@
 import _path from 'path'
-import _cloneDeep from 'lodash.clonedeep'
 import _isFunction from 'lodash.isfunction'
 import _isUndefined from 'lodash.isundefined'
 import _assign from 'lodash.assign'
@@ -173,7 +172,7 @@ export function fileSystemStoreMixin(repo, fs = realFs) {
   }
 
   repo.updateConfig = async function (loadedConfig) {
-    var baseConfig = _cloneDeep(DEFAULT_CONFIG)
+    var baseConfig = structuredClone(DEFAULT_CONFIG)
     var include_lists = baseConfig.code.include_lists
     const currentConfig = repo.config
     if (currentConfig && currentConfig.code)
@@ -192,7 +191,7 @@ export function fileSystemStoreMixin(repo, fs = realFs) {
     await repo.migrateTasksByConfig(currentConfig, newConfig)
     repo.config = newConfig
     repo.config.code.include_lists = include_lists
-    var _languages = _cloneDeep(languages)
+    var _languages = structuredClone(languages)
     repo.languages = repo.config.languages
       ? _assign(_languages, repo.config.languages)
       : _languages

package/lib/omit.js

@@ -0,0 +1,9 @@
+export function omit(obj, keys) {
+  const result = {}
+  for (const key in obj) {
+    if (Object.prototype.hasOwnProperty.call(obj, key) && !keys.includes(key)) {
+      result[key] = obj[key]
+    }
+  }
+  return result
+}

package/lib/plugins/archive-plugin.js

@@ -7,6 +7,10 @@ export default class ArchivePlugin extends Plugin {
     super(project)
   }
 
+  static get pluginName() {
+    return 'ArchivePlugin'
+  }
+
   get config() {
     return this.project.config
   }

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

@@ -5,6 +5,10 @@ export default class DefaultBoardActionsPlugin extends Plugin {
     super(project)
   }
 
+  static get pluginName() {
+    return 'DefaultBoardActionsPlugin'
+  }
+
   getBoardActions() {
     const project = this.project
     const isWindows = process.platform === 'win32'

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

@@ -19,6 +19,10 @@ export default class DefaultBoardPropertiesPlugin extends Plugin {
     this.templates = {}
   }
 
+  static get pluginName() {
+    return 'DefaultBoardPropertiesPlugin'
+  }
+
   async onBeforeBoardUpdate() {
     this.templates = await this.getTemplates()
   }

package/lib/plugins/epic-plugin.js

@@ -15,6 +15,10 @@ export default class EpicPlugin extends Plugin {
     this.epics = {}
   }
 
+  static get pluginName() {
+    return 'EpicPlugin'
+  }
+
   async onBeforeBoardUpdate() {
     this.epics = {}
   }

package/lib/plugins/extension-plugin.js

@@ -13,6 +13,10 @@ export default class ExtensionPlugin extends Plugin {
     this.configDir = _path.join(project.path, '.imdone')
   }
 
+  static get pluginName() {
+    return 'ExtensionPlugin'
+  }
+
   async init() {
     this.cardActionsFunction = await this.loadExtensionModule(
       () => [],

package/lib/plugins/persist-tags-plugin.js

@@ -7,6 +7,10 @@ export default class PersistTagsPlugin extends Plugin {
     super(project)
   }
 
+  static get pluginName() {
+    return 'PersistTagsPlugin'
+  }
+
   async onBoardUpdate() {
     await save(this.project.allTags.sort(), this.project.path)
   }

package/lib/plugins/plugin-manager.js

@@ -2,10 +2,9 @@ import Emitter from 'events'
 import Plugin from 'imdone-api'
 import _path from 'path'
 import { downloadPlugin } from '../adapters/git-download.js'
-import rimraf from 'rimraf'
 import chokidar from 'chokidar'
 import debounce from 'lodash.debounce'
-import { exists, mkdir, readdir } from '../adapters/file-gateway.js'
+import { exists, mkdir, readdir, rm } from '../adapters/file-gateway.js'
 import { appContext } from '../context/ApplicationContext.js'
 // import { createRequire } from 'node:module';
 
@@ -83,26 +82,21 @@ export class PluginManager extends Emitter {
   }
 
   async uninstallPlugin(pluginName) {
-    return new Promise((resolve, reject) => {
       logger.log('Preparing to uninstall plugin:', pluginName)
       const pluginClassName = Object.keys(this.pluginsMap).find((key) => {
         return this.getPlugin(key).info.name === pluginName
       })
       if (!pluginClassName) {
-        return reject(new Error('Unable to find plugin:' + pluginName))
+        throw new Error('Unable to find plugin:' + pluginName)
       }
       const { info } = this.getPlugin(pluginClassName)
       const { path } = info
       // const pkg = { version, name }
       logger.log('Uninstalling:', info)
 
-      rimraf(path, (err) => {
-        if (err) return reject(err)
-        delete this.pluginsMap[pluginClassName]
-        this.emit('plugin-uninstalled', pluginName)
-        resolve()
-      })
-    })
+      await rm(path, { recursive: true, force: true })
+      delete this.pluginsMap[pluginClassName]
+      this.emit('plugin-uninstalled', pluginName)
   }
 
   async installPlugin({ name, version }) {
@@ -190,9 +184,9 @@ export class PluginManager extends Emitter {
   }
   
   async createPlugin(pluginClass, path = undefined) {
-    if (!this.isPlugin(pluginClass))
+    const name = pluginClass.pluginName
+    if (!name || !this.isPlugin(pluginClass))
       throw new Error(`${pluginClass.name} is not a plugin`)
-    const name = pluginClass.name.toString()
     const pluginInstance = new pluginClass(this.project)
     const packageInfo = await this.getPackageInfo(path)
     let info = {

package/lib/project.js

@@ -1,7 +1,6 @@
 import { Project } from 'imdone-api/lib/project.js';
 import { PluginManager } from './plugins/plugin-manager.js';
 import { Repository } from './repository.js';
-import _cloneDeep from 'lodash.clonedeep';
 import { newCard } from './card.js';
 import { constants } from './constants.js';
 const { JOURNAL_TYPE, CONFIG_DIR } = constants;
@@ -15,6 +14,7 @@ import _isString from 'lodash.isstring';
 import _isFunction from 'lodash.isfunction';
 import { exec } from 'node:child_process';
 import { sort } from 'fast-sort';
+import { cloneDeep } from './clone.js'
 import { Task } from './task.js';
 import eol from 'eol';
 import { renderMarkdown, extractWikilinkTopics } from './adapters/markdown.js';
@@ -484,7 +484,7 @@ export class WorkerProject extends Project {
   filterLists(filter, lists = this.lists) {
     return lists.map((list) => {
       let newList = { ...list, tasks: [] }
-      newList = _cloneDeep(newList)
+      newList = cloneDeep(newList)
       newList.tasks = Repository.query(list.tasks, filter)
       return newList
     })

package/lib/repository.js

@@ -1,7 +1,7 @@
 import _isFunction from 'lodash.isfunction'
 import _isUndefined from 'lodash.isundefined'
 import _isString from 'lodash.isstring'
-import _omit from 'lodash.omit'
+import { omit } from './omit.js'
 import _reject from 'lodash.reject'
 import _noop from 'lodash.noop'
 import _some from 'lodash.some'
@@ -395,7 +395,7 @@ export class Repository extends Emitter {
   async addList (list) {
     if (this.listExists(list.name)) return;
 
-    list = _omit(list, 'tasks');
+    list = omit(list, 'tasks');
     this.config.lists.push(new List(list));
 
     if (!list.filter && !/[a-z]/.test(list.name)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "description": "imdone-core",
   "repository": {
     "type": "git",
@@ -14,15 +14,18 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "npm run build:docs && npm run build:docs:index && npm run coverage && npm run build:index && npm run build:types",
+    "build": "npm run pre-commit && npm run coverage",
     "build:docs": "doctoc --github --notitle README.md",
     "build:docs:index": "node scripts/index-markdown.js",
     "build:index": "node scripts/generate-index.js",
     "build:types": "tsc --noEmit false",
     "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-ci": "vitest --run",
-    "serve": "npx docsify-cli serve"
+    "serve": "npx docsify-cli serve",
+    "prepare": "husky"
   },
   "keywords": [
     "imdone",
@@ -55,26 +58,20 @@
     "find-up-simple": "^1.0.1",
     "gray-matter": "^4.0.2",
     "ignore": "^5.2.0",
-    "imdone-api": "^2.0.0",
+    "imdone-api": "^2.0.1",
     "isbinaryfile": "^5.0.4",
     "js-yaml": "^3.14.1",
     "json-fns": "^1.0.0",
     "lodash.assign": "^4.2.0",
-    "lodash.clone": "^4.5.0",
-    "lodash.clonedeep": "^4.5.0",
     "lodash.debounce": "^4.0.8",
-    "lodash.get": "^4.4.2",
     "lodash.groupby": "^4.6.0",
     "lodash.isempty": "^4.4.0",
-    "lodash.isequal": "^4.5.0",
     "lodash.isfunction": "^3.0.9",
     "lodash.isnumber": "^3.0.3",
     "lodash.isobject": "^3.0.2",
     "lodash.isstring": "^4.0.1",
     "lodash.isundefined": "^3.0.1",
     "lodash.noop": "^3.0.1",
-    "lodash.omit": "^4.5.0",
-    "lodash.pick": "^3.1.0",
     "lodash.reject": "^4.6.0",
     "lodash.remove": "^4.7.0",
     "lodash.some": "^4.6.0",
@@ -96,7 +93,6 @@
     "prompts": "^2.4.2",
     "readdirp": "^4.1.2",
     "remove-markdown": "^0.3.0",
-    "rimraf": "^3.0.2",
     "sanitize-filename": "^1.6.3",
     "sift": "^17.1.3",
     "simple-git": "^3.19.1",
@@ -114,13 +110,9 @@
     "esbuild": "^0.25.1",
     "expect.js": "~0.3.1",
     "fs-extra": "^11.1.0",
+    "husky": "^9.1.7",
     "json-stringify-safe": "~5.0.0",
-    "mocha": "^11.1.0",
-    "mocha-each": "^2.0.1",
     "prettier": "^2.5.1",
-    "should": "13.1.3",
-    "sinon": "^19.0.2",
-    "sinon-chai": "^4.0.0",
     "typescript": "^5.8.2",
     "vitest": "^3.0.8"
   }

package/types/card.d.ts

@@ -15,7 +15,36 @@ export function newCard(task: any, _project: any, dontParse: any): {
     readonly projectPath: any;
     readonly relPath: any;
     readonly fullPath: string | undefined;
-    readonly defaultData: any;
+    readonly defaultData: {
+        allContext: any;
+        allMeta: any;
+        allTags: any;
+        beforeText: any;
+        completed: any;
+        content: any;
+        context: any;
+        created: any;
+        due: any;
+        filteredListName: any;
+        fullPath: string | undefined;
+        id: any;
+        interpretedContent: any;
+        lastLine: any;
+        line: any;
+        list: any;
+        meta: any;
+        metaKeys: string[] | undefined;
+        progress: any;
+        projectPath: any;
+        rawTask: any;
+        relPath: any;
+        source: any;
+        started: any;
+        tags: any;
+        text: any;
+        topics: string[] | undefined;
+        totals: any;
+    };
     initData(): void;
     dataKeys: string[] | undefined;
     data: any;

package/types/clone.d.ts

@@ -0,0 +1 @@
+export function cloneDeep(obj: any, seen?: WeakMap<WeakKey, any>): any;

package/types/file.d.ts

@@ -113,7 +113,36 @@ export class File extends Emitter<[never]> {
         readonly projectPath: any;
         readonly relPath: any;
         readonly fullPath: string | undefined;
-        readonly defaultData: any;
+        readonly defaultData: {
+            allContext: any;
+            allMeta: any;
+            allTags: any;
+            beforeText: any;
+            completed: any;
+            content: any;
+            context: any;
+            created: any;
+            due: any;
+            filteredListName: any;
+            fullPath: string | undefined;
+            id: any;
+            interpretedContent: any;
+            lastLine: any;
+            line: any;
+            list: any;
+            meta: any;
+            metaKeys: string[] | undefined;
+            progress: any;
+            projectPath: any;
+            rawTask: any;
+            relPath: any;
+            source: any;
+            started: any;
+            tags: any;
+            text: any;
+            topics: string[] | undefined;
+            totals: any;
+        };
         initData(): void;
         dataKeys: string[] | undefined;
         data: any;
@@ -265,7 +294,7 @@ export class File extends Emitter<[never]> {
     getTaskAtLine(line: any): any;
     getLinePos(lineNo: any): any;
     getLineNumber(pos: any, content?: any): number;
-    toJSON(): any;
+    toJSON(): {};
     getRepoId(): any;
     getPath(): any;
     getFullPath(): string;

package/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./FileProjectContext.js";
 export * from "./ProjectContext.js";
 export * from "./card.js";
 export * from "./checksum.js";
+export * from "./clone.js";
 export * from "./config.js";
 export * from "./constants.js";
 export * from "./default-settings.js";
@@ -10,6 +11,7 @@ export * from "./get-tasks-to-modify.js";
 export * from "./languages.js";
 export * from "./list.js";
 export * from "./migrate-config.js";
+export * from "./omit.js";
 export * from "./project-factory.js";
 export * from "./project.js";
 export * from "./repository.js";

package/types/omit.d.ts

@@ -0,0 +1 @@
+export function omit(obj: any, keys: any): {};

package/types/plugins/archive-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class ArchivePlugin {
+    static get pluginName(): string;
     constructor(project: any);
     get config(): any;
     get fileGateway(): any;

package/types/plugins/default-board-actions-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class DefaultBoardActionsPlugin {
+    static get pluginName(): string;
     constructor(project: any);
     getBoardActions(): {
         title: string;

package/types/plugins/default-board-properties-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class DefaultBoardPropertiesPlugin {
+    static get pluginName(): string;
     constructor(project: any);
     templates: {};
     onBeforeBoardUpdate(): Promise<void>;

package/types/plugins/epic-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class EpicPlugin {
+    static get pluginName(): string;
     constructor(project: any);
     epics: {};
     onBeforeBoardUpdate(): Promise<void>;

package/types/plugins/extension-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class ExtensionPlugin {
+    static get pluginName(): string;
     constructor(project: any);
     configDir: string;
     init(): Promise<void>;

package/types/plugins/persist-tags-plugin.d.ts

@@ -1,4 +1,5 @@
 export default class PersistTagsPlugin {
+    static get pluginName(): string;
     constructor(project: any);
     onBoardUpdate(): Promise<void>;
 }

package/types/plugins/plugin-manager.d.ts

@@ -10,7 +10,7 @@ export class PluginManager extends Emitter<[never]> {
     stopDevMode(): void;
     initDevMode(): void;
     reloadPlugins(): Promise<void>;
-    uninstallPlugin(pluginName: any): Promise<any>;
+    uninstallPlugin(pluginName: any): Promise<void>;
     installPlugin({ name, version }: {
         name: any;
         version: any;

package/types/project.d.ts

@@ -150,7 +150,7 @@ export class WorkerProject {
         name: any;
         version: any;
     }): Promise<void>;
-    uninstallPlugin(name: any): Promise<any>;
+    uninstallPlugin(name: any): Promise<void>;
     refresh(): Promise<void>;
     renderMarkdown(content: any, filePath: any): any;
     extractWikilinkTopics(markdown: any): string[];