Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include signatures by default in repo map context provider #3722

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Include signatures by default in repo map context provider #3722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbbcfe0
include signatures by default in repo map context provider
RomneyDa Jan 14, 2025
4034e06
repo map context provider include signatures:
RomneyDa Jan 14, 2025
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 core/context/providers/RepoMapContextProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class RepoMapContextProvider extends BaseContextProvider {
// Doesn't ALWAYS depend on indexing, so not setting dependsOnIndexing = true, just checking for it
includeSignatures: extras.config.disableIndexing
? false
: (this.options?.includeSignatures ?? false),
: (this.options?.includeSignatures ?? true),
}),
},
];
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/customize/context-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,17 +261,17 @@ Uses the top _n_ levels (defaulting to 3) of the call stack for that thread.

### `@Repository Map`

Reference the outline of your codebase.
Reference the outline of your codebase. By default, signatures are included along with file in the repo map.

`includeSignatures` params can be used to include signatures for all files in the repo. Use with caution as will increase context size significantly. `includeSignatures` will not work if indexing is disabled.
`includeSignatures` params can be set to false to exclude signatures. This could be necessary for large codebases and/or to reduce context size significantly. Signatures will not be included if indexing is disabled.

```json title="config.json"
{
"contextProviders": [
{
"name": "repo-map",
"params": {
"includeSignatures": false
"includeSignatures": false // default true
}
}
]
Expand Down
Loading