Allow to code search with text_matches where return full fragment length

[md-robiul-hassan-kr]

Select Topic Area

Question

Body

(async () => {
  const response = await octokit.request('GET /search/code?q={q}&type={type}', {
    q: `class="jquery"`,
    type: 'Code',
    headers: {
      'Accept': 'application/vnd.github.text-match+json'
    },
    per_page: 100
  }).then(res => res.data.items.map(r => r.text_matches));
  console.log('----------: ', response);
})();

in the return

 {
      object_url: '',
      object_type: 'FileContent',
      property: 'content',
      fragment: ' ',
      matches: [Array]
}

In this code example, assume I have a div block as below,

<div class="jquery">
  <p>this is </p>
  <p>this is </p>
  <p>this is </p>
  <p>this is </p>
  <p>this is </p>
  <p>this is </p>
</div>

and when I search I want to be able to return the full block of the code in the fragment where today we are getting only 3 line of code within the matching I believe.

[b8zeek]

First of all, format the text properly if you expect to get help, that is the least you can do!

Your call:

;(async () => {
    const response = await octokit
        .request('GET /search/code?q={q}&type={type}', {
            q: 'jquery',
            type: 'Code',
            headers: {
                Accept: 'application/vnd.github.text-match+json'
            },
            per_page: 100
        })
        .then(res => res.data.items.map(r => r.text_matches))
    console.log('----------: ', response)
})()

Your response:

{
  object_url: '',
  object_type: 'FileContent',
  property: 'content',
  fragment: ' ',
  matches: [Array]
}

I don't think there is a way to configure the API to return the entire block of code in the fragment. The size of the text returned is determined by the API and I do not think you can't change it. If you want the whole content of the file, there's a call to get a file, take a look at REST API documentation: GET /repos/{owner}/{repo}/contents/{path}. This returns Base64 encoded string, you just need to decode it.

Definitely take a look at the documentation, this is what you need:

https://docs.github.com/en/rest/repos/contents

Let me know if you need help with that. Good luck. 🍺

🍀

[md-robiul-hassan-kr]

so in this case, how github search return 9 more matches, in our fragment on api, we are only receiving first match of the code, but not entire code which we can see when we expand the see more match? any idea how we can get that full match from using the github api?

[b8zeek]

Hey, there are some limitations in the search API; it returns only the first match of the code in the text matches array which can contain up to five fragments. Unfortunately, you can't have all the matches.

Sorry.

🍀

[md-robiul-hassan-kr]

Thanks a lot for taking time for answering. One last question, do you know if there is any plan in the future to add this support or any work around? I have noticed that somehow SourceGraph is able to send all the matches but not sure if they are using a different api. Thanks

[b8zeek]

Hey, I do not know of a plan for supporting this soon. Sorry.

🍀

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