imdone-core 1.54.10 → 2.0.0

package/README.md

@@ -9,7 +9,6 @@ Imdone is text based kanban processor with a simple syntax that uses [comment ta
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Imdone format](#imdone-format)
   - [Code Style](#code-style)
   - [Hash Style](#hash-style)
@@ -203,8 +202,9 @@ License
 {{version}} :package: :hammer_and_wrench: Code Version
 {{publishedVersion}} :package: :passenger_ship: Published Version
 
+[ESM Migration]({{getFilterURL('list = NOTE or allTags = "esm-migration"')}})
 [Focus]({{getFilterURL('list = DOING or tags = focus')}})
-[Plan]({{getFilterURL(' ')}})
+[Plan]({{clearFilterURL}})
 
 <!--
 expand:1

package/lib/cli.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+
+// DOING Modernize cli to esm
+// <!--
+// order:-40
+// -->
+import { Command } from 'commander';
+import ora from 'ora';
+import chalk from 'chalk';
+import * as fs from 'node:fs/promises'; // Use fs/promises for async read
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import { executeBoardAction, listAvailableActions } from './usecases/actions.js';
+import { logger } from './adapters/logger.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function getPackageJson() {
+  try {
+    const data = await fs.readFile(path.join(__dirname, '..', 'package.json'), 'utf8');
+    return JSON.parse(data);
+  } catch (error) {
+    logger.error("Error reading package.json:", error);
+    return null;
+  }
+}
+
+const _package = await getPackageJson();
+// const { log } = hideLogs();
+const spinner = ora('Loading unicorns');
+
+setTimeout(() => {
+  spinner.color = 'yellow';
+  spinner.text = 'Loading rainbows';
+}, 1000);
+
+function actionCancelled() {
+  logger.log(chalk.bgRed('Action canceled'));
+}
+
+const program = new Command();
+program.version(_package.version, '-v, --version', 'output the current version');
+
+const actionCmd = program.command('action')
+  .description('Manage board actions');
+
+actionCmd
+  .command('run <title>')
+  .option('-p, --plugin <plugin>', 'Plugin name', 'ExtensionPlugin')
+  .option('-t, --task <task>', 'Task filePath:line')
+  .option('-w, --working-dir <workingDir>', 'Working directory', '.')
+  .option('-c, --config <configPath>', 'Config file path', path.join('.imdone', 'config.yml'))
+  .description('Run a board action')
+  .action(async (title, {
+    plugin = 'ExtensionPlugin',
+    task, 
+    workingDir, 
+    configPath
+  }) => {
+    spinner.start();
+    const action = { plugin, title };
+    const [filePath, line] = task ? task.split(':') : [];
+    // DOING: Move this CLI command to a usecase
+    try {
+      await executeBoardAction({
+        projectPath: workingDir,
+        configPath,
+        task: filePath && line && { filePath, line },
+        action
+      });
+    } catch (e) {
+      logger.error(e);
+      actionCancelled();
+    } finally {
+      spinner.stop();
+      process.exit(0);
+    }
+  });
+
+actionCmd
+  .command('list')
+  .option('-p, --plugin <plugin>', 'Plugin name', 'ExtensionPlugin')
+  .option('-w, --working-dir <workingDir>', 'Working directory')
+  .option('-c, --config <configPath>', 'Config file path')
+  .description('List available actions')
+  .action(async ({ workingDir = path.resolve('.'), configPath, plugin}) => {
+    spinner.start();
+    try {
+      await listAvailableActions(workingDir, configPath, plugin);
+    } catch (e) {
+    logger.error(e);
+    actionCancelled();
+    } finally {
+      spinner.stop();
+      process.exit(0);
+    }
+  });
+
+program.parse();
+
+function hideLogs() {
+  const log = logger.log;
+  const info = logger.info;
+  const warn = logger.warn;
+  const logQueue = { warn: [], info: [], log: [] };
+  if (!process.env.DEBUG) {
+    Object.keys(logQueue).forEach((key) => {
+      console[key] = function(...args) {
+        logQueue[key].push(args);
+      };
+    });
+  }
+  return { log, info, warn, logQueue };
+}

package/lib/index.js

@@ -0,0 +1,23 @@
+export * from './FileProjectContext.js';
+export * from './ProjectContext.js';
+export * from './card.js';
+export * from './checksum.js';
+export * from './config.js';
+export * from './constants.js';
+export * from './default-settings.js';
+export * from './file.js';
+export * from './get-tasks-to-modify.js';
+export * from './languages.js';
+export * from './list.js';
+export * from './migrate-config.js';
+export * from './project-factory.js';
+export * from './project.js';
+export * from './repository.js';
+export * from './task.js';
+export * from './tools.js';
+export * as adapters from './adapters/index.js';
+export * as context from './context/index.js';
+export * as domain from './domain/index.js';
+export * as mixins from './mixins/index.js';
+export * as plugins from './plugins/index.js';
+export * as usecases from './usecases/index.js';

package/package.json

@@ -1,24 +1,33 @@
 {
   "name": "imdone-core",
-  "version": "1.54.10",
+  "version": "2.0.0",
   "description": "imdone-core",
-  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/imdone/imdone-core.git"
+  },
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "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:index && 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 +43,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 +82,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/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,37 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve imdone
-title: ''
-labels: 'bug'
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser (If imdone web site) [e.g. chrome, safari]
- - Imdone Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
-
-**DoD**
-- [ ] Issue is understood
-- [ ] Fix is implemented and tested
-- [ ] Fix is deployed in the current release

package/.github/workflows/ci.yml

@@ -1,24 +0,0 @@
-name: Node.js CI
-
-on:
-  push:
-    branches: [ '*' ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [16.x, 17.x, 18.x, 19.x, 20.x]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      - run: npm i
-      - run: npm run build --if-present

package/.imdoneignore

@@ -1,12 +0,0 @@
-coverage
-.nyc_output
-test/repos
-test/files
-test/file-spec.js
-__tests__
-test-big-file.md
-tmp
-imdone-export.json
-.imdone/templates
-.imdone
-notes/archive

package/.mocharc.json

@@ -1,10 +0,0 @@
-{
-  "diff": true,
-  "extension": ["js", "cjs", "mjs"],
-  "package": "./package.json",
-  "reporter": "spec",
-  "slow": "75",
-  "timeout": "20000",
-  "ui": "bdd",
-  "watch-files": ["lib/**/__tests__/**/*.spec.js", "test/**/*spec.js"]
-}

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true
-}

package/CHANGELOG.md

@@ -1,160 +0,0 @@
-## 1.28.8
-- Allow Card and Board actions to return a value
-
-# 1.5.31
-- When moving a task, only change the order of the current task unless it's moving to the top of a list with more than one task, then we update the task that was previously first as well.
-
-# 1.5.28
-- Implement Repository.modifyTaskFromContent
-
-# 1.5.10
-- Switch to readdirp
-
-# 1.5.2
-- add allContext, allTags and allMeta to tasks
-
-# 1.5.0
-- Add frontMatter
-
-# 1.4.19
-- Add doc generation and move regex dependency
-
-# 1.4.17
-- Improve issue matching
-
-# 1.4.15
-- ignore hash and link style tasks in code files
-
-# 1.4.14
-- Add modifyDescription
-
-# 1.4.13
-- Add rawTask to opts for Task constructor
-
-# 1.4.12
-- Make Repository.query return an empty array if no tasks found
-
-# 1.4.11
-- Expose Repository.query to filter tasks without repo
-
-# 1.4.10
-- Add task properties (created, completed, due, remind) as dates if they exist in metadata and parse as dates
-
-# 1.4.8
-- use string.search as fallback to rql
-
-# 1.4.7
-- Add .vue extension
-
-# 1.4.6
-- ignore tasks found in list if list has property `ignore: true` in config.lists
-
-# 1.4.4
-- repository.query Add rql querying of tasks
-
-# 1.4.3
-- Add savingFiles attribute when saving modified files
-
-# 1.4.2
-- Fix add and remove metaData
-
-# 1.4.1
-- Fix updateMetaData
-
-# 1.4.0
-- Switch to metadata for created and completed dates
-
-# 1.3.59
-- Fix meta so it captures the first key:
-
-# 1.3.58
-- extend include_lists
-
-# 1.3.54
-- Add .pug to languages
-- Update comment symbol for .jade and .pug to be //-
-
-# 1.3.51
-- Allow hash style tasks in code if they're in config.lists or config.code.include_lists
-
-# 1.3.45
-- switch to markdown-it for check-lists
-- Add following lines as task description
-
-# 1.3.38
-- Add list to include_lists
-
-# 1.3.34
-- Update chokidar
-
-# 1.3.27
-- Allow umlauts and other special characters in contexts
-
-# 1.3.26
-- Check excludes for all files before running stat
-
-# 1.3.25
-- Use eachLimit for Repository.readFiles
-
-# 1.3.24
-- Simplify isBinary check
-
-# 1.3.23
-- file.isOk callback with false if isBinaryCheck errs
-
-# 1.3.22
-- Drop async file access limit to 10
-
-# 1.3.21
-- Reduce async file access limit to 256
-
-# 1.3.20
-- Improve stats performance
-- emits tasks on update
-- Add isListVisible
-
-# 1.3.19
-- Minor bug fixes
-
-# 1.3.18
-- Add delete tasks
-
-# 1.3.17
-- Simplify readdir with node-dir
-
-# 1.3.16
-- Add php block comment.
-- Fix issue with hash style lists not getting added
-
-# 1.3.15
-- Fire config.loaded event after config is set
-
-# 1.3.14
-- Make sure list is in include_lists before adding it through listeners
-
-# 1.3.13
-- Raise async limit
-
-# 1.3.11
-- Add haml extension and -# comment
-
-# 1.3.9
-- Add .boot
-
-# 1.3.8
-- Add velocity comments
-
-# 1.3.5
-- Update .imdoneignore functionality to work like .gitignore
-
-# 1.3.3
-- Update marked and minimatch for security reasons
-
-# 1.3.2
-- When a user adds a list to the board, utomatically add list name to config.code.include_lists if it's all caps
-
-# 1.3.0
-- Add update task from metadata, tags and contexts
-- meta is empty object if no metadata found
-- make repo emit task.modified
-- compare meta.id as backup for id compare

package/_navbar.md

@@ -1 +0,0 @@
-**[:house: imdone-core Documentation](/README)**

package/cli.js

@@ -1,74 +0,0 @@
-#!/usr/bin/env node
-
-const { program } = require('commander');
-const ora = require('ora')
-const chalk = require('chalk')
-const package = require('./package.json')
-const { createFileSystemProject } = require('./lib/project-factory.js')
-const { load } = require('./lib/adapters/storage/config.js')
-// const { log } = hideLogs()
-const spinner = ora('Loading unicorns')
-
-
-setTimeout(() => {
-	spinner.color = 'yellow';
-	spinner.text = 'Loading rainbows';
-}, 1000);
-
-function actionCancelled() {
-  log(chalk.bgRed('Action canceled'))
-}
-
-const mainCmd = program
-.version(package.version, '-v, --version', 'output the current version')
-
-mainCmd
-.command('action <pluginName> <actionTitle>')
-.option('-t, --task <task>', 'Task filePath:line')
-.option('-w, --working-dir <workingDir>', 'Working directory')
-.option('-c, --config <config>', 'Config file path')
-.description('Run a board action')
-.action(async function (plugin, title, options) {
-  spinner.start()
-  const action = {plugin, title}
-  const [filePath, line] = options.task ? options.task.split(':') : []
-  try {
-    const path = options.workingDir || process.env.PWD
-    const config = options.config && await load(options.config)
-    const project = createFileSystemProject({path, config})
-    await project.init()
-    await project.toImdoneJSON()
-    chalk.bgGreen('Project loaded')
-    const file = filePath && project.getFile(filePath)
-    const task = file && line > -1 && file.getTaskAtLine(line)
-    await project.performBoardAction(action, task)
-  } catch (e) {
-    console.error(e)
-    actionCancelled()
-  } finally {
-    spinner.stop()
-    process.exit(0)
-  }
-})
-
-
-program.parse();
-
-function hideLogs() {
-  const log = console.log
-  const info = console.info
-  const warn = console.warn
-  const logQueue = {warn: [], info: [], log: []}
-  if (!process.env.DEBUG) {
-    Object.keys(logQueue).forEach((key) => {
-      console[key] = function(...args) {
-        logQueue[key].push(args)
-      }
-    })
-  }
-  return {log, info, warn, logQueue}
-}
-
-function actionCancelled() {
-  log(chalk.bgRed('Action canceled'))
-}