Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pnpm-debug.log*
npm-debug.log*
yarn-debug.log*
docs.config.json
docs.lock
/docs-lock.json
coverage
TODO.md
.docs/
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pnpm.
## Cache layout

- Materialized sources live at `.docs/<id>/`.
- Lock file lives next to `docs.config.json` as `docs.lock`.
- Lock file lives next to `docs.config.json` as `docs-lock.json`.

## CLI architecture

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Documentation is cached in a gitignored location, exposed to agent and tool targ
## Features

- **Local only**: Cache lives in the directory `.docs` (or a custom location) and _should_ be gitignored.
- **Deterministic**: `docs.lock` pins commits and file metadata.
- **Deterministic**: `docs-lock.json` pins commits and file metadata.
- **Fast**: Local cache avoids network roundtrips after sync.
- **Flexible**: Cache full repos or just the subdirectories you need.

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"dependencies": {
"@clack/prompts": "^1.0.0",
"cac": "^6.7.14",
"execa": "^9.6.1",
"fast-glob": "^3.3.2",
"picocolors": "^1.1.1",
"picomatch": "^2.3.1",
Expand Down
121 changes: 121 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion scripts/benchmarks/run.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
verifyCache,
} from "../../dist/api.mjs";
import {
DEFAULT_LOCK_FILENAME,
readLock,
resolveLockPath,
validateLock,
Expand Down Expand Up @@ -286,7 +287,7 @@ const main = async () => {
() => {
const tempLock = path.join(
benchRoot,
`docs.lock.${Math.random().toString(36).slice(2)}`,
`${DEFAULT_LOCK_FILENAME}.${Math.random().toString(36).slice(2)}`,
);
return writeLock(tempLock, lockData);
},
Expand Down
1 change: 1 addition & 0 deletions src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export { loadConfig } from "./config";
export { redactRepoUrl } from "./git/redact";
export { enforceHostAllowlist, parseLsRemote } from "./git/resolve-remote";
export { initConfig } from "./init";
export { DEFAULT_LOCK_FILENAME } from "./lock";
export { pruneCache } from "./prune";
export { removeSources } from "./remove";
export { resolveRepoInput } from "./resolve-repo";
Expand Down
Loading
Loading