doc-freshness-checker 1.0.0

package/dist/cli.d.ts

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import type { DocFreshnessConfig, ValidationResults } from './types.js';
+export interface CLIOptions {
+    config?: string;
+    reporter?: string;
+    output?: string;
+    verbose?: boolean;
+    only?: string;
+    skipUrls?: boolean;
+    files?: string;
+    manifest?: string;
+    source?: string;
+    cache?: boolean;
+    clearCache?: boolean;
+    score?: boolean;
+    incremental?: boolean;
+    vectorSearch?: boolean;
+}
+interface CliDeps {
+    loadConfig: (configPath?: string) => Promise<DocFreshnessConfig>;
+    run: (config: DocFreshnessConfig) => Promise<ValidationResults>;
+    logError: (...args: unknown[]) => void;
+}
+export declare function createProgram(): Command;
+export declare function parseCliOptions(argv: string[]): CLIOptions;
+export declare function applyCliOverrides(config: DocFreshnessConfig, options: CLIOptions): void;
+export declare function runCli(options: CLIOptions, deps?: CliDeps): Promise<number>;
+export declare function main(argv?: string[], deps?: CliDeps): Promise<number>;
+export declare function runAsCli(argv?: string[], deps?: CliDeps): Promise<void>;
+export declare function isDirectCliInvocation(argv?: string[]): boolean;
+export {};

