@tduyng/pi-outline 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,178 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+Use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 tduyng

package/README.md

@@ -1,3 +1,23 @@
-# Temporary Holding Version
+# @tduyng/pi-outline
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Declarations of a source file with the line span of each, so a read fetches one body by offset and limit instead of the whole file.
+
+## The tool
+
+`outline` takes a `path` and an optional `depth` (0 to 5, default 1). It prints one row per declaration: the span, then the declaration line. Members sit under their class or impl, one indent per level. A row whose declaration has children beyond `depth` ends in `[N nested]`.
+
+Covered: TypeScript and JavaScript (functions, classes, interfaces, type aliases, enums, and class methods), Python (`def` and `class`), Go (`func` and `type`), Rust (`fn`, `struct`, `enum`, `trait`, `impl`, `mod`), and Markdown headings. Headings inside code fences are ignored.
+
+## Why it is cheap
+
+A big read is blocked by pi-subagent's bulk-read guard, and the block message now names `outline` first. On pi-goal's `goal.ts` (1,213 lines, 51KB) the depth-1 outline is 47 rows, 3.4KB. A whole read would put all 51KB into context and re-bill it on every later turn.
+
+## Limits
+
+No parser is used, so the rules are regular expressions over single lines. Spans come from indentation: a span runs to the next line at the same or a lower indent, and includes the closing brace that follows the body. Expect an occasional missed declaration on unusual formatting, and an object-literal method may show as a member. A file the rules do not cover gets a line saying so, with grep or a ranged read as the fallback.
+
+Files over 2MB are refused.
+
+## Install
+
+Local checkout, as part of this dotfiles package: the root `package.json` lists `./extensions/pi-outline/src/outline.ts`.

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@tduyng/pi-outline",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Declarations of a source file with line spans, so a read fetches one body instead of the whole file.",
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-coding-agent",
+    "outline",
+    "read",
+    "tokens"
+  ],
+  "license": "Apache-2.0",
+  "author": "tduyng",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./src/outline.ts"
+    ]
+  },
+  "dependencies": {
+    "ata-validator": "^1.62.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/tduyng/pi-agent.git",
+    "directory": "extensions/pi-outline"
+  },
+  "homepage": "https://gitlab.com/tduyng/pi-agent/-/tree/main/extensions/pi-outline#readme",
+  "bugs": "https://gitlab.com/tduyng/pi-agent/-/issues"
+}

package/src/declarations.ts

