getappmap / getappmap/appmap-js

If a user mentions a file by name, try to send the whole text with the context (if feasible)

Open
#1,775 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
53
Forks
18
Avg merge
3d 18h
Merged PRs (30d)
8

Description

Sometimes a user has a specific file in mind with the query that they want to edit or analyze. For example, I tried this query:

@generate
Recently a user had a problem running appmap-node: they had a script in package.json that read "npm run generate-types & npm run server"; they edited it, inteding to run the server with appmap-node, to "appmap-node npm run generate-types & npm run server". However, this had the effect of only running the generate-types script instrumented, with requests to the server consequently not getting recorded.
Propose changes to the appmap-node.md file that will help users avoid this mistake.

It turns out that in the context, Navie only got bits and pieces of the file in question. The answer wasn't bad, but I can't help but feel it could have been much better if it could see the whole thing. Obviously this won't always be feasible: it might not fit in the context window. However when the user explicitly calls out a file, I feel it should be prioritized to transfer that.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the appmap-node.md example and tracing the Navie context-gathering entry point for explicitly named files. The work is done when a named file is prioritized for inclusion when feasible, while respecting the context window; the issue does not name a test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
ai, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.