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.
230 lines
6.8 KiB
JavaScript
230 lines
6.8 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import { readdir, readFile } from 'node:fs/promises';
|
|
import path from 'node:path';
|
|
import { fileURLToPath, pathToFileURL } from 'node:url';
|
|
|
|
const codeExtensions = new Set(['.ts', '.tsx', '.js', '.jsx', '.mjs', '.cjs', '.py']);
|
|
const runtimeAssetPatterns = [/^packages\/cli\/src\/prompts\/.+\.md$/, /^packages\/cli\/src\/skills\/.+\.md$/];
|
|
const identifierSkipPrefixes = ['docs/', 'docs-site/', 'examples/', 'python/ktx-sl/plans/', 'python/ktx-sl/openspec/'];
|
|
const identifierAllowPatterns = [
|
|
/^packages\/cli\/src\/(?:index|managed-local-embeddings|managed-python-command|managed-python-daemon|managed-python-runtime|release-version|runtime)(?:\.test)?\.ts$/,
|
|
/^python\/ktx-daemon\/src\/ktx_daemon\/__init__\.py$/,
|
|
/^scripts\/(?:build-python-runtime-wheel|local-embeddings-runtime-smoke|package-artifacts|public-npm-release-metadata|published-package-smoke|release-readiness)(?:\.test)?\.mjs$/,
|
|
/^scripts\/semantic-release-config\.cjs$/,
|
|
];
|
|
const forbiddenIdentifierTerms = ['kae' + 'lio', 'Kae' + 'lio', 'KAE' + 'LIO_'];
|
|
|
|
const appImportPatterns = [
|
|
{
|
|
label: 'server source import',
|
|
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*)(?:@server\/|server\/src|(?:\.\.\/)+server\/src)/,
|
|
},
|
|
{
|
|
label: 'frontend source import',
|
|
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*)(?:@frontend\/|frontend\/src|(?:\.\.\/)+frontend\/src)/,
|
|
},
|
|
{
|
|
label: 'python service app import',
|
|
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*|from\s+)(?:python-service\/app|python_service\.app|app\.)/,
|
|
},
|
|
];
|
|
|
|
const llmBoundaryPatterns = [
|
|
{
|
|
label: 'direct Anthropic provider construction',
|
|
pattern: /\bcreateAnthropic\b/,
|
|
},
|
|
{
|
|
label: 'direct Vertex Anthropic provider construction',
|
|
pattern: /\bcreateVertexAnthropic\b/,
|
|
},
|
|
{
|
|
label: 'direct AI SDK gateway construction',
|
|
pattern: /\bcreateGateway\b/,
|
|
},
|
|
{
|
|
label: 'direct AI SDK embedding execution',
|
|
pattern: /\bembedMany\b/,
|
|
},
|
|
{
|
|
label: 'context-owned LLM provider port',
|
|
pattern: /\bLlmProviderPort\b/,
|
|
},
|
|
{
|
|
label: 'scan-owned LLM provider port',
|
|
pattern: /\bKtxScanLlmPort\b/,
|
|
},
|
|
{
|
|
label: 'context-owned gateway LLM provider helper',
|
|
pattern: /\bcreateGatewayLlmProvider\b/,
|
|
},
|
|
];
|
|
|
|
const contextProductionLlmBoundaryPatterns = [
|
|
{
|
|
label: 'context getModelByName call',
|
|
pattern: /\.\s*getModelByName\s*\(/,
|
|
},
|
|
];
|
|
|
|
function normalizePath(filePath) {
|
|
return filePath.split(path.sep).join('/');
|
|
}
|
|
|
|
function isCodeSource(relativePath) {
|
|
return codeExtensions.has(path.extname(relativePath));
|
|
}
|
|
|
|
function isRuntimeAsset(relativePath) {
|
|
return runtimeAssetPatterns.some((pattern) => pattern.test(relativePath));
|
|
}
|
|
|
|
function scansForAppImports(relativePath) {
|
|
return isCodeSource(relativePath);
|
|
}
|
|
|
|
function scansForLlmBoundaries(relativePath) {
|
|
return isCodeSource(relativePath) && relativePath.startsWith('packages/cli/src/context/');
|
|
}
|
|
|
|
function isTestSource(relativePath) {
|
|
return (
|
|
/(?:^|\/)[^/]+\.(?:test|spec)\.[cm]?[jt]sx?$/.test(relativePath) ||
|
|
/(?:^|\/)tests\/(?:.+\/)?(?:test_[^/]+|[^/]+_test)\.py$/.test(relativePath)
|
|
);
|
|
}
|
|
|
|
function scansForContextProductionLlmBoundaries(relativePath) {
|
|
return scansForLlmBoundaries(relativePath) && !isTestSource(relativePath);
|
|
}
|
|
|
|
function scansForForbiddenIdentifiers(relativePath) {
|
|
return (isCodeSource(relativePath) && !isTestSource(relativePath)) || isRuntimeAsset(relativePath);
|
|
}
|
|
|
|
function skipsIdentifierScan(relativePath) {
|
|
return identifierSkipPrefixes.some((prefix) => relativePath.startsWith(prefix));
|
|
}
|
|
|
|
function allowsForbiddenIdentifier(relativePath) {
|
|
return identifierAllowPatterns.some((pattern) => pattern.test(relativePath));
|
|
}
|
|
|
|
export function scanFileContent(relativePath, content) {
|
|
const normalizedPath = normalizePath(relativePath);
|
|
const violations = [];
|
|
|
|
if (scansForAppImports(normalizedPath)) {
|
|
for (const appImportPattern of appImportPatterns) {
|
|
if (appImportPattern.pattern.test(content)) {
|
|
violations.push({
|
|
file: normalizedPath,
|
|
kind: 'app-import',
|
|
message: `Forbidden ${appImportPattern.label}`,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
if (scansForLlmBoundaries(normalizedPath)) {
|
|
for (const llmBoundaryPattern of llmBoundaryPatterns) {
|
|
if (llmBoundaryPattern.pattern.test(content)) {
|
|
violations.push({
|
|
file: normalizedPath,
|
|
kind: 'llm-boundary',
|
|
message: `Forbidden ${llmBoundaryPattern.label}; use packages/cli/src/llm`,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
if (scansForContextProductionLlmBoundaries(normalizedPath)) {
|
|
for (const llmBoundaryPattern of contextProductionLlmBoundaryPatterns) {
|
|
if (llmBoundaryPattern.pattern.test(content)) {
|
|
violations.push({
|
|
file: normalizedPath,
|
|
kind: 'llm-boundary',
|
|
message: `Forbidden ${llmBoundaryPattern.label}; use getModel(role) inside context modules`,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
if (
|
|
scansForForbiddenIdentifiers(normalizedPath) &&
|
|
!skipsIdentifierScan(normalizedPath) &&
|
|
!allowsForbiddenIdentifier(normalizedPath)
|
|
) {
|
|
for (const term of forbiddenIdentifierTerms) {
|
|
if (content.includes(term)) {
|
|
violations.push({
|
|
file: normalizedPath,
|
|
kind: 'identifier',
|
|
message: `Forbidden product identifier "${term}"`,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
return violations;
|
|
}
|
|
|
|
async function collectFiles(rootDir, currentDir = rootDir) {
|
|
const entries = await readdir(currentDir, { withFileTypes: true });
|
|
const files = [];
|
|
|
|
for (const entry of entries) {
|
|
const fullPath = path.join(currentDir, entry.name);
|
|
|
|
if (entry.isDirectory()) {
|
|
if (entry.name === 'node_modules' || entry.name === 'dist' || entry.name === '.venv') {
|
|
continue;
|
|
}
|
|
|
|
files.push(...(await collectFiles(rootDir, fullPath)));
|
|
continue;
|
|
}
|
|
|
|
if (entry.isFile()) {
|
|
files.push(fullPath);
|
|
}
|
|
}
|
|
|
|
return files;
|
|
}
|
|
|
|
export async function collectViolations(rootDir) {
|
|
const files = await collectFiles(rootDir);
|
|
const violations = [];
|
|
|
|
for (const file of files) {
|
|
const relativePath = normalizePath(path.relative(rootDir, file));
|
|
const content = await readFile(file, 'utf8');
|
|
|
|
violations.push(...scanFileContent(relativePath, content));
|
|
}
|
|
|
|
return violations;
|
|
}
|
|
|
|
async function main() {
|
|
const scriptDir = path.dirname(fileURLToPath(import.meta.url));
|
|
const rootDir = path.resolve(scriptDir, '..');
|
|
const violations = await collectViolations(rootDir);
|
|
|
|
if (violations.length === 0) {
|
|
process.stdout.write('ktx boundary check passed\n');
|
|
return;
|
|
}
|
|
|
|
for (const violation of violations) {
|
|
process.stderr.write(`${violation.file}: ${violation.message}\n`);
|
|
}
|
|
|
|
process.exitCode = 1;
|
|
}
|
|
|
|
if (import.meta.url === pathToFileURL(process.argv[1] ?? '').href) {
|
|
await main();
|
|
}
|