@@ -0,0 +1,142 @@
+import { extname } from 'node:path'
+
+export type Language = 'js/ts' | 'python' | 'go' | 'rust' | 'markdown'
+
+export interface Declaration {
+    line: number
+    end: number
+    level: number
+    text: string
+}
+
+const BY_EXTENSION = {
+    '.ts': 'js/ts',
+    '.tsx': 'js/ts',
+    '.mts': 'js/ts',
+    '.cts': 'js/ts',
+    '.js': 'js/ts',
+    '.jsx': 'js/ts',
+    '.mjs': 'js/ts',
+    '.cjs': 'js/ts',
+    '.py': 'python',
+    '.go': 'go',
+    '.rs': 'rust',
+    '.md': 'markdown',
+    '.markdown': 'markdown'
+} as const satisfies Record<string, Language>
+
+type KnownExtension = keyof typeof BY_EXTENSION
+
+const PATTERNS = {
+    'js/ts': [
+        /^(?:export\s+)?(?:default\s+)?(?:declare\s+)?(?:abstract\s+)?(?:async\s+)?(?:function\b|class\b|interface\b|enum\b|namespace\b|type\s+\w+(?:<[^>]*>)?\s*=)/,
+        /^(?:export\s+)?(?:const|let|var)\s+\w+\s*(?::[^=]+)?=\s*(?:async\s*)?(?:\([^)]*\)|\w+)\s*(?::[^=]+)?=>/,
+        /^\s+(?:(?:public|private|protected|static|readonly|override|async|get|set)\s+)*\*?(?!(?:if|for|while|switch|catch|with)\b)\w+\s*\([^)]*\)\s*(?::[^{;]+)?\{\s*$/
+    ],
+    python: [/^\s*(?:async\s+)?(?:def|class)\s+\w+/],
+    go: [/^(?:func|type)\s+/],
+    rust: [
+        /^\s*(?:pub(?:\([^)]*\))?\s+)?(?:default\s+)?(?:const\s+)?(?:async\s+)?(?:unsafe\s+)?(?:extern\s+"[^"]*"\s+)?(?:fn|struct|enum|trait|impl|mod)\b/
+    ]
+} as const satisfies Record<Exclude<Language, 'markdown'>, readonly RegExp[]>
+
+const HEADING = /^(#{1,6})\s+\S/
+const FENCE = /^\s*(?:```|~~~)/
+const CLOSER = /^\s*[)\]}]/
+const MAX_ROW_TEXT = 120
+
+function isKnownExtension(extension: string): extension is KnownExtension {
+    return Object.hasOwn(BY_EXTENSION, extension)
+}
+
+export function languageOf(path: string): Language | undefined {
+    const extension = extname(path).toLowerCase()
+    return isKnownExtension(extension) ? BY_EXTENSION[extension] : undefined
+}
+
+interface Mark {
+    blank: boolean
+    measure: number
+    declares: boolean
+    boundary: boolean
+}
+
+function markLines(lines: string[], language: Language): Mark[] {
+    let inFence = false
+    return lines.map((line) => {
+        const blank = line.trim() === ''
+        if (language === 'markdown') {
+            if (FENCE.test(line)) {
+                inFence = !inFence
+                return { blank, measure: 0, declares: false, boundary: false }
+            }
+            const heading = inFence ? null : HEADING.exec(line)
+            const level = heading ? heading[1]!.length : 0
+            return { blank, measure: level, declares: heading !== null, boundary: heading !== null }
+        }
+        const measure = /^[ \t]*/.exec(line)![0].length
+        const declares = PATTERNS[language].some((pattern) => pattern.test(line))
+        return { blank, measure, declares, boundary: !blank && !CLOSER.test(line) }
+    })
+}
+
+export function findDeclarations(text: string, language: Language): Declaration[] {
+    const lines = text.replace(/\r\n?/g, '\n').split('\n')
+    const marks = markLines(lines, language)
+    const found: Declaration[] = []
+    const stack: { end: number }[] = []
+
+    for (let line = 0; line < lines.length; line++) {
+        const mark = marks[line]!
+        if (!mark.declares) continue
+        let end = line
+        for (let next = line + 1; next < lines.length; next++) {
+            const after = marks[next]!
+            if (after.blank) continue
+            if (after.boundary && after.measure <= mark.measure) break
+            end = next
+        }
+        while (stack.length > 0 && stack[stack.length - 1]!.end < line) stack.pop()
+        found.push({ line, end, level: stack.length, text: lines[line]!.trim().slice(0, MAX_ROW_TEXT) })
+        stack.push({ end })
+    }
+    return found
+}
+
+export const MAX_ROWS = 200
+
+export function renderOutline(
+    path: string,
+    language: Language,
+    lineCount: number,
+    declarations: Declaration[],
+    depth: number
+): string {
+    const header = `=== ${path} (${language}): ${lineCount} lines ===`
+    if (declarations.length === 0) {
+        return `${header}\nNo declarations found. Read the file with offset and limit, or grep for a name.`
+    }
+
+    const rows: { declaration: Declaration; nested: number }[] = []
+    let parent: { declaration: Declaration; nested: number } | undefined
+    for (const declaration of declarations) {
+        if (declaration.level <= depth) {
+            parent = { declaration, nested: 0 }
+            rows.push(parent)
+        } else if (parent) {
+            parent.nested += 1
+        }
+    }
+
+    const lines = rows.slice(0, MAX_ROWS).map(({ declaration, nested }) => {
+        const span = `${declaration.line + 1}-${declaration.end + 1}`
+        const hidden = nested > 0 ? ` [${nested} nested]` : ''
+        return `${span}  ${'  '.repeat(declaration.level)}${declaration.text}${hidden}`
+    })
+    const more =
+        rows.length > MAX_ROWS
+            ? [`[${rows.length - MAX_ROWS} more rows. Lower depth to 0 for top-level only, or read a span.]`]
+            : []
+    const footer = 'Spans are estimated from indentation. Read one with offset=<start> limit=<length>.'
+    return [header, ...lines, ...more, footer].join('\n')
+}

package/src/outline.ts

@@ -0,0 +1,50 @@
+import { readFileSync, statSync } from 'node:fs'
+import { isAbsolute, resolve } from 'node:path'
+import type { ExtensionAPI, ToolDefinition } from '@earendil-works/pi-coding-agent'
+import type { Infer } from 'ata-validator'
+import { t } from 'ata-validator/t'
+import { findDeclarations, languageOf, renderOutline } from './declarations.js'
+
+const MAX_BYTES = 2_000_000
+
+const parameters = t.object({
+    path: t.string({ description: 'File path, relative to the working directory or absolute.' }),
+    depth: t.optional(
+        t.integer({
+            minimum: 0,
+            maximum: 5,
+            description: '0 lists top-level declarations, 1 adds their members. Default 1.'
+        })
+    )
+})
+
+export const outlineTool = {
+    name: 'outline',
+    label: 'Outline',
+    description:
+        'Declarations of a source file with the line span of each, so read can fetch one body by offset and limit. Covers TypeScript and JavaScript, Python, Go, Rust, and Markdown headings. Spans are estimates from indentation.',
+    promptSnippet: 'Outline a source file: declarations with line spans, before reading it whole',
+    annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false },
+    parameters,
+    async execute(_toolCallId, params: Infer<typeof parameters>, _signal, _onUpdate, ctx) {
+        const absolute = isAbsolute(params.path) ? params.path : resolve(ctx.cwd, params.path)
+        const language = languageOf(absolute)
+        if (language === undefined) {
+            const text = `No outline for ${params.path}: no declaration rules for this file type. Use grep, or read with offset and limit.`
+            return { content: [{ type: 'text', text }], details: undefined }
+        }
+        if (statSync(absolute).size > MAX_BYTES) {
+            const text = `${params.path} is over 2MB. Use grep for a name, or read with offset and limit.`
+            return { content: [{ type: 'text', text }], details: undefined }
+        }
+        const content = readFileSync(absolute, 'utf8')
+        const declarations = findDeclarations(content, language)
+        const lineCount = content.split('\n').length
+        const text = renderOutline(params.path, language, lineCount, declarations, params.depth ?? 1)
+        return { content: [{ type: 'text', text }], details: undefined }
+    }
+} satisfies ToolDefinition<typeof parameters>
+
+export default function outlineExtension(pi: ExtensionAPI): void {
+    pi.registerTool(outlineTool)
+}