imdone-core 1.54.10 → 2.0.1

package/lib/tools.js

@@ -1,43 +1,12 @@
-'use strict'
-
-var _isFunction = require('lodash.isfunction'),
-  _noop = require('lodash.noop'),
-  crypto = require('crypto'),
-  _path = require('path'),
-  fastSort = require('fast-sort/dist/sort.js'),
-  eol = require('eol'),
-  max_bytes = 512
-
-function mkdirp(fs, path, mode, cb, position) {
-  if (_isFunction(mode)) {
-    cb = mode
-    mode = '0777'
-  }
-  if (!cb) cb = _noop
-
-  var parts = _path.normalize(path).split(_path.sep)
-  mode = mode || process.umask()
-  position = position || 0
+import _isFunction from 'lodash.isfunction'
+import _noop from 'lodash.noop'
+import crypto from 'crypto'
+import _path from 'path'
+import { sort } from 'fast-sort'
+import eol from 'eol'
+import escapeRegExp from 'escape-string-regexp'
 
-  if (position >= parts.length) {
-    return cb()
-  }
-
-  var directory = parts.slice(0, position + 1).join(_path.sep) || _path.sep
-  fs.stat(directory, function (err) {
-    if (err === null) {
-      mkdirp(fs, path, mode, cb, position + 1)
-    } else {
-      fs.mkdir(directory, mode, function (err) {
-        if (err && err.code != 'EEXIST') {
-          return cb(err)
-        } else {
-          mkdirp(fs, path, mode, cb, position + 1)
-        }
-      })
-    }
-  })
-}
+const max_bytes = 512
 
 function isBinaryCheck(bytes, size) {
   if (size === 0) return false
@@ -86,18 +55,39 @@ function isBinaryCheck(bytes, size) {
   return false
 }
 
-module.exports = {
-  escapeRegExp: require('escape-string-regexp'),
-  userHome: function () {
+function deepEqual(a, b) {
+  if (a === b) return true; // Same reference
+
+  if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {
+    return false; // Different types or one is null
+  }
+
+  if (Array.isArray(a) !== Array.isArray(b)) return false; // One is array, one is object
+
+  const keysA = Object.keys(a);
+  const keysB = Object.keys(b);
+  if (keysA.length !== keysB.length) return false; // Different number of keys
+
+  return keysA.every((key) => keysB.includes(key) && deepEqual(a[key], b[key]));
+}
+
+export const tools =  {
+  union(...arrays) {
+    return [...new Set(arrays.flat())];
+  },
+  escapeRegExp(str) {
+    return escapeRegExp(str)
+  },
+  userHome() {
     return process.env.HOME || process.env.HOMEPATH || process.env.USERPROFILE
   },
-
+  deepEqual,
   /**
    * Description
    * @method user
    * @return LogicalExpression
    */
-  user: function () {
+  user() {
     return process.env.USER || process.env.USERNAME
   },
 
@@ -107,13 +97,14 @@ module.exports = {
    * @param {} cb
    * @return ConditionalExpression
    */
-  cb: function (cb) {
+  cb(cb) {
     return _isFunction(cb) ? cb : _noop
   },
 
-  inMixinsNoop: function (cb) {
+  inMixinsNoop(cb) {
     cb = this.cb(cb)
-    cb(new Error('Implemented in mixins'))
+    if (cb) return cb(new Error('Implemented in mixins'))
+    throw new Error('Implemented in mixins')
   },
 
   /**
@@ -176,73 +167,8 @@ module.exports = {
   },
 
   isBinaryCheck: isBinaryCheck,
-
-  readdirSyncRecursive: function (fs, baseDir) {
-    baseDir = baseDir.replace(/\/$/, '')
-
-    var readdirSyncRecursive = function (baseDir) {
-      var files = [],
-        curFiles,
-        nextDirs,
-        isDir = function (fname) {
-          return fs.existsSync(_path.join(baseDir, fname))
-            ? fs.statSync(_path.join(baseDir, fname)).isDirectory()
-            : false
-        },
-        prependBaseDir = function (fname) {
-          return _path.join(baseDir, fname)
-        }
-
-      curFiles = fs.readdirSync(baseDir)
-      nextDirs = curFiles.filter(isDir)
-      curFiles = curFiles.map(prependBaseDir)
-
-      files = files.concat(curFiles)
-
-      while (nextDirs.length) {
-        files = files.concat(
-          readdirSyncRecursive(_path.join(baseDir, nextDirs.shift()))
-        )
-      }
-
-      return files
-    }
-
-    // convert absolute paths to relative
-    var fileList = readdirSyncRecursive(baseDir).map(function (val) {
-      return _path.relative(baseDir, val)
-    })
-
-    return fileList
-  },
-
-  mkdirSyncRecursive: function (fs, path, mode) {
-    var self = this
-    path = _path.normalize(path)
-
-    try {
-      fs.mkdirSync(path, mode)
-    } catch (err) {
-      if (err.code == 'ENOENT') {
-        var slashIdx = path.lastIndexOf(_path.sep)
-
-        if (slashIdx > 0) {
-          var parentPath = path.substring(0, slashIdx)
-          this.mkdirSyncRecursive(parentPath, mode)
-          this.mkdirSyncRecursive(path, mode)
-        } else {
-          throw err
-        }
-      } else if (err.code == 'EEXIST') {
-        return
-      } else {
-        throw err
-      }
-    }
-  },
-  mkdirp: mkdirp,
   sortTasks(tasks) {
-    return fastSort(tasks).asc([u => u.order, u => u.text])
+    return sort(tasks).asc([u => u.order, u => u.text])
   },
   hasBlankLines(content) {
     return new RegExp(`^\\s*${String(eol.auto)}`, 'gm').test(content)

package/lib/usecases/actions.js

@@ -0,0 +1,32 @@
+import { createFileSystemProject } from '../project-factory.js';
+import { load } from '../adapters/storage/config.js';
+import { logger } from '../adapters/logger.js';
+
+/**
+ * Initializes and returns a project instance.
+ * @param {string} projectPath - The path to the project.
+ * @param {string} configPath - The path to the configuration file.
+ * @returns {Promise<Object>} - The initialized project instance.
+ */
+async function initializeProject(projectPath, configPath) {
+  const path = projectPath;
+  const config = await load(projectPath, configPath);
+  const project = createFileSystemProject({ path, config });
+  await project.init();
+  await project.toImdoneJSON();
+
+  return project;
+}
+
+export async function executeBoardAction({ projectPath, configPath, task, action }) {
+  const project = await initializeProject(projectPath, configPath);
+  const file = task && project.getFile(task.filePath);
+  const activeTask = file && task.line > -1 && file.getTaskAtLine(task.line);
+  await project.performBoardAction(action, activeTask);
+}
+
+export async function listAvailableActions(projectPath, configPath, plugin) {
+  const project = await initializeProject(projectPath, configPath);
+  logger.log('\nAvailable actions:');
+  logger.log(JSON.stringify(project.boardActions, null, 2));
+}

package/lib/usecases/get-project-tags.js

@@ -1,16 +1,7 @@
-const {
-  load
-} = require('../adapters/storage/tags.js')
+import { load } from '../adapters/storage/tags.js'
+import { findImdonePath } from '../adapters/storage/config.js'
 
-const {
-  findImdonePath
-} = require('../adapters/storage/config.js')
-
-module.exports = {
-  getTags
-}
-
-async function getTags(filePath) {
+export async function getTags(filePath) {
   const projectPath = await findImdonePath(filePath)
   return await load(projectPath)
 }

package/lib/usecases/get-tasks-in-file.js

@@ -1,12 +1,9 @@
-const { loadForFilePath } = require('../adapters/storage/config')
-const { getFileParser } = require('../adapters/parsers/file/LocalFileParserFactory')
-const { Readable } = require('stream');
+import { loadForFilePath } from '../adapters/storage/config.js';
+import { getFileParser } from '../adapters/parsers/file/LocalFileParserFactory.js';
+import { Readable } from 'node:stream';
 
-module.exports = {
-  getTasks  
-}
 
-async function getTasks({filePath, content}) {
+export async function getTasks({filePath, content}) {
   const config = await loadForFilePath(filePath)
 
   const readStream = new Readable({

package/lib/usecases/index.js

@@ -0,0 +1,4 @@
+export * from './actions.js';
+export * from './get-imdone-url.js';
+export * from './get-project-tags.js';
+export * from './get-tasks-in-file.js';

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "imdone-core",
-  "version": "1.54.10",
+  "version": "2.0.1",
   "description": "imdone-core",
-  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/imdone/imdone-core.git"
+  },
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "type": "module",
   "bin": {
-    "imdone-cli": "./cli.js"
+    "imdone-cli": "lib/cli.js"
   },
   "scripts": {
-    "build": "doctoc --github --notitle README.md && npm test",
-    "coverage": "nyc --reporter=lcov --reporter=text --reporter=html mocha --exit",
-    "lint": "jshint ./lib",
-    "mocha": "mocha --exit",
-    "test": "export NODE_ENV=test && npm run coverage",
-    "test-debug": "mocha debug",
+    "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: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",
+    "test": "vitest --run",
+    "test-ci": "vitest --run",
     "serve": "npx docsify-cli serve"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/imdone/imdone-core.git"
-  },
   "keywords": [
     "imdone",
     "TODO",
@@ -34,33 +39,24 @@
     "url": "https://github.com/imdone/imdone-core/issues"
   },
   "homepage": "https://github.com/imdone/imdone-core",
-  "jshintConfig": {
-    "strict": true,
-    "node": true,
-    "globals": {
-      "jQuery": true,
-      "console": false,
-      "module": true,
-      "document": true
-    }
-  },
   "dependencies": {
-    "async": "~1.5.0",
-    "chalk": "^4.1.2",
-    "checksum": "^0.1.1",
-    "chrono-node": "^2.6.4",
-    "command-exists": "^1.2.9",
-    "commander": "^11.1.0",
+    "adm-zip": "^0.5.16",
+    "async": "^3.2.6",
+    "async-es": "^3.2.6",
+    "chalk": "^5.4.1",
+    "chokidar": "^4.0.3",
+    "chrono-node": "^2.7.8",
+    "commander": "^13.1.0",
     "debug": ">=4.3.4",
-    "download": "^8.0.0",
     "eol": "^0.9.1",
     "escape-string-regexp": "^1.0.5",
-    "fast-sort": "^2.2.0",
-    "find-up": "^5.0.0",
+    "eta": "^3.5.0",
+    "fast-sort": "^3.4.1",
+    "find-up-simple": "^1.0.1",
     "gray-matter": "^4.0.2",
     "ignore": "^5.2.0",
     "imdone-api": "^1.54.0",
-    "isbinaryfile": "^3.0.2",
+    "isbinaryfile": "^5.0.4",
     "js-yaml": "^3.14.1",
     "json-fns": "^1.0.0",
     "lodash.assign": "^4.2.0",
@@ -82,69 +78,51 @@
     "lodash.reject": "^4.6.0",
     "lodash.remove": "^4.7.0",
     "lodash.some": "^4.6.0",
-    "lodash.template": "^4.5.0",
     "lodash.union": "^4.6.0",
     "lodash.uniq": "^4.5.0",
     "lodash.where": "^3.1.0",
     "lodash.without": "^4.4.0",
-    "markdown-it": "^12.3.2",
+    "markdown-it": "^14.1.0",
     "markdown-it-checkbox": "^1.1.0",
     "markdown-it-emoji": "^2.0.0",
     "markdown-it-imsize": "^2.0.1",
     "markdown-it-mark": "^3.0.1",
-    "mkdirp": "^1.0.4",
     "moment": "^2.29.1",
     "monquery": "github:imdone/node-monquery#0.2.1",
     "multilang-extract-comments": "^0.4.0",
+    "node-fetch": "^3.3.2",
     "open": "^9.1.0",
-    "ora": "^5.4.1",
+    "ora": "^8.2.0",
     "parse-code-context": "^1.0.0",
     "prompts": "^2.4.2",
-    "readdirp": "^3.6.0",
+    "readdirp": "^4.1.2",
     "remove-markdown": "^0.3.0",
     "rimraf": "^3.0.2",
-    "sane": "^5.0.1",
     "sanitize-filename": "^1.6.3",
     "sift": "^17.1.3",
     "simple-git": "^3.19.1",
     "uniqid": "^5.4.0",
-    "xregexp": "^5.1.0"
+    "xregexp": "^5.1.2"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
+    "@types/node": "^22.13.13",
+    "@vitest/coverage-istanbul": "^3.0.8",
+    "@vitest/coverage-v8": "^3.0.8",
+    "chai": "^5.2.0",
     "colors": "^1.4.0",
+    "dependency-cruiser": "^16.10.0",
     "doctoc": "^2.1.0",
+    "esbuild": "^0.25.1",
     "expect.js": "~0.3.1",
     "fs-extra": "^11.1.0",
-    "jshint": "^2.9.4",
     "json-stringify-safe": "~5.0.0",
     "mocha": "^11.1.0",
     "mocha-each": "^2.0.1",
-    "nyc": "^15.1.0",
     "prettier": "^2.5.1",
     "should": "13.1.3",
-    "sinon": "^13.0.0",
-    "sinon-chai": "^3.7.0",
-    "wrench": "~1.5.8"
-  },
-  "mocha": {
-    "diff": true,
-    "extension": [
-      "js",
-      "cjs",
-      "mjs"
-    ],
-    "package": "./package.json",
-    "reporter": "spec",
-    "slow": "75",
-    "timeout": "2000",
-    "spec": [
-      "lib/**/__tests__/**/*.spec.js",
-      "test/**/*spec.js"
-    ],
-    "watch-files": [
-      "lib/**/__tests__/**/*.spec.js",
-      "test/**/*spec.js"
-    ]
+    "sinon": "^19.0.2",
+    "sinon-chai": "^4.0.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.8"
   }
 }

package/scripts/delete-markdown-indexes.js

@@ -0,0 +1,87 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+// Get the current directory name in ESM
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const sidebar = '_index.md';
+
+function getMarkdownFiles(files = []) {
+  return files.filter(file => file.endsWith('.md') && file !== sidebar && file !== '_navbar.md');
+}
+
+function getFileLinks(files) {
+  return files.map(file => `- [${file.replace('.md', '')}](${file})`).join('\n');
+}
+
+function getSubDirLinks(files, directory) {
+  const subDirs = files.filter(file => fs.statSync(path.join(directory, file)).isDirectory());
+  const subDirsContainingMarkdown = subDirs.filter(subDir => fs.readdirSync(path.join(directory, subDir)).find(file => file.endsWith('.md')));
+  return subDirsContainingMarkdown.map(subDir => {
+    const resource = fs.readdirSync(path.join(directory, subDir)).find(file => file.toLowerCase() === 'readme.md')
+      ? 'README'
+      : sidebar;
+    return `- [:file_folder: **${subDir}**](${subDir}/${resource})`;
+  }).join('\n');
+}
+
+function getBreadCrumb(parentDir) {
+  const homeLink = '[:house: **Home**](/README)';
+  return parentDir ? `- ${homeLink}\n- [:arrow_heading_up: **Parent Directory**](${parentDir}${sidebar})` : '';
+}
+
+function createIndexes(directory, parentDir, title) {
+  const basename = path.basename(directory);
+  if (basename.startsWith('.')) {
+    return;
+  }
+
+  title = title || basename;
+
+  const files = fs.readdirSync(directory);
+  const markdownFiles = getMarkdownFiles(files);
+
+  if (markdownFiles.length > 0) {
+    const subDirLinks = getSubDirLinks(files, directory);
+    const fileLinks = getFileLinks(markdownFiles);
+    const breadcrumb = getBreadCrumb(parentDir);
+
+    fs.writeFileSync(path.join(directory, sidebar), `# ${title}\n${breadcrumb}\n${subDirLinks}\n${fileLinks}\n`);
+  }
+
+  files
+    .filter(file => fs.statSync(path.join(directory, file)).isDirectory())
+    .forEach(subDir => createIndexes(path.join(directory, subDir), parentDir ? path.join(parentDir, basename) + '/' : '/'));
+}
+
+createIndexes(process.cwd(), undefined, 'imdone-core');
+console.log('Indexes created successfully!');
+
+function deleteIndexFiles(dir) {
+  // Read the directory and filter for _index.md files
+  const files = fs.readdirSync(dir);
+
+  files.forEach(file => {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+
+    // If it's a file and matches the _index.md pattern, delete it
+    if (stat.isFile() && file === '_index.md') {
+      console.log(`Deleting file: ${filePath}`);
+      fs.unlinkSync(filePath);
+    }
+
+    // If it's a directory, recurse
+    if (stat.isDirectory()) {
+      deleteIndexFiles(filePath);
+    }
+  });
+}
+
+// Path to your test directory
+const testDirectory = path.join(__dirname, '..', 'test');
+
+// Call the function to delete _index.md files
+deleteIndexFiles(testDirectory);

package/scripts/generate-index.js

@@ -0,0 +1,35 @@
+import fs from 'fs';
+import path from 'path';
+
+const LIB_DIR = './lib';
+
+// Recursively generates index.js files
+function generateIndexes(dir) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+  const files = entries
+    .filter(entry => entry.isFile() && entry.name !== 'index.js' && entry.name !== 'cli.js' && entry.name.endsWith('.js'))
+    .map(entry => `export * from './${entry.name}';`);
+
+  const subdirs = entries
+    .filter(entry => entry.isDirectory() && entry.name !== '__tests__')
+    .map(entry => entry.name);
+
+  // Generate index.js in each subdirectory
+  subdirs.forEach(subdir => generateIndexes(path.join(dir, subdir)));
+
+  // Add namespace exports for subdirectories
+  const namespaceExports = subdirs.map(subdir => `export * as ${subdir} from './${subdir}/index.js';`);
+
+  // Write the index.js file
+  if (files.length || namespaceExports.length) {
+    const indexPath = path.join(dir, 'index.js');
+    const content = [...files, ...namespaceExports].join('\n') + '\n';
+    fs.writeFileSync(indexPath, content);
+    console.log(`Generated: ${indexPath}`);
+  }
+}
+
+// Run the script
+generateIndexes(LIB_DIR);
+console.log('✅ Index files generated successfully!');

package/{index-markdown.js → scripts/index-markdown.js}

@@ -1,5 +1,6 @@
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
+
 const sidebar = '_index.md';
 
 function getMarkdownFiles(files = []) {
@@ -12,12 +13,11 @@ function getFileLinks(files) {
 
 function getSubDirLinks(files, directory) {
   const subDirs = files.filter(file => fs.statSync(path.join(directory, file)).isDirectory());
-  const subDirsContainingMarkdown = subDirs.filter(subDir => fs.readdirSync(path.join(directory, subDir)).find(file => file.endsWith('.md'))
-  );
+  const subDirsContainingMarkdown = subDirs.filter(subDir => fs.readdirSync(path.join(directory, subDir)).find(file => file.endsWith('.md')));
   return subDirsContainingMarkdown.map(subDir => {
     const resource = fs.readdirSync(path.join(directory, subDir)).find(file => file.toLowerCase() === 'readme.md')
       ? 'README'
-      : sidebar
+      : sidebar;
     return `- [:file_folder: **${subDir}**](${subDir}/${resource})`;
   }).join('\n');
 }
@@ -29,7 +29,7 @@ function getBreadCrumb(parentDir) {
 
 function createIndexes(directory, parentDir, title) {
   const basename = path.basename(directory);
-  if (basename.startsWith('.')) {
+  if (basename.startsWith('.') || basename === 'test') {
     return;
   }
 
@@ -52,4 +52,4 @@ function createIndexes(directory, parentDir, title) {
 }
 
 createIndexes(process.cwd(), undefined, 'imdone-core');
-console.log('Indexes created successfully!');
+console.log('Indexes created successfully!');

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "allowJs": true,
+    "outDir": "types",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ESNext",
+    "esModuleInterop": true,
+    "strict": true
+  },
+  "include": ["lib/**/index.js"],
+  "exclude": ["node_modules", "__tests__"]
+}

package/types/FileProjectContext.d.ts

@@ -0,0 +1,4 @@
+export class FileProjectContext {
+    getOrder(list: any, order: any): number | undefined;
+    getProject(): void;
+}

package/types/ProjectContext.d.ts

@@ -0,0 +1,9 @@
+export class ProjectContext extends FileProjectContext {
+    constructor(repo: any);
+    repo: any;
+    getOrder(list: any, order: any): any;
+    get config(): any;
+    toJSON(): null;
+    determineOrder(config: any, order: any, tasks: any): any;
+}
+import { FileProjectContext } from './FileProjectContext.js';

package/types/adapters/date-time.d.ts

@@ -0,0 +1,2 @@
+export function setNoDST(noDST: any): void;
+export function getIsoDateWithOffset(date: any): string;

package/types/adapters/environment.d.ts

@@ -0,0 +1 @@
+export function isDev(): boolean;