package/dist/cli.js

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { run } from './runner.js';
+import { loadConfig } from './config/loader.js';
+import { readFileSync, realpathSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join, resolve } from 'path';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJson = JSON.parse(readFileSync(join(__dirname, '..', 'package.json'), 'utf-8'));
+const defaultDeps = {
+    loadConfig,
+    run,
+    logError: (...args) => console.error(...args),
+};
+export function createProgram() {
+    return new Command()
+        .name('doc-freshness')
+        .description('Check documentation freshness and accuracy for any project')
+        .version(packageJson.version)
+        .option('-c, --config <path>', 'Path to config file')
+        .option('-r, --reporter <type>', 'Reporter type (console, json, markdown)', 'console')
+        .option('-o, --output <path>', 'Output file path for reports')
+        .option('-v, --verbose', 'Enable verbose logging')
+        .option('--only <types>', 'Only check specific reference types (comma-separated)')
+        .option('--skip-urls', 'Skip URL validation')
+        .option('--files <patterns>', 'Only check specific files (comma-separated glob patterns)')
+        .option('--manifest <files>', 'Manifest files to use (comma-separated)')
+        .option('--source <patterns>', 'Source patterns to use (comma-separated)')
+        .option('--no-cache', 'Disable caching')
+        .option('--clear-cache', 'Clear cache before running')
+        .option('--score', 'Include freshness scores in report')
+        .option('--incremental', 'Only check changed files (requires cache)')
+        .option('--vector-search', 'Enable semantic vector search for doc-code mismatches');
+}
+export function parseCliOptions(argv) {
+    return createProgram().parse(argv).opts();
+}
+export function applyCliOverrides(config, options) {
+    if (options.reporter) {
+        config.reporters = [options.reporter];
+    }
+    if (options.output) {
+        config.outputPath = options.output;
+    }
+    if (options.verbose) {
+        config.verbose = true;
+    }
+    if (options.skipUrls) {
+        config.urlValidation ??= {};
+        config.urlValidation.enabled = false;
+    }
+    if (options.only) {
+        const types = options.only.split(',');
+        const rules = (config.rules ??= {});
+        for (const [rule, ruleConfig] of Object.entries(rules)) {
+            if (ruleConfig) {
+                ruleConfig.enabled = types.includes(rule);
+            }
+        }
+    }
+    if (options.files) {
+        config.include = options.files.split(',');
+    }
+    if (options.manifest) {
+        config.manifestFiles = options.manifest.split(',');
+    }
+    if (options.source) {
+        config.sourcePatterns = options.source.split(',');
+    }
+    if (options.cache === false) {
+        config.cache = { enabled: false };
+    }
+    if (options.clearCache) {
+        config.clearCache = true;
+    }
+    if (options.score) {
+        config.freshnessScoring = { ...config.freshnessScoring, enabled: true };
+    }
+    if (options.incremental) {
+        config.incremental = { enabled: true };
+    }
+    if (options.vectorSearch) {
+        config.vectorSearch = { ...config.vectorSearch, enabled: true };
+    }
+}
+export async function runCli(options, deps = defaultDeps) {
+    try {
+        const config = await deps.loadConfig(options.config);
+        applyCliOverrides(config, options);
+        const result = await deps.run(config);
+        // Exit with error code if there are errors
+        if (result.summary.errors > 0) {
+            return 1;
+        }
+        return 0;
+    }
+    catch (error) {
+        deps.logError('Error:', error.message);
+        if (options.verbose) {
+            deps.logError(error.stack);
+        }
+        return 1;
+    }
+}
+export async function main(argv = process.argv, deps = defaultDeps) {
+    const options = parseCliOptions(argv);
+    return runCli(options, deps);
+}
+// This wrapper keeps the process-exit side effect out of `main` so tests can
+// verify CLI behavior without terminating the Vitest process.
+export async function runAsCli(argv = process.argv, deps = defaultDeps) {
+    const options = parseCliOptions(argv);
+    const exitCode = await runCli(options, deps);
+    if (exitCode !== 0) {
+        process.exit(exitCode);
+    }
+}
+function toRealPath(filePath) {
+    try {
+        return realpathSync(filePath);
+    }
+    catch {
+        return resolve(filePath);
+    }
+}
+export function isDirectCliInvocation(argv = process.argv) {
+    const entryPath = argv[1];
+    if (!entryPath) {
+        return false;
+    }
+    return toRealPath(entryPath) === toRealPath(__filename);
+}
+if (isDirectCliInvocation()) {
+    void runAsCli();
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG9C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAMtC,MAAM,WAAW,GAAgB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAyB1G,MAAM,WAAW,GAAY;IAC3B,UAAU;IACV,GAAG;IACH,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;CAC9C,CAAC;AAEF,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,OAAO,EAAE;SACjB,IAAI,CAAC,eAAe,CAAC;SACrB,WAAW,CAAC,4DAA4D,CAAC;SACzE,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC;SAC5B,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;SACpD,MAAM,CAAC,uBAAuB,EAAE,yCAAyC,EAAE,SAAS,CAAC;SACrF,MAAM,CAAC,qBAAqB,EAAE,8BAA8B,CAAC;SAC7D,MAAM,CAAC,eAAe,EAAE,wBAAwB,CAAC;SACjD,MAAM,CAAC,gBAAgB,EAAE,uDAAuD,CAAC;SACjF,MAAM,CAAC,aAAa,EAAE,qBAAqB,CAAC;SAC5C,MAAM,CAAC,oBAAoB,EAAE,2DAA2D,CAAC;SACzF,MAAM,CAAC,oBAAoB,EAAE,yCAAyC,CAAC;SACvE,MAAM,CAAC,qBAAqB,EAAE,0CAA0C,CAAC;SACzE,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC;SACvC,MAAM,CAAC,eAAe,EAAE,4BAA4B,CAAC;SACrD,MAAM,CAAC,SAAS,EAAE,oCAAoC,CAAC;SACvD,MAAM,CAAC,eAAe,EAAE,2CAA2C,CAAC;SACpE,MAAM,CAAC,iBAAiB,EAAE,uDAAuD,CAAC,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAc;IAC5C,OAAO,aAAa,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAc,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAA0B,EAAE,OAAmB;IAC/E,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,SAAS,GAAG,CAAC,OAAO,CAAC,QAAwD,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IACrC,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IACxB,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,aAAa,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,aAAa,CAAC,OAAO,GAAG,KAAK,CAAC;IACvC,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,IAAI,UAAU,EAAE,CAAC;gBACf,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,gBAAgB,GAAG,EAAE,GAAG,MAAM,CAAC,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC1E,CAAC;IACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,CAAC,WAAW,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACzC,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,YAAY,GAAG,EAAE,GAAG,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAClE,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAmB,EAAE,OAAgB,WAAW;IAC3E,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEtC,2CAA2C;QAC3C,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAG,KAAe,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,CAAE,KAAe,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAiB,OAAO,CAAC,IAAI,EAAE,OAAgB,WAAW;IACnF,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,6EAA6E;AAC7E,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAiB,OAAO,CAAC,IAAI,EAAE,OAAgB,WAAW;IACvF,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,QAAgB;IAClC,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAiB,OAAO,CAAC,IAAI;IACjE,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC;AAC1D,CAAC;AAED,IAAI,qBAAqB,EAAE,EAAE,CAAC;IAC5B,KAAK,QAAQ,EAAE,CAAC;AAClB,CAAC"}

package/dist/cli.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli.test.js

@@ -0,0 +1,184 @@
+import { mkdtemp, symlink, rm } from 'fs/promises';
+import { tmpdir } from 'os';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { applyCliOverrides, isDirectCliInvocation, main, parseCliOptions, runAsCli, runCli } from './cli.js';
+afterEach(() => {
+    vi.restoreAllMocks();
+});
+function makeConfig() {
+    return {
+        reporters: ['console'],
+        rules: {
+            'file-path': { enabled: true },
+            'external-url': { enabled: true },
+            version: { enabled: true },
+        },
+        urlValidation: { enabled: true },
+        cache: { enabled: true },
+    };
+}
+function makeResults(errors) {
+    return {
+        documents: [],
+        summary: {
+            total: 0,
+            valid: 0,
+            errors,
+            warnings: 0,
+            skipped: 0,
+        },
+    };
+}
+describe('CLI option parsing', () => {
+    it('parses supported flags and values', () => {
+        const options = parseCliOptions([
+            'node',
+            'doc-freshness',
+            '--config',
+            'my-config.json',
+            '--reporter',
+            'json',
+            '--only',
+            'file-path,version',
+            '--no-cache',
+            '--vector-search',
+        ]);
+        expect(options.config).toBe('my-config.json');
+        expect(options.reporter).toBe('json');
+        expect(options.only).toBe('file-path,version');
+        expect(options.cache).toBe(false);
+        expect(options.vectorSearch).toBe(true);
+    });
+});
+describe('applyCliOverrides', () => {
+    it('applies all overrideable CLI options to config', () => {
+        const config = makeConfig();
+        const options = {
+            reporter: 'markdown',
+            output: 'reports/out.md',
+            verbose: true,
+            skipUrls: true,
+            only: 'version',
+            files: 'docs/**/*.md,README.md',
+            manifest: 'package.json,requirements.txt',
+            source: 'src/**/*.ts,lib/**/*.ts',
+            cache: false,
+            clearCache: true,
+            score: true,
+            incremental: true,
+            vectorSearch: true,
+        };
+        applyCliOverrides(config, options);
+        expect(config.reporters).toEqual(['markdown']);
+        expect(config.outputPath).toBe('reports/out.md');
+        expect(config.verbose).toBe(true);
+        expect(config.urlValidation?.enabled).toBe(false);
+        expect(config.rules?.version?.enabled).toBe(true);
+        expect(config.rules?.['file-path']?.enabled).toBe(false);
+        expect(config.rules?.['external-url']?.enabled).toBe(false);
+        expect(config.include).toEqual(['docs/**/*.md', 'README.md']);
+        expect(config.manifestFiles).toEqual(['package.json', 'requirements.txt']);
+        expect(config.sourcePatterns).toEqual(['src/**/*.ts', 'lib/**/*.ts']);
+        expect(config.cache).toEqual({ enabled: false });
+        expect(config.clearCache).toBe(true);
+        expect(config.freshnessScoring?.enabled).toBe(true);
+        expect(config.incremental?.enabled).toBe(true);
+        expect(config.vectorSearch?.enabled).toBe(true);
+    });
+});
+describe('runCli', () => {
+    it('returns 0 on successful run with no errors', async () => {
+        const loadConfigMock = vi.fn().mockResolvedValue(makeConfig());
+        const runMock = vi.fn().mockResolvedValue(makeResults(0));
+        const logErrorMock = vi.fn();
+        const exitCode = await runCli({ config: 'doc-freshness.config.ts' }, {
+            loadConfig: loadConfigMock,
+            run: runMock,
+            logError: logErrorMock,
+        });
+        expect(exitCode).toBe(0);
+        expect(loadConfigMock).toHaveBeenCalledWith('doc-freshness.config.ts');
+        expect(runMock).toHaveBeenCalledTimes(1);
+        expect(logErrorMock).not.toHaveBeenCalled();
+    });
+    it('returns 1 when validation reports errors', async () => {
+        const exitCode = await runCli({}, {
+            loadConfig: vi.fn().mockResolvedValue(makeConfig()),
+            run: vi.fn().mockResolvedValue(makeResults(2)),
+            logError: vi.fn(),
+        });
+        expect(exitCode).toBe(1);
+    });
+    it('returns 1 and logs error details on exception', async () => {
+        const logErrorMock = vi.fn();
+        const thrown = new Error('boom');
+        const exitCode = await runCli({ verbose: true }, {
+            loadConfig: vi.fn().mockRejectedValue(thrown),
+            run: vi.fn(),
+            logError: logErrorMock,
+        });
+        expect(exitCode).toBe(1);
+        expect(logErrorMock).toHaveBeenCalledWith('Error:', 'boom');
+        expect(logErrorMock).toHaveBeenCalledWith(thrown.stack);
+    });
+});
+describe('main', () => {
+    it('parses argv and applies options before running', async () => {
+        const runMock = vi.fn().mockResolvedValue(makeResults(0));
+        const deps = {
+            loadConfig: vi.fn().mockResolvedValue(makeConfig()),
+            run: runMock,
+            logError: vi.fn(),
+        };
+        const exitCode = await main(['node', 'doc-freshness', '--reporter', 'json', '--no-cache'], deps);
+        expect(exitCode).toBe(0);
+        expect(runMock).toHaveBeenCalledWith(expect.objectContaining({
+            reporters: ['json'],
+            cache: { enabled: false },
+        }));
+    });
+});
+describe('runAsCli', () => {
+    it('calls process.exit when CLI run fails', async () => {
+        const exitSpy = vi.spyOn(process, 'exit').mockImplementation((() => undefined));
+        const deps = {
+            loadConfig: vi.fn().mockResolvedValue(makeConfig()),
+            run: vi.fn().mockResolvedValue(makeResults(1)),
+            logError: vi.fn(),
+        };
+        await runAsCli(['node', 'doc-freshness'], deps);
+        expect(exitSpy).toHaveBeenCalledWith(1);
+    });
+    it('does not call process.exit on successful run', async () => {
+        const exitSpy = vi.spyOn(process, 'exit').mockImplementation((() => undefined));
+        const deps = {
+            loadConfig: vi.fn().mockResolvedValue(makeConfig()),
+            run: vi.fn().mockResolvedValue(makeResults(0)),
+            logError: vi.fn(),
+        };
+        await runAsCli(['node', 'doc-freshness'], deps);
+        expect(exitSpy).not.toHaveBeenCalled();
+    });
+});
+describe('isDirectCliInvocation', () => {
+    const cliPath = fileURLToPath(new URL('./cli.ts', import.meta.url));
+    it('returns true when argv entry points directly to cli file', () => {
+        expect(isDirectCliInvocation(['node', cliPath])).toBe(true);
+    });
+    it('returns true when argv entry is a symlink to cli file', async () => {
+        const tempDir = await mkdtemp(path.join(tmpdir(), 'doc-freshness-cli-'));
+        const linkPath = path.join(tempDir, 'doc-freshness');
+        await symlink(cliPath, linkPath);
+        try {
+            expect(isDirectCliInvocation(['node', linkPath])).toBe(true);
+        }
+        finally {
+            await rm(tempDir, { recursive: true, force: true });
+        }
+    });
+    it('returns false when argv entry points elsewhere', () => {
+        expect(isDirectCliInvocation(['node', '/tmp/not-cli.js'])).toBe(false);
+    });
+});
+//# sourceMappingURL=cli.test.js.map

package/dist/cli.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.test.js","sourceRoot":"","sources":["../src/cli.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAmB,MAAM,UAAU,CAAC;AAG9H,SAAS,CAAC,GAAG,EAAE;IACb,EAAE,CAAC,eAAe,EAAE,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH,SAAS,UAAU;IACjB,OAAO;QACL,SAAS,EAAE,CAAC,SAAS,CAAC;QACtB,KAAK,EAAE;YACL,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YAC9B,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YACjC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;SAC3B;QACD,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QAChC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;KACzB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO;QACL,SAAS,EAAE,EAAE;QACb,OAAO,EAAE;YACP,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,MAAM;YACN,QAAQ,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;SACX;KACF,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,OAAO,GAAG,eAAe,CAAC;YAC9B,MAAM;YACN,eAAe;YACf,UAAU;YACV,gBAAgB;YAChB,YAAY;YACZ,MAAM;YACN,QAAQ;YACR,mBAAmB;YACnB,YAAY;YACZ,iBAAiB;SAClB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAe;YAC1B,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,gBAAgB;YACxB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,wBAAwB;YAC/B,QAAQ,EAAE,+BAA+B;YACzC,MAAM,EAAE,yBAAyB;YACjC,KAAK,EAAE,KAAK;YACZ,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC;QAEF,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,YAAY,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAC3B,EAAE,MAAM,EAAE,yBAAyB,EAAE,EACrC;YACE,UAAU,EAAE,cAAc;YAC1B,GAAG,EAAE,OAAO;YACZ,QAAQ,EAAE,YAAY;SACvB,CACF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;QACvE,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAC3B,EAAE,EACF;YACE,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACnD,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC9C,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CACF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,YAAY,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAC3B,EAAE,OAAO,EAAE,IAAI,EAAE,EACjB;YACE,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC;YAC7C,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YACZ,QAAQ,EAAE,YAAY;SACvB,CACF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACnD,GAAG,EAAE,OAAO;YACZ,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC;QAEjG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAClC,MAAM,CAAC,gBAAgB,CAAC;YACtB,SAAS,EAAE,CAAC,MAAM,CAAC;YACnB,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;SAC1B,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAU,CAAC,CAAC;QACzF,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACnD,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC9C,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QAEF,MAAM,QAAQ,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAU,CAAC,CAAC;QACzF,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACnD,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC9C,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QAEF,MAAM,QAAQ,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpE,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErD,MAAM,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEjC,IAAI,CAAC;YACH,MAAM,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC;gBAAS,CAAC;YACT,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/config/defaults.d.ts

@@ -0,0 +1,5 @@
+import type { DocFreshnessConfig } from '../types.js';
+/**
+ * Default configuration values for Documentation Freshness Checker
+ */
+export declare const DEFAULT_CONFIG: DocFreshnessConfig;

package/dist/config/defaults.js

@@ -0,0 +1,135 @@
+/**
+ * Default configuration values for Documentation Freshness Checker
+ */
+export const DEFAULT_CONFIG = {
+    // Root directory for resolving paths (defaults to process.cwd())
+    rootDir: process.cwd(),
+    // Documentation files to check
+    include: ['docs/**/*.md', 'README.md'],
+    // Files to exclude
+    exclude: ['**/node_modules/**', '**/vendor/**', '**/dist/**', '**/build/**'],
+    // Manifest files to read for version/dependency checking
+    // Auto-detected if not specified
+    manifestFiles: null,
+    // Source code patterns for code pattern validation
+    // Auto-detected if not specified
+    sourcePatterns: null,
+    // URL validation settings
+    urlValidation: {
+        enabled: true,
+        timeout: 10000,
+        concurrency: 5,
+        skipDomains: ['localhost', '127.0.0.1', 'example.com'],
+        cacheSeconds: 3600,
+    },
+    // Validation rules configuration
+    rules: {
+        'file-path': {
+            enabled: true,
+            severity: 'error',
+            // Patterns to identify illustrative/placeholder paths (regex strings)
+            illustrativePatterns: [
+                // Generic placeholder prefixes (case-insensitive match on filename)
+                '^(?:Your|My|Example|Sample|Demo|Test|Foo|Bar|Baz|Dummy|Mock|Fake|Stub)',
+                // Common tutorial placeholders
+                '^(?:first|second|third|another|some|new)\\.',
+                // Placeholder with angle brackets or curly braces in name
+                '<[^>]+>',
+                '\\{[^}]+\\}',
+                // Paths containing obvious placeholder segments
+                '/(?:your|my|example|sample)-',
+                '/\\[.*\\]/', // Paths with [brackets]
+            ],
+            skipIllustrative: true,
+        },
+        'external-url': {
+            enabled: true,
+            severity: 'warning',
+        },
+        version: {
+            enabled: true,
+            severity: 'warning',
+            allowMinorDrift: true,
+        },
+        'directory-structure': {
+            enabled: true,
+            severity: 'warning',
+            // Patterns to identify illustrative/placeholder paths in directory trees
+            illustrativePatterns: [
+                // Generic placeholder prefixes (case-insensitive match on filename)
+                '^(?:Your|My|Example|Sample|Demo|Test|Foo|Bar|Baz|Dummy|Mock|Fake|Stub)',
+                // Common tutorial placeholders
+                '^(?:first|second|third|another|some|new)\\.',
+                // Very short generic names without extensions (likely placeholders)
+                '^(?:foo|bar|baz|qux|quux)$',
+            ],
+            skipIllustrative: true,
+        },
+        'code-pattern': {
+            enabled: true,
+            severity: 'warning',
+        },
+        dependency: {
+            enabled: true,
+            severity: 'info',
+        },
+    },
+    // Reporter configuration
+    reporters: ['console'],
+    // Output directory for reports
+    outputDir: '.doc-freshness-reports',
+    // Ignore patterns (regex strings)
+    ignorePatterns: [],
+    // Custom extractors (advanced)
+    customExtractors: [],
+    // Custom validators (advanced)
+    customValidators: {},
+    // Code-to-Doc Graph settings
+    graph: {
+        enabled: true,
+        cacheDir: '.doc-freshness-cache',
+        cacheMaxAge: 24 * 60 * 60 * 1000, // 24 hours for non-git repos
+    },
+    // Git integration settings
+    git: {
+        enabled: true, // Auto-detected
+        trackChanges: true, // Enable incremental checking
+        changeWindow: 7, // Days to look back for changes
+    },
+    // Freshness scoring settings
+    freshnessScoring: {
+        enabled: false,
+        weights: {
+            referenceValidity: 0.4,
+            gitTimeDelta: 0.3,
+            codeChangeFrequency: 0.15,
+            symbolCoverage: 0.15,
+        },
+        thresholds: {
+            gradeA: 90,
+            gradeB: 80,
+            gradeC: 70,
+            gradeD: 60,
+        },
+    },
+    // Vector search settings (optional, requires fastembed package)
+    vectorSearch: {
+        enabled: false, // Disabled by default
+        similarityThreshold: 0.3, // Lower = stricter matching
+        indexCodeComments: true,
+        indexDocstrings: true,
+    },
+    // Cache settings
+    cache: {
+        enabled: true,
+        dir: '.doc-freshness-cache',
+        maxAge: 24 * 60 * 60 * 1000,
+    },
+    // Incremental checking (only check changed files)
+    incremental: {
+        enabled: false,
+    },
+    // Verbose logging
+    verbose: false,
+};
+//# sourceMappingURL=defaults.js.map

package/dist/config/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/config/defaults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAuB;IAChD,iEAAiE;IACjE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;IAEtB,+BAA+B;IAC/B,OAAO,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC;IAEtC,mBAAmB;IACnB,OAAO,EAAE,CAAC,oBAAoB,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,CAAC;IAE5E,yDAAyD;IACzD,iCAAiC;IACjC,aAAa,EAAE,IAAI;IAEnB,mDAAmD;IACnD,iCAAiC;IACjC,cAAc,EAAE,IAAI;IAEpB,0BAA0B;IAC1B,aAAa,EAAE;QACb,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,CAAC;QACd,WAAW,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC;QACtD,YAAY,EAAE,IAAI;KACnB;IAED,iCAAiC;IACjC,KAAK,EAAE;QACL,WAAW,EAAE;YACX,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,OAAO;YACjB,sEAAsE;YACtE,oBAAoB,EAAE;gBACpB,oEAAoE;gBACpE,wEAAwE;gBACxE,+BAA+B;gBAC/B,6CAA6C;gBAC7C,0DAA0D;gBAC1D,SAAS;gBACT,aAAa;gBACb,gDAAgD;gBAChD,8BAA8B;gBAC9B,YAAY,EAAE,wBAAwB;aACvC;YACD,gBAAgB,EAAE,IAAI;SACvB;QACD,cAAc,EAAE;YACd,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;YACnB,eAAe,EAAE,IAAI;SACtB;QACD,qBAAqB,EAAE;YACrB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;YACnB,yEAAyE;YACzE,oBAAoB,EAAE;gBACpB,oEAAoE;gBACpE,wEAAwE;gBACxE,+BAA+B;gBAC/B,6CAA6C;gBAC7C,oEAAoE;gBACpE,4BAA4B;aAC7B;YACD,gBAAgB,EAAE,IAAI;SACvB;QACD,cAAc,EAAE;YACd,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB;QACD,UAAU,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,MAAM;SACjB;KACF;IAED,yBAAyB;IACzB,SAAS,EAAE,CAAC,SAAS,CAAC;IAEtB,+BAA+B;IAC/B,SAAS,EAAE,wBAAwB;IAEnC,kCAAkC;IAClC,cAAc,EAAE,EAAE;IAElB,+BAA+B;IAC/B,gBAAgB,EAAE,EAAE;IAEpB,+BAA+B;IAC/B,gBAAgB,EAAE,EAAE;IAEpB,6BAA6B;IAC7B,KAAK,EAAE;QACL,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,sBAAsB;QAChC,WAAW,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,6BAA6B;KAChE;IAED,2BAA2B;IAC3B,GAAG,EAAE;QACH,OAAO,EAAE,IAAI,EAAE,gBAAgB;QAC/B,YAAY,EAAE,IAAI,EAAE,8BAA8B;QAClD,YAAY,EAAE,CAAC,EAAE,gCAAgC;KAClD;IAED,6BAA6B;IAC7B,gBAAgB,EAAE;QAChB,OAAO,EAAE,KAAK;QACd,OAAO,EAAE;YACP,iBAAiB,EAAE,GAAG;YACtB,YAAY,EAAE,GAAG;YACjB,mBAAmB,EAAE,IAAI;YACzB,cAAc,EAAE,IAAI;SACrB;QACD,UAAU,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;SACX;KACF;IAED,gEAAgE;IAChE,YAAY,EAAE;QACZ,OAAO,EAAE,KAAK,EAAE,sBAAsB;QACtC,mBAAmB,EAAE,GAAG,EAAE,4BAA4B;QACtD,iBAAiB,EAAE,IAAI;QACvB,eAAe,EAAE,IAAI;KACtB;IAED,iBAAiB;IACjB,KAAK,EAAE;QACL,OAAO,EAAE,IAAI;QACb,GAAG,EAAE,sBAAsB;QAC3B,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;KAC5B;IAED,kDAAkD;IAClD,WAAW,EAAE;QACX,OAAO,EAAE,KAAK;KACf;IAED,kBAAkB;IAClB,OAAO,EAAE,KAAK;CACf,CAAC"}

package/dist/config/defineConfig.d.ts

@@ -0,0 +1,28 @@
+import type { DocFreshnessConfig } from '../types.js';
+/**
+ * Define configuration for Documentation Freshness Checker.
+ *
+ * This helper function provides IntelliSense support for configuration options.
+ *
+ * @example
+ * ```ts
+ * // .doc-freshness.config.js
+ * import { defineConfig } from 'doc-freshness-checker';
+ *
+ * export default defineConfig({
+ *   include: ['docs/**‍/*.md', 'README.md'],
+ *   exclude: ['**‍/node_modules/**'],
+ *   rules: {
+ *     'file-path': { enabled: true, severity: 'error' },
+ *     'external-url': { enabled: true, severity: 'warning' },
+ *   },
+ *   vectorSearch: {
+ *     enabled: true,
+ *   },
+ * });
+ * ```
+ *
+ * @param config - Configuration object
+ * @returns The same configuration object (for type inference)
+ */
+export declare function defineConfig(config: DocFreshnessConfig): DocFreshnessConfig;

package/dist/config/defineConfig.js

@@ -0,0 +1,30 @@
+/**
+ * Define configuration for Documentation Freshness Checker.
+ *
+ * This helper function provides IntelliSense support for configuration options.
+ *
+ * @example
+ * ```ts
+ * // .doc-freshness.config.js
+ * import { defineConfig } from 'doc-freshness-checker';
+ *
+ * export default defineConfig({
+ *   include: ['docs/**‍/*.md', 'README.md'],
+ *   exclude: ['**‍/node_modules/**'],
+ *   rules: {
+ *     'file-path': { enabled: true, severity: 'error' },
+ *     'external-url': { enabled: true, severity: 'warning' },
+ *   },
+ *   vectorSearch: {
+ *     enabled: true,
+ *   },
+ * });
+ * ```
+ *
+ * @param config - Configuration object
+ * @returns The same configuration object (for type inference)
+ */
+export function defineConfig(config) {
+    return config;
+}
+//# sourceMappingURL=defineConfig.js.map

package/dist/config/defineConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineConfig.js","sourceRoot":"","sources":["../../src/config/defineConfig.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,YAAY,CAAC,MAA0B;IACrD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/config/defineConfig.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/config/defineConfig.test.js

@@ -0,0 +1,10 @@
+import { defineConfig } from './defineConfig.js';
+describe('defineConfig', () => {
+    it('returns the same config object for type inference', () => {
+        const input = { include: ['docs/**/*.md'], verbose: true };
+        const result = defineConfig(input);
+        expect(result).toBe(input);
+        expect(result).toEqual({ include: ['docs/**/*.md'], verbose: true });
+    });
+});
+//# sourceMappingURL=defineConfig.test.js.map

package/dist/config/defineConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineConfig.test.js","sourceRoot":"","sources":["../../src/config/defineConfig.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC3D,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/config/loader.d.ts

@@ -0,0 +1,7 @@
+import { DEFAULT_CONFIG } from './defaults.js';
+import type { DocFreshnessConfig } from '../types.js';
+export { DEFAULT_CONFIG };
+/**
+ * Load and merge configuration
+ */
+export declare function loadConfig(configPath?: string): Promise<DocFreshnessConfig>;