mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm * refactor(workspace): rewrite @ktx/llm imports to relative paths * refactor(workspace): fold internal packages into cli * chore(workspace): gate dead-code with knip production mode Turn on production-mode knip plus an autofix run in pre-commit and the `pnpm dead-code` script, document the `/** @internal */` convention for test-only exports in AGENTS.md, annotate test-only exports across the CLI with that JSDoc, and drop dead exports/wrappers the new gate surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`, `createLocalScanEnrichmentProvidersFromConfig`, `PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports). Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit production entries so cross-package barrel leaks are caught. * refactor(cli): delete internal barrel index.ts files The 34 `index.ts` re-export barrels inside `packages/cli/src/` were holdovers from the pre-fold multi-workspace structure. Post-fold-in they served no production purpose: external consumers go through the single package main entry, and in-repo callers mostly imported through them only because the path was short. Internally, knip flagged most barrel re-exports as production-dead (only reached via tests). This change: - Deletes every internal barrel except `packages/cli/src/index.ts` (the published package entry). - Rewrites ~270 source/test files to import each name directly from the file that defines it. - Moves `tools/warehouse-verification/index.ts` to `create-warehouse-verification-tools.ts` (the function it defined locally) and updates its single consumer. - Renames `search/backend-conformance.ts` → `.test-utils.ts` to match the existing test-helper file convention. - Deletes 13 dead test-only chains (dbt-descriptions/*, live-database/extracted-schema, live-database/structural-sync, relationship-* feedback/review chain) plus their tests and a cascading orphan integration test. - Updates test mocks that pointed at deleted barrel paths (notion-client, connector barrels in scan/local-scan-connectors tests) to mock the source files instead. - Points the maintainer benchmark script (`scripts/relationship-benchmark-report.mjs`) at source files instead of `dist/context/scan/index.js`. - Drops the barrel `!` entries from `knip.json`; adds explicit production entries only for the benchmark code reached via dist by the maintainer script. Net: 413 files changed, ~1.2k insertions, ~9.4k deletions. `pnpm run dead-code` (Biome + knip default + knip production) and `pnpm run type-check` are clean; 2277 tests pass. * refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly Promote the CLI workspace package to the public name `@kaelio/ktx` and drop the separate `scripts/build-public-npm-package.mjs` wrapper. The CLI package is now publishable in place (`publishConfig.access: public`, `provenance: true`), so artifact packing uses `pnpm pack` against `packages/cli/` instead of assembling a parallel package tree. Updates all workspace filter invocations, docs, tests, and release readiness checks to reference the new package name, and folds the tarball-name helper into `scripts/public-npm-release-metadata.mjs`. * docs: align "agent clients" and "data agents" terminology Replace "client agents" with "agent clients" and "database agents" with "data agents" across AGENTS.md, README.md, the docs-site copy, and the matching setup-agents test description, matching the canonical vocabulary in docs/terminology.md. Also moves packages/cli/tsconfig.json's tsBuildInfoFile from node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive node_modules reinstalls. * refactor(release): single source of truth for package version Make packages/cli/package.json the single source of truth for the @kaelio/ktx version. publicNpmPackageVersion() now reads it directly, so artifact filenames, release-readiness checks, and the Python wheel version all derive from one field. The duplicate release-policy.json.publicNpmPackageVersion is removed. Previously the two fields could drift: tarballs were named kaelio-ktx-0.4.1.tgz while internally containing @kaelio/ktx@0.0.0-private. - update-public-release-version.mjs rewrites both Python pyproject.toml files (ktx-daemon, ktx-sl) alongside the npm package.jsons, normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2). - semantic-release-config.cjs adds the two pyproject.toml files to @semantic-release/git assets so the release commit back to main carries every version source in lockstep. - The six "?? '0.0.0-private'" fallback literals across the CLI are replaced with "?? getKtxCliPackageInfo().version", and createDefaultKtxMcpServer makes its version arg required. - docs/release.md describes the actual commit-back model: the dev tree always reflects the most recent release; no sentinel pin to maintain. Verified: pnpm run artifacts:build now produces kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with @kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and 2287 vitests + 173 script tests pass. * refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and scan command entrypoints so tests can stub them, and teach resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime feature when ktx.yaml selects sentence-transformers. * chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal Both symbols are consumed only by status-project.test.ts. Annotating with /** @internal */ keeps knip's production-mode check clean without changing runtime behavior. * fix(cli): use real package metadata in print-command-tree The stubbed package name embedded a forbidden product identifier that tripped the boundary check in CI. Read the metadata from package.json instead — keeps the rendered tree unchanged and removes a duplicate source of truth. * feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer source counts, computed with `SUM(embedding_json IS NOT NULL)` over `knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to "Wiki" (canonical per `docs/terminology.md`) and rename the matching `localStats.knowledgePages` field to `localStats.wikiPages`. Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those duplicated the per-surface rows above. Disk now reports only actual byte usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` / `semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry` helpers, and the `filter` arg on `summarizeDir` are removed.
104 lines
3.8 KiB
TypeScript
104 lines
3.8 KiB
TypeScript
import { createRequire } from 'node:module';
|
|
|
|
import type { KtxConnectionArgs } from './connection.js';
|
|
import type { KtxAdminReindexArgs } from './admin-reindex.js';
|
|
import type { KtxDoctorArgs } from './doctor.js';
|
|
import type { KtxKnowledgeArgs } from './knowledge.js';
|
|
import type { KtxPublicIngestArgs } from './public-ingest.js';
|
|
import type { KtxRuntimeArgs } from './runtime.js';
|
|
import type { KtxSetupArgs } from './setup.js';
|
|
import type { KtxSlArgs } from './sl.js';
|
|
import type { KtxSqlArgs } from './sql.js';
|
|
import { profileMark, profileSpan } from './startup-profile.js';
|
|
import type { KtxTextIngestArgs } from './text-ingest.js';
|
|
import { assertCliVersion } from './release-version.js';
|
|
|
|
profileMark('module:cli-runtime');
|
|
|
|
const requirePackageJson = createRequire(import.meta.url);
|
|
|
|
export interface KtxCliPackageInfo {
|
|
name: string;
|
|
version: string;
|
|
}
|
|
|
|
export interface KtxCliIo {
|
|
stdout: { isTTY?: boolean; columns?: number; write(chunk: string): void };
|
|
stderr: { write(chunk: string): void };
|
|
}
|
|
|
|
export interface KtxCliDeps {
|
|
adminReindex?: (args: KtxAdminReindexArgs, io: KtxCliIo) => Promise<number>;
|
|
setup?: (args: KtxSetupArgs, io: KtxCliIo) => Promise<number>;
|
|
connection?: (args: KtxConnectionArgs, io: KtxCliIo) => Promise<number>;
|
|
doctor?: (args: KtxDoctorArgs, io: KtxCliIo) => Promise<number>;
|
|
publicIngest?: (args: KtxPublicIngestArgs, io: KtxCliIo) => Promise<number>;
|
|
textIngest?: (args: KtxTextIngestArgs, io: KtxCliIo) => Promise<number>;
|
|
runtime?: (args: KtxRuntimeArgs, io: KtxCliIo) => Promise<number>;
|
|
knowledge?: (args: KtxKnowledgeArgs, io: KtxCliIo) => Promise<number>;
|
|
sl?: (args: KtxSlArgs, io: KtxCliIo) => Promise<number>;
|
|
sql?: (args: KtxSqlArgs, io: KtxCliIo) => Promise<number>;
|
|
mcp?: {
|
|
startDaemon?: typeof import('./managed-mcp-daemon.js').startKtxMcpDaemon;
|
|
stopDaemon?: typeof import('./managed-mcp-daemon.js').stopKtxMcpDaemon;
|
|
readStatus?: typeof import('./managed-mcp-daemon.js').readKtxMcpDaemonStatus;
|
|
runServer?: typeof import('./mcp-http-server.js').runKtxMcpHttpServer;
|
|
runStdioServer?: typeof import('./mcp-stdio-server.js').runKtxMcpStdioServer;
|
|
};
|
|
}
|
|
|
|
export function getKtxCliPackageInfo(): KtxCliPackageInfo {
|
|
return packageInfoFromJson(requirePackageJson('../package.json'));
|
|
}
|
|
|
|
export function packageInfoFromJson(packageJson: unknown): KtxCliPackageInfo {
|
|
if (
|
|
typeof packageJson !== 'object' ||
|
|
packageJson === null ||
|
|
!('name' in packageJson) ||
|
|
!('version' in packageJson) ||
|
|
typeof packageJson.name !== 'string' ||
|
|
typeof packageJson.version !== 'string'
|
|
) {
|
|
throw new Error('Invalid KTX CLI package metadata');
|
|
}
|
|
|
|
return {
|
|
name: packageJson.name,
|
|
version: assertCliVersion(packageJson.version, `${packageJson.name}/package.json`),
|
|
};
|
|
}
|
|
|
|
async function runInit(args: { projectDir: string; force: boolean }, io: KtxCliIo): Promise<number> {
|
|
const { initKtxProject } = await import('./context/project/project.js');;
|
|
const result = await initKtxProject({
|
|
projectDir: args.projectDir,
|
|
force: args.force,
|
|
});
|
|
|
|
io.stdout.write(`Initialized KTX project at ${result.projectDir}\n`);
|
|
io.stdout.write(`Config: ${result.configPath}\n`);
|
|
io.stdout.write(`Commit: ${result.commitHash ?? 'none'}\n`);
|
|
return 0;
|
|
}
|
|
|
|
export async function runInitForCommander(
|
|
args: { projectDir: string; force: boolean },
|
|
io: KtxCliIo,
|
|
): Promise<number> {
|
|
return await runInit(args, io);
|
|
}
|
|
|
|
export async function runKtxCli(
|
|
argv = process.argv.slice(2),
|
|
io: KtxCliIo = process,
|
|
deps: KtxCliDeps = {},
|
|
): Promise<number> {
|
|
const info = getKtxCliPackageInfo();
|
|
profileMark('runtime:runKtxCli');
|
|
const { runCommanderKtxCli } = await profileSpan('import ./cli-program.js', () => import('./cli-program.js'));
|
|
|
|
return await runCommanderKtxCli(argv, io, deps, info, {
|
|
runInit: runInitForCommander,
|
|
});
|
|
}
|