apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-07-01 08:59:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(cli): survive ktx.yaml version skew and derive repo ownership from disk (#293)

Browse source 
* fix(cli): survive ktx.yaml version skew and derive repo ownership from disk

Loading ktx.yaml is now tolerant of keys this ktx version does not
recognize: they are stripped from the in-memory config (the file on disk
is never rewritten) and reported by ktx status as non-blocking warnings,
while invalid values on recognized fields still fail hard. Repo
ownership is derived from observed state (a .git directory plus a root
ktx.yaml) instead of a ktx.managed git-config marker, so projects
created by any past or future ktx classify identically. initKtxProject
now runs an explicit foreign-repo pre-check and writes ktx.yaml before
initializing git, so an interrupted init leaves only recoverable
residue instead of a bare .git misread as foreign.

* style(cli): trim comment blocks to constraint-only notes

* docs(agents): require constraint-only code comments
This commit is contained in:
Andrey Avtomonov 2026-06-11 22:10:47 +02:00 • committed by GitHub
parent a278d2f7d0
commit 0689d709d2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 502 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

63
packages/cli/test/context/project/project.test.ts
View file

@ -1,5 +1,5 @@
import { execFileSync } from 'node:child_process';
import { mkdir, mkdtemp, readFile, realpath, rm, stat } from 'node:fs/promises';
import { mkdir, mkdtemp, readFile, realpath, rm, stat, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
@ -61,6 +61,31 @@ describe('ktx local project runtime', () => {
});
});
it('loads a ktx.yaml carrying fields removed in a newer ktx without mutating it on disk', async () => {
const projectDir = join(tempDir, 'warehouse');
await initKtxProject({ projectDir });
// Simulate a project written by a different ktx: inject unknown fields into
// the existing storage.git block and as a top-level memory block.
const configPath = join(projectDir, 'ktx.yaml');
const original = await readFile(configPath, 'utf-8');
const withStaleKeys = `${original.replace(
'author: ktx <ktx@example.com>',
'auto_commit: true\n author: ktx <ktx@example.com>',
)}memory:\n auto_commit: true\n`;
await writeFile(configPath, withStaleKeys, 'utf-8');
const loaded = await loadKtxProject({ projectDir });
// Loading tolerates the unknown fields instead of throwing: they are stripped
// from the in-memory config so every command still runs.
expect(loaded.config).not.toHaveProperty('memory');
expect(loaded.config.storage.git).toEqual({ author: 'ktx <ktx@example.com>' });
// The file on disk stays exactly as the user wrote it.
await expect(readFile(configPath, 'utf-8')).resolves.toBe(withStaleKeys);
});
it('initializes a dedicated git repo at the project dir even when nested inside an enclosing repo', async () => {
// A ktx project dir living below an existing git working tree (e.g. an analytics
// subfolder of an app repo). ktx must own its own repo rooted at the project dir,
@ -95,4 +120,40 @@ describe('ktx local project runtime', () => {
configPath: join(projectDir, 'ktx.yaml'),
});
});
it('refuses to initialize inside a foreign git repo and writes nothing into it', async () => {
// A user's own repo: has history, no root ktx.yaml. The guard must reject
// before writing ktx.yaml — that file would make the repo classify as ktx's.
const projectDir = join(tempDir, 'app-repo');
await mkdir(projectDir, { recursive: true });
execFileSync('git', ['init', '-q'], { cwd: projectDir });
await writeFile(join(projectDir, 'README.md'), '# App\n', 'utf-8');
execFileSync('git', ['add', 'README.md'], { cwd: projectDir });
execFileSync(
'git',
['-c', 'user.name=App', '-c', 'user.email=app@example.com', 'commit', '-q', '-m', 'baseline'],
{ cwd: projectDir },
);
await expect(initKtxProject({ projectDir })).rejects.toThrow(
/already a git repository that ktx did not create/,
);
await expect(stat(join(projectDir, 'ktx.yaml'))).rejects.toMatchObject({ code: 'ENOENT' });
const tracked = execFileSync('git', ['ls-files'], { cwd: projectDir, encoding: 'utf-8' });
expect(tracked).not.toContain('ktx.yaml');
});
it('recovers an init interrupted after ktx.yaml was written but before git finished', async () => {
// ktx.yaml is written before git init, so the only crash residue is a valid
// ktx.yaml with no `.git` — the next load must re-init, not reject as foreign.
const projectDir = join(tempDir, 'half-init');
await initKtxProject({ projectDir });
await rm(join(projectDir, '.git'), { recursive: true, force: true });
const loaded = await loadKtxProject({ projectDir });
await expect(stat(join(projectDir, '.git'))).resolves.toBeDefined();
expect(await loaded.git.revParseHead()).toMatch(/^[0-9a-f]{40}$/);
});
});