@md2do/cli 0.2.3 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @md2do/cli
 
+## 0.3.0
+
+### Minor Changes
+
+- Add comprehensive warning system for markdown validation and VSCode extension
+  - Add warning configuration system with customizable rules
+  - Add VSCode extension with task explorer, diagnostics, hover tooltips, and smart completion
+  - Support for validating malformed checkboxes, missing metadata, duplicate IDs, and more
+  - Add .vsix distribution for beta testing
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @md2do/core@0.3.0
+  - @md2do/config@0.3.0
+  - @md2do/todoist@0.3.0
+
 ## 0.2.3
 
 ### Patch Changes

package/dist/cli.js

@@ -31,6 +31,7 @@ var import_path = require("path");
 // src/commands/list.ts
 var import_commander = require("commander");
 var import_core2 = require("@md2do/core");
+var import_config = require("@md2do/config");
 
 // src/scanner.ts
 var import_promises = require("fs/promises");
@@ -68,11 +69,16 @@ async function scanMarkdownFiles(options = {}) {
       allTasks.push(...result.tasks);
       allWarnings.push(...result.warnings);
     } catch (error) {
+      const message = `Failed to read file: ${error instanceof Error ? error.message : "Unknown error"}`;
       allWarnings.push({
+        severity: "error",
+        source: "md2do",
+        ruleId: "file-read-error",
         file,
         line: 0,
         text: "",
-        reason: `Failed to read file: ${error instanceof Error ? error.message : "Unknown error"}`
+        message,
+        reason: message
       });
     }
   }
@@ -388,21 +394,30 @@ function createListCommand() {
           break;
       }
       console.log(output);
