@jarkkojs/readseek-api 0.9.14 → 0.9.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +176 -0
- package/README.md +2 -1
- package/bin/readseek.cjs +55 -0
- package/dist/argv.d.ts +2 -0
- package/dist/client.d.ts +11 -0
- package/dist/contract.d.ts +2 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +41 -6
- package/package.json +12 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
CHANGED
package/bin/readseek.cjs
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
// Copyright (C) Jarkko Sakkinen 2026
|
|
4
|
+
|
|
5
|
+
const { execFileSync } = require('node:child_process');
|
|
6
|
+
const fs = require('node:fs');
|
|
7
|
+
const path = require('node:path');
|
|
8
|
+
|
|
9
|
+
function resolveBinary() {
|
|
10
|
+
const platform = `${process.platform}-${process.arch}`;
|
|
11
|
+
const packages = {
|
|
12
|
+
'darwin-arm64': '@jarkkojs/readseek-darwin-arm64',
|
|
13
|
+
'linux-arm64': '@jarkkojs/readseek-linux-arm64',
|
|
14
|
+
'linux-x64': '@jarkkojs/readseek-linux-x64',
|
|
15
|
+
'win32-x64': '@jarkkojs/readseek-win32-x64',
|
|
16
|
+
};
|
|
17
|
+
const packageName = packages[platform];
|
|
18
|
+
if (!packageName) {
|
|
19
|
+
throw new Error(
|
|
20
|
+
`unsupported platform: ${platform}; supported platforms: ${Object.keys(packages).join(', ')}`
|
|
21
|
+
);
|
|
22
|
+
}
|
|
23
|
+
const binaryName = process.platform === 'win32' ? 'readseek.exe' : 'readseek';
|
|
24
|
+
|
|
25
|
+
let packageDir;
|
|
26
|
+
try {
|
|
27
|
+
packageDir = path.dirname(
|
|
28
|
+
require.resolve(`${packageName}/package.json`, { paths: [__dirname] })
|
|
29
|
+
);
|
|
30
|
+
} catch {
|
|
31
|
+
throw new Error(
|
|
32
|
+
`package ${packageName} is not installed; ` +
|
|
33
|
+
'install the optional platform-specific dependency'
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
const binaryPath = path.join(packageDir, 'bin', binaryName);
|
|
38
|
+
if (!fs.existsSync(binaryPath)) {
|
|
39
|
+
throw new Error(`binary not found: ${binaryPath}`);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return binaryPath;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
try {
|
|
46
|
+
const binary = resolveBinary();
|
|
47
|
+
const args = process.argv.slice(2);
|
|
48
|
+
execFileSync(binary, args, { stdio: 'inherit' });
|
|
49
|
+
} catch (err) {
|
|
50
|
+
if (typeof err.status === 'number') {
|
|
51
|
+
process.exit(err.status);
|
|
52
|
+
}
|
|
53
|
+
console.error(err.message);
|
|
54
|
+
process.exit(1);
|
|
55
|
+
}
|
package/dist/argv.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { DigestFacet, DocumentNodeKind, VisionAnalysisMode, VisionLevel, VisionMode } from "./contract.ts";
|
|
2
2
|
import { type GitSelectionInput } from "./validation.ts";
|
|
3
|
+
export declare const DEFAULT_DIGEST_MAP_DEPTH = 1;
|
|
3
4
|
export declare function buildLineLocation(line: number, column?: number): string;
|
|
4
5
|
export declare function appendGitSelectionArgs(args: string[], input: GitSelectionInput): string[];
|
|
5
6
|
export type ApplyPlanHashOrder = "plan-hash-first" | "apply-first";
|
|
@@ -15,6 +16,7 @@ export type DigestArgsInput = {
|
|
|
15
16
|
at?: string;
|
|
16
17
|
end?: number;
|
|
17
18
|
limit?: number;
|
|
19
|
+
depth?: number;
|
|
18
20
|
language?: string;
|
|
19
21
|
visionMode?: VisionMode;
|
|
20
22
|
visionLevel?: VisionLevel;
|
package/dist/client.d.ts
CHANGED
|
@@ -24,11 +24,21 @@ export interface ReadSeekSymbol {
|
|
|
24
24
|
start_anchor?: string;
|
|
25
25
|
end_anchor?: string;
|
|
26
26
|
}
|
|
27
|
+
export interface ReadSeekMapNode {
|
|
28
|
+
kind: string;
|
|
29
|
+
name: string;
|
|
30
|
+
start_line: number;
|
|
31
|
+
end_line: number;
|
|
32
|
+
start_anchor: string;
|
|
33
|
+
end_anchor: string;
|
|
34
|
+
children: ReadSeekMapNode[];
|
|
35
|
+
}
|
|
27
36
|
export interface ReadSeekMapOutput {
|
|
28
37
|
file: string;
|
|
29
38
|
language: string;
|
|
30
39
|
line_count: number;
|
|
31
40
|
file_hash: string;
|
|
41
|
+
root: ReadSeekMapNode;
|
|
32
42
|
symbols: ReadSeekSymbol[];
|
|
33
43
|
}
|
|
34
44
|
export interface ReadSeekSearchCapture {
|
|
@@ -213,6 +223,7 @@ export interface ReadSeekDigestOptions {
|
|
|
213
223
|
at?: string;
|
|
214
224
|
end?: number;
|
|
215
225
|
limit?: number;
|
|
226
|
+
depth?: number;
|
|
216
227
|
language?: string;
|
|
217
228
|
visionMode?: VisionMode;
|
|
218
229
|
visionLevel?: VisionLevel;
|
package/dist/contract.d.ts
CHANGED
|
@@ -38,6 +38,7 @@ export declare const PARAM_DESCRIPTIONS: {
|
|
|
38
38
|
readonly at: "Location: line:N[:COLUMN], hash:HASH[:COLUMN], or symbol:NAME";
|
|
39
39
|
readonly end: "Last line to include";
|
|
40
40
|
readonly limit: "Maximum number of lines to include";
|
|
41
|
+
readonly digestDepth: "Maximum structural depth for map output; defaults to 1 in agent tools";
|
|
41
42
|
readonly offset: "One-based starting line";
|
|
42
43
|
readonly readLimit: "Maximum lines to return";
|
|
43
44
|
readonly symbolRead: "Symbol name to read";
|
|
@@ -87,7 +88,7 @@ export declare const PARAM_DESCRIPTIONS: {
|
|
|
87
88
|
readonly scopeContext: "Context lines within each symbol";
|
|
88
89
|
};
|
|
89
90
|
export declare const TOOL_DESCRIPTIONS: {
|
|
90
|
-
readonly digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use for structural
|
|
91
|
+
readonly digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use shallow maps for structural overviews, diagnostics for syntax checks, and identity for cursor context.";
|
|
91
92
|
readonly edit: "Edit existing text files with fresh `LINE:HASH` anchors. Read or search first when no fresh anchors are available. Each `edits[]` item must use exactly one nested object: `{\"set_line\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"replace_lines\":{\"start_anchor\":\"LINE:HASH\",\"end_anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"insert_after\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"replace_symbol\":{\"symbol\":\"name\",\"new_body\":\"...\"}}`, or `{\"replace\":{\"old_text\":\"...\",\"new_text\":\"...\"}}`.";
|
|
92
93
|
readonly write: "Create or replace a complete text file and return `LINE:HASH` anchors. Use `edit` for small changes to an existing file.";
|
|
93
94
|
readonly grep: "Search text or regex in files and return edit-ready `LINE:HASH` anchors. Use for identifiers, strings, configuration, errors, comments, and documentation.";
|
package/dist/index.d.ts
CHANGED
|
@@ -2,11 +2,11 @@ export { DIGEST_FACETS, DOCUMENT_NODE_KINDS, EDIT_VARIANTS, GIT_SELECTION_FLAGS,
|
|
|
2
2
|
export { BUILTIN_FALLBACKS, REPLACEABLE_TOOLS, TOOL_COMPACT_GUIDELINES, fallbackToolDescriptionMap, preferredToolDescriptionMap, renderCompactGuidelines, renderFallbackToolDescription, renderPreferredToolDescription, renderToolRoutingPolicy, resolveToolName, rewriteBacktickedToolNames, type ReplaceableTool, type ToolAliasMap, type ToolRoutingPolicyOptions, } from "./policy.ts";
|
|
3
3
|
export { coerceBoolean, coerceNonNegativeInt, coerceObviousBase10Int, coerceOptionalString, coercePositiveInt, validateExactlyOneEditVariant, validateGitSelection, validateRefsNameVsScope, validateVisionLevelVsMode, type CoercedIntResult, type EditItem, type EditObject, type GitSelectionInput, type InsertAfterEdit, type RefsScopeInput, type ReplaceEdit, type ReplaceLinesEdit, type ReplaceSymbolEdit, type SetLineEdit, type ValidationResult, type VisionInput, } from "./validation.ts";
|
|
4
4
|
export { HASH_LEN, parseLineAnchor, tryParseLineAnchor, type LineAnchor, } from "./hashline.ts";
|
|
5
|
-
export { appendApplyAndPlanHash, appendGitSelectionArgs, buildDefArgs, buildDigestArgs, buildEditArgs, buildLineLocation, buildRefsArgs, buildRenameArgs, buildSearchArgs, buildViewArgs, type ApplyPlanHashInput, type ApplyPlanHashOrder, type DefArgsInput, type DigestArgsInput, type EditArgsInput, type RefsArgsInput, type RenameArgsInput, type SearchArgsInput, type ViewArgsInput, } from "./argv.ts";
|
|
5
|
+
export { appendApplyAndPlanHash, appendGitSelectionArgs, buildDefArgs, buildDigestArgs, DEFAULT_DIGEST_MAP_DEPTH, buildEditArgs, buildLineLocation, buildRefsArgs, buildRenameArgs, buildSearchArgs, buildViewArgs, type ApplyPlanHashInput, type ApplyPlanHashOrder, type DefArgsInput, type DigestArgsInput, type EditArgsInput, type RefsArgsInput, type RenameArgsInput, type SearchArgsInput, type ViewArgsInput, } from "./argv.ts";
|
|
6
6
|
export { READSEEK_BINARY_ENV, READSEEK_PLATFORM_PACKAGES, readSeekBinaryName, readSeekPlatformKey, resolveReadSeekBinaryFromPackages, resolveReadSeekBinaryOverride, resolveReadSeekCacheDir, type ModuleResolver, type ReadSeekCacheOptions, } from "./platform.ts";
|
|
7
7
|
export { canonicalPathKey, expandUserPath, isSubPath, resolveScopedPath, resolveToCwd, } from "./path.ts";
|
|
8
8
|
export { cleanReadSeekErrorText, parseReadSeekJson, } from "./json.ts";
|
|
9
9
|
export { DEFAULT_MAX_OUTPUT_BYTES, DEFAULT_READSEEK_TIMEOUT_MS, ensureSuccessfulStdout, failureFromProcessResult, parseSuccessfulJson, resolveProcessLimits, type ProcessRunOptions, type ProcessRunResult, } from "./process.ts";
|
|
10
10
|
export { runReadSeekNode, runReadSeekNodeJson, runReadSeekNodeText, } from "./process-node.ts";
|
|
11
11
|
export { runReadSeekBun, runReadSeekBunJson, runReadSeekBunText, } from "./process-bun.ts";
|
|
12
|
-
export { classifyReadSeekFailure, createReadSeekClient, type DefLocation, type EditOutput, type IdentifierOutput, type IdentifyOutput, type ReadSeekCheckOutput, type ReadSeekClient, type ReadSeekDetection, type ReadSeekDetectedObject, type ReadSeekDiagnostic, type ReadSeekDigestOptions, type ReadSeekDigestOutput, type ReadSeekDocumentCache, type ReadSeekFailure, type ReadSeekHashline, type ReadSeekImageDetection, type ReadSeekImageMode, type ReadSeekMapOutput, type ReadSeekOcrText, type ReadSeekPreparedImage, type ReadSeekReadOutput, type ReadSeekReference, type ReadSeekRunOptions, type ReadSeekRunner, type RenameConflict, type RenameEdit, type RenameFileOutput, type RenameOutput, type ReadSeekSearchCapture, type ReadSeekSearchFileOutput, type ReadSeekSearchMatch, type ReadSeekSymbol, type ReadSeekViewOptions, } from "./client.ts";
|
|
12
|
+
export { classifyReadSeekFailure, createReadSeekClient, type DefLocation, type EditOutput, type IdentifierOutput, type IdentifyOutput, type ReadSeekCheckOutput, type ReadSeekClient, type ReadSeekDetection, type ReadSeekDetectedObject, type ReadSeekDiagnostic, type ReadSeekDigestOptions, type ReadSeekDigestOutput, type ReadSeekDocumentCache, type ReadSeekFailure, type ReadSeekHashline, type ReadSeekImageDetection, type ReadSeekImageMode, type ReadSeekMapOutput, type ReadSeekMapNode, type ReadSeekOcrText, type ReadSeekPreparedImage, type ReadSeekReadOutput, type ReadSeekReference, type ReadSeekRunOptions, type ReadSeekRunner, type RenameConflict, type RenameEdit, type RenameFileOutput, type RenameOutput, type ReadSeekSearchCapture, type ReadSeekSearchFileOutput, type ReadSeekSearchMatch, type ReadSeekSymbol, type ReadSeekViewOptions, } from "./client.ts";
|
package/dist/index.js
CHANGED
|
@@ -64,6 +64,7 @@ var PARAM_DESCRIPTIONS = {
|
|
|
64
64
|
at: "Location: line:N[:COLUMN], hash:HASH[:COLUMN], or symbol:NAME",
|
|
65
65
|
end: "Last line to include",
|
|
66
66
|
limit: "Maximum number of lines to include",
|
|
67
|
+
digestDepth: "Maximum structural depth for map output; defaults to 1 in agent tools",
|
|
67
68
|
offset: "One-based starting line",
|
|
68
69
|
readLimit: "Maximum lines to return",
|
|
69
70
|
symbolRead: "Symbol name to read",
|
|
@@ -113,7 +114,7 @@ var PARAM_DESCRIPTIONS = {
|
|
|
113
114
|
scopeContext: "Context lines within each symbol"
|
|
114
115
|
};
|
|
115
116
|
var TOOL_DESCRIPTIONS = {
|
|
116
|
-
digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use for structural
|
|
117
|
+
digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use shallow maps for structural overviews, diagnostics for syntax checks, and identity for cursor context.",
|
|
117
118
|
edit: 'Edit existing text files with fresh `LINE:HASH` anchors. Read or search first when no fresh anchors are available. Each `edits[]` item must use exactly one nested object: `{"set_line":{"anchor":"LINE:HASH","new_text":"..."}}`, `{"replace_lines":{"start_anchor":"LINE:HASH","end_anchor":"LINE:HASH","new_text":"..."}}`, `{"insert_after":{"anchor":"LINE:HASH","new_text":"..."}}`, `{"replace_symbol":{"symbol":"name","new_body":"..."}}`, or `{"replace":{"old_text":"...","new_text":"..."}}`.',
|
|
118
119
|
write: "Create or replace a complete text file and return `LINE:HASH` anchors. Use `edit` for small changes to an existing file.",
|
|
119
120
|
grep: "Search text or regex in files and return edit-ready `LINE:HASH` anchors. Use for identifiers, strings, configuration, errors, comments, and documentation.",
|
|
@@ -217,6 +218,7 @@ var TOOL_CONTRACTS = [
|
|
|
217
218
|
at: { type: "string", description: PARAM_DESCRIPTIONS.at },
|
|
218
219
|
end: { type: "integer", minimum: 1, description: PARAM_DESCRIPTIONS.end },
|
|
219
220
|
limit: { type: "integer", minimum: 1, description: PARAM_DESCRIPTIONS.limit },
|
|
221
|
+
depth: { type: "integer", minimum: 0, description: PARAM_DESCRIPTIONS.digestDepth },
|
|
220
222
|
language: { type: "string", description: PARAM_DESCRIPTIONS.languageOverride },
|
|
221
223
|
visionMode: {
|
|
222
224
|
type: "string",
|
|
@@ -433,7 +435,7 @@ var REPLACEABLE_TOOLS = [
|
|
|
433
435
|
];
|
|
434
436
|
var TOOL_COMPACT_GUIDELINES = {
|
|
435
437
|
digest: [
|
|
436
|
-
"Use `digest` for
|
|
438
|
+
"Use `digest` for shallow maps, diagnostics, and identity; use `def`, `refs`, or `search` for targeted symbol questions."
|
|
437
439
|
],
|
|
438
440
|
edit: [
|
|
439
441
|
"Prefer set_line, replace_lines, and insert_after; use replace only when anchors are impractical."
|
|
@@ -508,7 +510,7 @@ function renderToolRoutingPolicy(options = {}) {
|
|
|
508
510
|
if (options.style === "server") {
|
|
509
511
|
return [
|
|
510
512
|
"Structural code navigation, document viewing, and hash-verified edits with readseek.",
|
|
511
|
-
"For structural questions, prefer these tools to text Grep/Bash: definitions, references, AST search
|
|
513
|
+
"For structural questions, prefer these tools to text Grep/Bash: targeted definitions, references, and AST search; shallow digest maps; diagnostics and identity; and document views.",
|
|
512
514
|
`Use ${edit} for LINE:HASH-anchored mutations (preview with apply=false; apply defaults to true and re-checks plan_hash).`,
|
|
513
515
|
"Paths resolve against CLAUDE_PROJECT_DIR. Native Read/Grep/Edit hooks provide passive context;",
|
|
514
516
|
"call MCP tools for active navigation, document questions, or anchored edits."
|
|
@@ -519,7 +521,7 @@ function renderToolRoutingPolicy(options = {}) {
|
|
|
519
521
|
if (options.preferOverBuiltIns) {
|
|
520
522
|
bullets.push("- Prefer ReadSeek tools over built-ins when they can do the job.");
|
|
521
523
|
}
|
|
522
|
-
bullets.push(`- Read with ${digest} first; ${edit} needs fresh LINE:HASH anchors.`, `- Use ${grep} for text/regex, ${search} for AST patterns,
|
|
524
|
+
bullets.push(`- Read with ${digest} first; ${edit} needs fresh LINE:HASH anchors.`, `- Use ${grep} for text/regex, ${search} for AST patterns, ${def}/${refs} for targeted symbols, and shallow ${digest} maps only for file overviews.`, `- Use ${edit} for existing files, ${write} for whole-file creation or replacement, and ${rename} for symbol renames.`, `- Use ${view} for document structure; run ${digest} with select diagnostics after source edits for a quick syntax check.`);
|
|
523
525
|
if (options.demoteBuiltIns && options.demoteBuiltIns.length > 0) {
|
|
524
526
|
bullets.push(`- Do not use built-in ${options.demoteBuiltIns.join(", ")} when a ReadSeek tool can do the job.`);
|
|
525
527
|
}
|
|
@@ -715,6 +717,7 @@ function coerceNonNegativeInt(value) {
|
|
|
715
717
|
return;
|
|
716
718
|
}
|
|
717
719
|
// src/argv.ts
|
|
720
|
+
var DEFAULT_DIGEST_MAP_DEPTH = 1;
|
|
718
721
|
function buildLineLocation(line, column) {
|
|
719
722
|
return column === undefined ? `line:${line}` : `line:${line}:${column}`;
|
|
720
723
|
}
|
|
@@ -757,6 +760,10 @@ function selectArg(select) {
|
|
|
757
760
|
return;
|
|
758
761
|
return Array.isArray(select) ? select.join(",") : select;
|
|
759
762
|
}
|
|
763
|
+
function selectsDigestMap(select) {
|
|
764
|
+
const value = selectArg(select);
|
|
765
|
+
return value?.split(",").some((facet) => facet.trim() === "map") ?? false;
|
|
766
|
+
}
|
|
760
767
|
function buildDigestArgs(input) {
|
|
761
768
|
const vision = validateVisionLevelVsMode({
|
|
762
769
|
visionMode: input.visionMode,
|
|
@@ -764,6 +771,14 @@ function buildDigestArgs(input) {
|
|
|
764
771
|
});
|
|
765
772
|
if (!vision.ok)
|
|
766
773
|
throw new Error(vision.error);
|
|
774
|
+
const selectsMap = selectsDigestMap(input.select);
|
|
775
|
+
if (input.depth !== undefined) {
|
|
776
|
+
if (!Number.isInteger(input.depth) || input.depth < 0) {
|
|
777
|
+
throw new Error("depth must be a non-negative integer");
|
|
778
|
+
}
|
|
779
|
+
if (!selectsMap)
|
|
780
|
+
throw new Error("depth requires the map facet");
|
|
781
|
+
}
|
|
767
782
|
const args = [];
|
|
768
783
|
if (input.readseekDir !== undefined)
|
|
769
784
|
args.push("--readseek-dir", input.readseekDir);
|
|
@@ -774,6 +789,7 @@ function buildDigestArgs(input) {
|
|
|
774
789
|
pushOptionalString(args, "--at", input.at);
|
|
775
790
|
pushOptionalNumber(args, "--end", input.end);
|
|
776
791
|
pushOptionalNumber(args, "--limit", input.limit);
|
|
792
|
+
pushOptionalNumber(args, "--depth", input.depth);
|
|
777
793
|
pushOptionalString(args, "--language", input.language);
|
|
778
794
|
pushOptionalString(args, "--vision-mode", input.visionMode);
|
|
779
795
|
pushOptionalString(args, "--vision-level", input.visionLevel);
|
|
@@ -906,9 +922,9 @@ function resolveReadSeekBinaryFromPackages(resolver = resolveFromPackage, option
|
|
|
906
922
|
const platformPackage = READSEEK_PLATFORM_PACKAGES[key];
|
|
907
923
|
if (!platformPackage) {
|
|
908
924
|
const supported = Object.keys(READSEEK_PLATFORM_PACKAGES).join(", ");
|
|
909
|
-
throw new Error(`@jarkkojs/readseek ships no binary for ${key}; it supports ${supported}`);
|
|
925
|
+
throw new Error(`@jarkkojs/readseek-api ships no binary for ${key}; it supports ${supported}`);
|
|
910
926
|
}
|
|
911
|
-
const metaPackage = options.metaPackage ?? "@jarkkojs/readseek";
|
|
927
|
+
const metaPackage = options.metaPackage ?? "@jarkkojs/readseek-api";
|
|
912
928
|
const metaPackageJson = resolve(`${metaPackage}/package.json`);
|
|
913
929
|
const metaPackageDir = path.dirname(metaPackageJson);
|
|
914
930
|
let packageJsonPath;
|
|
@@ -1298,6 +1314,22 @@ function parseReadOutput(value) {
|
|
|
1298
1314
|
hashlines: hashlines.map((line) => parseHashline(line, "hashline"))
|
|
1299
1315
|
};
|
|
1300
1316
|
}
|
|
1317
|
+
function parseMapNode(value) {
|
|
1318
|
+
if (!value || typeof value !== "object")
|
|
1319
|
+
throw new Error("invalid readseek map node");
|
|
1320
|
+
const node = value;
|
|
1321
|
+
if (!Array.isArray(node.children))
|
|
1322
|
+
throw new Error("invalid readseek map node children");
|
|
1323
|
+
return {
|
|
1324
|
+
kind: requireString(node.kind, "map node.kind"),
|
|
1325
|
+
name: requireString(node.name, "map node.name"),
|
|
1326
|
+
start_line: requireNumber(node.start_line, "map node.start_line"),
|
|
1327
|
+
end_line: requireNumber(node.end_line, "map node.end_line"),
|
|
1328
|
+
start_anchor: requireString(node.start_anchor, "map node.start_anchor"),
|
|
1329
|
+
end_anchor: requireString(node.end_anchor, "map node.end_anchor"),
|
|
1330
|
+
children: node.children.map(parseMapNode)
|
|
1331
|
+
};
|
|
1332
|
+
}
|
|
1301
1333
|
function parseMapOutput(value) {
|
|
1302
1334
|
if (!value || typeof value !== "object")
|
|
1303
1335
|
throw new Error("invalid readseek map output");
|
|
@@ -1310,6 +1342,7 @@ function parseMapOutput(value) {
|
|
|
1310
1342
|
language: requireString(output.language, "language"),
|
|
1311
1343
|
line_count: requireNumber(output.line_count, "line_count"),
|
|
1312
1344
|
file_hash: requireString(output.file_hash, "file_hash"),
|
|
1345
|
+
root: parseMapNode(output.root),
|
|
1313
1346
|
symbols: symbols.map((symbol) => {
|
|
1314
1347
|
if (!symbol || typeof symbol !== "object")
|
|
1315
1348
|
throw new Error("invalid readseek symbol");
|
|
@@ -1701,6 +1734,7 @@ function createReadSeekClient(runner) {
|
|
|
1701
1734
|
at: options.at,
|
|
1702
1735
|
end: options.end,
|
|
1703
1736
|
limit: options.limit,
|
|
1737
|
+
depth: options.depth,
|
|
1704
1738
|
language: options.language,
|
|
1705
1739
|
visionMode: options.visionMode,
|
|
1706
1740
|
visionLevel: options.visionLevel,
|
|
@@ -1979,5 +2013,6 @@ export {
|
|
|
1979
2013
|
DIGEST_FACETS,
|
|
1980
2014
|
DEFAULT_READSEEK_TIMEOUT_MS,
|
|
1981
2015
|
DEFAULT_MAX_OUTPUT_BYTES,
|
|
2016
|
+
DEFAULT_DIGEST_MAP_DEPTH,
|
|
1982
2017
|
BUILTIN_FALLBACKS
|
|
1983
2018
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jarkkojs/readseek-api",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.16",
|
|
4
4
|
"description": "Shared ReadSeek CLI contract, validation, argv builders, and bounded process runners",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -13,14 +13,19 @@
|
|
|
13
13
|
"bugs": {
|
|
14
14
|
"url": "https://gitlab.com/jarkkojs/readseek/-/issues"
|
|
15
15
|
},
|
|
16
|
+
"bin": {
|
|
17
|
+
"readseek": "bin/readseek.cjs"
|
|
18
|
+
},
|
|
16
19
|
"exports": {
|
|
17
20
|
".": {
|
|
18
21
|
"types": "./dist/index.d.ts",
|
|
19
22
|
"import": "./dist/index.js",
|
|
20
23
|
"default": "./dist/index.js"
|
|
21
|
-
}
|
|
24
|
+
},
|
|
25
|
+
"./package.json": "./package.json"
|
|
22
26
|
},
|
|
23
27
|
"files": [
|
|
28
|
+
"bin/",
|
|
24
29
|
"dist/",
|
|
25
30
|
"README.md"
|
|
26
31
|
],
|
|
@@ -43,8 +48,11 @@
|
|
|
43
48
|
"ast-grep",
|
|
44
49
|
"hashline"
|
|
45
50
|
],
|
|
46
|
-
"
|
|
47
|
-
"@jarkkojs/readseek": "
|
|
51
|
+
"optionalDependencies": {
|
|
52
|
+
"@jarkkojs/readseek-darwin-arm64": "0.9.16",
|
|
53
|
+
"@jarkkojs/readseek-linux-arm64": "0.9.16",
|
|
54
|
+
"@jarkkojs/readseek-linux-x64": "0.9.16",
|
|
55
|
+
"@jarkkojs/readseek-win32-x64": "0.9.16"
|
|
48
56
|
},
|
|
49
57
|
"devDependencies": {
|
|
50
58
|
"@types/node": "^22.0.0",
|