mirror of
https://github.com/go-gitea/gitea.git
synced 2026-11-19 15:14:40 +09:00
Adds GitHub-style code search endpoints and makes code search behave the
same in the web UI and the API, whether it runs on git grep, bleve or
Elasticsearch.
- `GET /repos/{owner}/{repo}/code/search` searches any branch, tag or
commit with git grep, so it works without the code indexer.
- `GET /search/code` searches the default branches of all accessible
repositories with the code indexer.
- One query syntax everywhere: every term must match a file's content or
path, case-insensitively. It supports `"phrases"`, `/regexp/` (git grep
only) and the `path:`, `language:`, `repo:`, `user:` and `org:`
qualifiers. Invalid queries return an error.
- All engines apply the same include, exclude, vendored and size rules,
and return every match. The web UI shows them as multiple snippets per
file with the matched text highlighted.
<img width="359" height="295" alt="image"
src="https://github.com/user-attachments/assets/59b7aa66-b1dc-4938-9ef9-66668ae08d7c"
/>
Fixes: https://github.com/go-gitea/gitea/issues/10706
Fixed: https://github.com/go-gitea/gitea/issues/15841
Fixes: https://github.com/go-gitea/gitea/issues/31375
Related: https://gitea.com/gitea/gitea-mcp/issues/280
Docs: https://gitea.com/gitea/docs/pulls/615
AI usage disclosure: Yes, I used AI to write code, review changes and
verify the factuality of the overview I provided. I take full
responsibility for the code in this PR.
---------
Co-authored-by: silverwind <me@silverwind.io>
43 lines
1.4 KiB
Go
43 lines
1.4 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package structs
|
|
|
|
// CodeSearchResults contains matching files.
|
|
type CodeSearchResults struct {
|
|
TotalCount int64 `json:"total_count"`
|
|
// Search stopped early
|
|
IncompleteResults bool `json:"incomplete_results"`
|
|
Items []*CodeSearchResultItem `json:"items"`
|
|
}
|
|
|
|
// CodeSearchResultItem is a matching file.
|
|
type CodeSearchResultItem struct {
|
|
Name string `json:"name"`
|
|
Path string `json:"path"`
|
|
// Contents API URL at the searched commit
|
|
URL string `json:"url"`
|
|
// File URL at the searched commit
|
|
HTMLURL string `json:"html_url"`
|
|
// Programming language (Gitea extension)
|
|
Language string `json:"language,omitempty"`
|
|
Repository *Repository `json:"repository"`
|
|
TextMatches []*CodeSearchTextMatch `json:"text_matches"`
|
|
}
|
|
|
|
// CodeSearchTextMatch is a matching fragment.
|
|
type CodeSearchTextMatch struct {
|
|
ObjectURL string `json:"object_url"`
|
|
ObjectType string `json:"object_type"`
|
|
Property string `json:"property"`
|
|
Fragment string `json:"fragment"`
|
|
Matches []*CodeSearchTextMatchTerm `json:"matches"`
|
|
}
|
|
|
|
// CodeSearchTextMatchTerm is a matched term.
|
|
type CodeSearchTextMatchTerm struct {
|
|
Text string `json:"text"`
|
|
// Start and end UTF-8 byte offsets in the fragment, end-exclusive
|
|
Indices []int `json:"indices"`
|
|
}
|