-      if (options.warnings !== false && scanResult.warnings.length > 0) {
-        console.error(
-          `
-\u26A0\uFE0F  ${scanResult.warnings.length} warning${scanResult.warnings.length > 1 ? "s" : ""} encountered during scanning`
+      if (options.warnings !== false) {
+        const config = await (0, import_config.loadConfig)({
+          cwd: options.path || process.cwd()
+        });
+        const warningConfig = config.warnings ?? import_config.DEFAULT_CONFIG.warnings;
+        const filteredWarnings = (0, import_core2.filterWarnings)(
+          scanResult.warnings,
+          warningConfig ?? {}
         );
-        const warningsToShow = options.allWarnings ? scanResult.warnings : scanResult.warnings.slice(0, 5);
-        for (const warning of warningsToShow) {
-          console.error(
-            `  ${warning.file}:${warning.line} - ${warning.reason}`
-          );
-        }
-        if (!options.allWarnings && scanResult.warnings.length > 5) {
+        if (filteredWarnings.length > 0) {
           console.error(
-            `  ... and ${scanResult.warnings.length - 5} more warning${scanResult.warnings.length - 5 > 1 ? "s" : ""} (use --all-warnings to see all)`
+            `
+\u26A0\uFE0F  ${filteredWarnings.length} warning${filteredWarnings.length > 1 ? "s" : ""} encountered during scanning`
           );
+          const warningsToShow = options.allWarnings ? filteredWarnings : filteredWarnings.slice(0, 5);
+          for (const warning of warningsToShow) {
+            const message = warning.message || warning.reason || "Unknown warning";
+            console.error(`  ${warning.file}:${warning.line} - ${message}`);
+          }
+          if (!options.allWarnings && filteredWarnings.length > 5) {
+            console.error(
+              `  ... and ${filteredWarnings.length - 5} more warning${filteredWarnings.length - 5 > 1 ? "s" : ""} (use --all-warnings to see all)`
+            );
+          }
         }
       }
     } catch (error) {
@@ -652,7 +667,7 @@ function capitalize(str) {
 
 // src/commands/todoist.ts
 var import_commander3 = require("commander");
-var import_config = require("@md2do/config");
+var import_config2 = require("@md2do/config");
 var import_todoist = require("@md2do/todoist");
 var import_core4 = require("@md2do/core");
 var import_promises2 = __toESM(require("fs/promises"));
@@ -681,7 +696,7 @@ function createTodoistListCommand() {
   return command;
 }
 async function todoistListAction(options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -812,7 +827,7 @@ function createTodoistAddCommand() {
   return command;
 }
 async function todoistAddAction(taskContent, options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -905,7 +920,7 @@ async function todoistImportAction(location, options) {
     console.error(`\u274C Error: Invalid line number: ${lineStr}`);
     process.exit(1);
   }
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -1019,7 +1034,7 @@ function createTodoistSyncCommand() {
   return command;
 }
 async function todoistSyncAction(options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");

package/dist/index.js

@@ -39,6 +39,7 @@ module.exports = __toCommonJS(index_exports);
 // src/commands/list.ts
 var import_commander = require("commander");
 var import_core2 = require("@md2do/core");
+var import_config = require("@md2do/config");
 
 // src/scanner.ts
 var import_promises = require("fs/promises");
@@ -76,11 +77,16 @@ async function scanMarkdownFiles(options = {}) {
       allTasks.push(...result.tasks);
       allWarnings.push(...result.warnings);
     } catch (error) {
+      const message = `Failed to read file: ${error instanceof Error ? error.message : "Unknown error"}`;
       allWarnings.push({
+        severity: "error",
+        source: "md2do",
+        ruleId: "file-read-error",
         file,
         line: 0,
         text: "",
-        reason: `Failed to read file: ${error instanceof Error ? error.message : "Unknown error"}`
+        message,
+        reason: message
       });
     }
   }
@@ -396,21 +402,30 @@ function createListCommand() {
           break;
       }
       console.log(output);
-      if (options.warnings !== false && scanResult.warnings.length > 0) {
-        console.error(
-          `
-\u26A0\uFE0F  ${scanResult.warnings.length} warning${scanResult.warnings.length > 1 ? "s" : ""} encountered during scanning`
+      if (options.warnings !== false) {
+        const config = await (0, import_config.loadConfig)({
+          cwd: options.path || process.cwd()
+        });
+        const warningConfig = config.warnings ?? import_config.DEFAULT_CONFIG.warnings;
+        const filteredWarnings = (0, import_core2.filterWarnings)(
+          scanResult.warnings,
+          warningConfig ?? {}
         );
-        const warningsToShow = options.allWarnings ? scanResult.warnings : scanResult.warnings.slice(0, 5);
-        for (const warning of warningsToShow) {
-          console.error(
-            `  ${warning.file}:${warning.line} - ${warning.reason}`
-          );
-        }
-        if (!options.allWarnings && scanResult.warnings.length > 5) {
+        if (filteredWarnings.length > 0) {
           console.error(
-            `  ... and ${scanResult.warnings.length - 5} more warning${scanResult.warnings.length - 5 > 1 ? "s" : ""} (use --all-warnings to see all)`
+            `
+\u26A0\uFE0F  ${filteredWarnings.length} warning${filteredWarnings.length > 1 ? "s" : ""} encountered during scanning`
           );
+          const warningsToShow = options.allWarnings ? filteredWarnings : filteredWarnings.slice(0, 5);
+          for (const warning of warningsToShow) {
+            const message = warning.message || warning.reason || "Unknown warning";
+            console.error(`  ${warning.file}:${warning.line} - ${message}`);
+          }
+          if (!options.allWarnings && filteredWarnings.length > 5) {
+            console.error(
+              `  ... and ${filteredWarnings.length - 5} more warning${filteredWarnings.length - 5 > 1 ? "s" : ""} (use --all-warnings to see all)`
+            );
+          }
         }
       }
     } catch (error) {
@@ -660,7 +675,7 @@ function capitalize(str) {
 
 // src/commands/todoist.ts
 var import_commander3 = require("commander");
-var import_config = require("@md2do/config");
+var import_config2 = require("@md2do/config");
 var import_todoist = require("@md2do/todoist");
 var import_core4 = require("@md2do/core");
 var import_promises2 = __toESM(require("fs/promises"));
@@ -689,7 +704,7 @@ function createTodoistListCommand() {
   return command;
 }
 async function todoistListAction(options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -820,7 +835,7 @@ function createTodoistAddCommand() {
   return command;
 }
 async function todoistAddAction(taskContent, options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -913,7 +928,7 @@ async function todoistImportAction(location, options) {
     console.error(`\u274C Error: Invalid line number: ${lineStr}`);
     process.exit(1);
   }
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");
@@ -1027,7 +1042,7 @@ function createTodoistSyncCommand() {
   return command;
 }
 async function todoistSyncAction(options) {
-  const config = await (0, import_config.loadConfig)();
+  const config = await (0, import_config2.loadConfig)();
   if (!config.todoist?.apiToken) {
     console.error("\u274C Error: Todoist API token not configured");
     console.error("");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md2do/cli",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "CLI interface for md2do task manager",
   "keywords": [
     "markdown",
@@ -40,16 +40,16 @@
   },
   "dependencies": {
     "@doist/todoist-api-typescript": "^3.0.3",
-    "chalk": "^5.6.2",
+    "chalk": "^4.1.2",
     "cli-table3": "^0.6.5",
     "commander": "^11.1.0",
     "cosmiconfig": "^9.0.0",
     "date-fns": "^3.0.6",
     "fast-glob": "^3.3.3",
     "zod": "^3.22.4",
-    "@md2do/config": "0.2.3",
-    "@md2do/core": "0.2.3",
-    "@md2do/todoist": "0.2.3"
+    "@md2do/core": "0.3.0",
+    "@md2do/config": "0.3.0",
+    "@md2do/todoist": "0.3.0"
   },
   "devDependencies": {
     "tsup": "^8.0.1"

package/src/commands/list.ts

@@ -1,5 +1,6 @@
 import { Command } from 'commander';
-import { filters, sorting } from '@md2do/core';
+import { filters, sorting, filterWarnings } from '@md2do/core';
+import { loadConfig, DEFAULT_CONFIG } from '@md2do/config';
 import { scanMarkdownFiles } from '../scanner.js';
 import { formatAsPretty, formatAsTable } from '../formatters/pretty.js';
 import { formatAsJson } from '../formatters/json.js';
@@ -211,27 +212,42 @@ export function createListCommand(): Command {
 
         console.log(output);
 
-        // Show warnings if any (unless --no-warnings)
-        if (options.warnings !== false && scanResult.warnings.length > 0) {
-          console.error(
-            `\n⚠️  ${scanResult.warnings.length} warning${scanResult.warnings.length > 1 ? 's' : ''} encountered during scanning`,
+        // Load config and apply warning filters (unless --no-warnings overrides)
+        if (options.warnings !== false) {
+          const config = await loadConfig({
+            cwd: options.path || process.cwd(),
+          });
+          const warningConfig = config.warnings ?? DEFAULT_CONFIG.warnings;
+
+          // Apply config-based filtering
+          const filteredWarnings = filterWarnings(
+            scanResult.warnings,
+            warningConfig ?? {},
           );
 
-          // Show all warnings if --all-warnings, otherwise show first 5
-          const warningsToShow = options.allWarnings
-            ? scanResult.warnings
-            : scanResult.warnings.slice(0, 5);
-
-          for (const warning of warningsToShow) {
+          // Show warnings if any remain after filtering
+          if (filteredWarnings.length > 0) {
             console.error(
-              `  ${warning.file}:${warning.line} - ${warning.reason}`,
+              `\n⚠️  ${filteredWarnings.length} warning${filteredWarnings.length > 1 ? 's' : ''} encountered during scanning`,
             );
-          }
 
-          if (!options.allWarnings && scanResult.warnings.length > 5) {
-            console.error(
-              `  ... and ${scanResult.warnings.length - 5} more warning${scanResult.warnings.length - 5 > 1 ? 's' : ''} (use --all-warnings to see all)`,
-            );
+            // Show all warnings if --all-warnings, otherwise show first 5
+            const warningsToShow = options.allWarnings
+              ? filteredWarnings
+              : filteredWarnings.slice(0, 5);
+
+            for (const warning of warningsToShow) {
+              // Use message field (new) or fallback to reason (legacy)
+              const message =
+                warning.message || warning.reason || 'Unknown warning';
+              console.error(`  ${warning.file}:${warning.line} - ${message}`);
+            }
+
+            if (!options.allWarnings && filteredWarnings.length > 5) {
+              console.error(
+                `  ... and ${filteredWarnings.length - 5} more warning${filteredWarnings.length - 5 > 1 ? 's' : ''} (use --all-warnings to see all)`,
+              );
+            }
           }
         }
       } catch (error) {

package/src/scanner.ts

@@ -82,11 +82,16 @@ export async function scanMarkdownFiles(
       allWarnings.push(...result.warnings);
     } catch (error) {
       // Add warning for files that couldn't be read
+      const message = `Failed to read file: ${error instanceof Error ? error.message : 'Unknown error'}`;
       allWarnings.push({
+        severity: 'error',
+        source: 'md2do',
+        ruleId: 'file-read-error',
         file,
         line: 0,
         text: '',
-        reason: `Failed to read file: ${error instanceof Error ? error.message : 'Unknown error'}`,
+        message,
+        reason: message,
       });
     }
   }

package/tests/e2e/__snapshots__/warnings.test.ts.snap

@@ -0,0 +1,104 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`E2E: Warning Configuration Profiles > custom: all disabled > all-disabled 1`] = `
+"
+Found 3 tasks
+  ✓ 1 completed | ○ 2 incomplete
+
+  ○ !! Valid task (2026-02-01) @alice #bug
+    tasks.md:6
+
+  ✓ Completed task without completion date
+    tasks.md:7
+
+  ○ Task without a due date
+    tasks.md:8
+
+"
+`;
+
+exports[`E2E: Warning Configuration Profiles > custom: only spacing errors > custom-space-only 1`] = `
+"
+Found 3 tasks
+  ✓ 1 completed | ○ 2 incomplete
+
+  ○ !! Valid task (2026-02-01) @alice #bug
+    tasks.md:6
+
+  ✓ Completed task without completion date
+    tasks.md:7
+
+  ○ Task without a due date
+    tasks.md:8
+
+
+⚠️  2 warnings encountered during scanning
+  tasks.md:4 - Missing space after checkbox. Use "- [x] Task" format.
+  tasks.md:5 - Missing space before checkbox. Use "- [x] Task" format.
+"
+`;
+
+exports[`E2E: Warning Configuration Profiles > recommended profile (default) > recommended-default 1`] = `
+"
+Found 3 tasks
+  ✓ 1 completed | ○ 2 incomplete
+
+  ○ !! Valid task (2026-02-01) @alice #bug
+    tasks.md:6
+
+  ✓ Completed task without completion date
+    tasks.md:7
+
+  ○ Task without a due date
+    tasks.md:8
+
+
+⚠️  3 warnings encountered during scanning
+  tasks.md:3 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  tasks.md:4 - Missing space after checkbox. Use "- [x] Task" format.
+  tasks.md:5 - Missing space before checkbox. Use "- [x] Task" format.
+"
+`;
+
+exports[`E2E: Warning Configuration Profiles > strict profile > strict-all-warnings 1`] = `
+"
+Found 3 tasks
+  ✓ 1 completed | ○ 2 incomplete
+
+  ○ !! Valid task (2026-02-01) @alice #bug
+    tasks.md:6
+
+  ✓ Completed task without completion date
+    tasks.md:7
+
+  ○ Task without a due date
+    tasks.md:8
+
+
+⚠️  6 warnings encountered during scanning
+  tasks.md:3 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  tasks.md:4 - Missing space after checkbox. Use "- [x] Task" format.
+  tasks.md:5 - Missing space before checkbox. Use "- [x] Task" format.
+  tasks.md:6 - Task has no due date. Add [due: YYYY-MM-DD] or place under a heading with a date.
+  tasks.md:7 - Completed task missing completion date. Add [completed: YYYY-MM-DD].
+  ... and 1 more warning (use --all-warnings to see all)
+"
+`;
+
+exports[`E2E: Warning Filtering Edge Cases > respects CLI --no-warnings override > cli-no-warnings-override 1`] = `
+"No tasks found
+"
+`;
+
+exports[`E2E: Warning Filtering Edge Cases > shows warnings correctly with truncation > truncated-warnings 1`] = `
+"No tasks found
+
+⚠️  20 warnings encountered during scanning
+  many-warnings.md:1 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  many-warnings.md:2 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  many-warnings.md:3 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  many-warnings.md:4 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  many-warnings.md:5 - Unsupported bullet marker (* or +). Use dash (-) for task lists.
+  ... and 15 more warnings (use --all-warnings to see all)
+"
+`;

package/tests/e2e/warnings.test.ts

@@ -0,0 +1,186 @@
+/**
+ * E2E Tests: Warning Configuration Profiles
+ *
+ * Tests warning filtering with different configuration profiles using snapshots.
+ */
+
+import { describe, it, expect } from 'vitest';
+import { execSync } from 'child_process';
+import { join } from 'path';
+import { mkdtempSync, writeFileSync, rmSync } from 'fs';
+import { tmpdir } from 'os';
+
+function runCLIWithConfig(
+  config: object,
+  testFiles: Record<string, string>,
+): string {
+  const tmpDir = mkdtempSync(join(tmpdir(), 'md2do-test-'));
+
+  try {
+    // Write config
+    writeFileSync(join(tmpDir, '.md2do.json'), JSON.stringify(config, null, 2));
+
+    // Write test files
+    for (const [filename, content] of Object.entries(testFiles)) {
+      writeFileSync(join(tmpDir, filename), content);
+    }
+
+    // Run CLI - need to capture both stdout and stderr since warnings go to stderr
+    const cliPath = join(__dirname, '../../dist/cli.js');
+    const output = execSync(
+      `node ${cliPath} list --path ${tmpDir} --no-colors 2>&1`,
+      {
+        encoding: 'utf-8',
+      },
+    );
+
+    // Normalize file paths for consistent snapshots across environments
+    // Replace absolute paths with relative paths
+    return output.replace(new RegExp('file://[^\\s]+/packages/cli/', 'g'), '');
+  } finally {
+    rmSync(tmpDir, { recursive: true });
+  }
+}
+
+describe('E2E: Warning Configuration Profiles', () => {
+  const testFiles = {
+    'tasks.md': `
+# Tasks
+
+* [x] Wrong bullet type task
+- [ ]Missing space after checkbox task
+-[x] Missing space before checkbox task
+- [ ] Valid task @alice !! #bug (2026-02-01)
+- [x] Completed task without completion date
+- [ ] Task without a due date
+    `.trim(),
+  };
+
+  it('recommended profile (default)', () => {
+    const output = runCLIWithConfig({}, testFiles);
+
+    // Format warnings shown
+    expect(output).toContain('⚠️');
+    expect(output).toContain('Unsupported bullet');
+    expect(output).toContain('Missing space');
+
+    // Metadata warnings NOT shown (stylistic choice)
+    expect(output).not.toContain('No due date');
+    expect(output).not.toContain('Completed without date');
+
+    expect(output).toMatchSnapshot('recommended-default');
+  });
+
+  it('strict profile', () => {
+    const output = runCLIWithConfig(
+      {
+        warnings: {
+          enabled: true,
+          rules: {
+            'unsupported-bullet': 'error',
+            'malformed-checkbox': 'error',
+            'missing-space-after': 'error',
+            'missing-space-before': 'error',
+            'relative-date-no-context': 'error',
+            'missing-due-date': 'warn',
+            'missing-completed-date': 'warn',
+            'duplicate-todoist-id': 'error',
+            'file-read-error': 'error',
+          },
+        },
+      },
+      testFiles,
+    );
+
+    // ALL warnings shown
+    expect(output).toContain('⚠️');
+    expect(output).toContain('Unsupported bullet');
+    expect(output).toContain('Missing space');
+    expect(output).toContain('Task has no due date');
+    expect(output).toContain('Completed task missing completion date');
+
+    expect(output).toMatchSnapshot('strict-all-warnings');
+  });
+
+  it('custom: all disabled', () => {
+    const output = runCLIWithConfig(
+      {
+        warnings: { enabled: false },
+      },
+      testFiles,
+    );
+
+    expect(output).not.toContain('⚠️');
+    expect(output).toMatchSnapshot('all-disabled');
+  });
+
+  it('custom: only spacing errors', () => {
+    const output = runCLIWithConfig(
+      {
+        warnings: {
+          enabled: true,
+          rules: {
+            'unsupported-bullet': 'off',
+            'malformed-checkbox': 'off',
+            'missing-space-after': 'error',
+            'missing-space-before': 'error',
+            'relative-date-no-context': 'off',
+            'missing-due-date': 'off',
+            'missing-completed-date': 'off',
+            'duplicate-todoist-id': 'error',
+            'file-read-error': 'error',
+          },
+        },
+      },
+      testFiles,
+    );
+
+    // Only space warnings
+    expect(output).toContain('Missing space');
+    expect(output).not.toContain('Unsupported bullet');
+    expect(output).not.toContain('Task has no due date');
+
+    expect(output).toMatchSnapshot('custom-space-only');
+  });
+});
+
+describe('E2E: Warning Filtering Edge Cases', () => {
+  it('shows warnings correctly with truncation', () => {
+    // Create many warnings to test truncation
+    const testFiles = {
+      'many-warnings.md': Array.from(
+        { length: 20 },
+        (_, i) => `* [ ] Task ${i}`,
+      ).join('\n'),
+    };
+
+    const output = runCLIWithConfig({}, testFiles);
+
+    // Should show first 5, then "... and N more"
+    expect(output).toMatch(/and \d+ more warning/);
+    expect(output).toMatchSnapshot('truncated-warnings');
+  });
+
+  it('respects CLI --no-warnings override', () => {
+    const tmpDir = mkdtempSync(join(tmpdir(), 'md2do-test-'));
+
+    try {
+      const testFile = '* [x] Wrong bullet';
+      writeFileSync(join(tmpDir, 'tasks.md'), testFile);
+
+      const cliPath = join(__dirname, '../../dist/cli.js');
+      const output = execSync(
+        `node ${cliPath} list --path ${tmpDir} --no-warnings --no-colors`,
+        {
+          encoding: 'utf-8',
+        },
+      );
+
+      // Should not show warnings even though config has them enabled
+      expect(output).not.toContain('⚠️');
+      expect(output).toMatchSnapshot('cli-no-warnings-override');
+    } finally {
+      rmSync(tmpDir, { recursive: true });
+    }
+  });
+});