☂️ Improved zero-config code navigation

[varungandhi-src]

RFC

Summary

Improve the zero-config code navigation experience compared to today's search-based code intel.

Sub-projects

• https://github.com/sourcegraph/sourcegraph/issues/58726

  • Status (Feb 2 2024): COMPLETED

• https://github.com/sourcegraph/sourcegraph/issues/58182 (RFC)

  • Status (Feb 2 2024): PAUSED because of on-going re-organization in the client code (SvelteKit rewrite). The SvelteKit version of the app doesn't have the reference panel yet, and it doesn't make sense to implement this feature in the old reference panel if that will be replaced soon.

• https://github.com/sourcegraph/sourcegraph/issues/58727

  • Status (Feb 2 2024): Out of 3 sub-tasks, we've completed two.

    • Introduce a CLI for generating syntactic SCIP indexes
    • Scope out the backend work needed for batch indexing

    One sub-task that wasn't completed was creating a new worker for batch indexing. We have added a stub worker process, but it is not wired in anywhere. This is because it's actually much more work than we originally estimated. However, the progress so far is an incremental step towards our goals for the next quarter.

• Measuring quality

  • Static: https://github.com/sourcegraph/sourcegraph/issues/58730
  • Status (Feb 2 2024): IN PROGRESS AND ON TRACK to be completed by Feb 15. This has a bit more flexibility in that it shouldn't be affected by feature freeze (since it's an internal tool).
  • Dynamic: https://github.com/sourcegraph/sourcegraph/issues/58729
  • Status (Feb 2 2024): PAUSED We have not been able to make significant progress on this due to complexity and tech debt in the client-side code, lack of familiarity with the code, on-going re-organization (SvelteKit rewrite), and the number of incoming customer issues.

[github-actions[bot]]

Hey, @sourcegraph/code-search - Batch Changes has been mentioned. Let's take a look.

[ErikaRS]

Would it make sense to also have sub-projects for the specific languages and functionality we want to support?

[varungandhi-src]

Test plan for Feb 15 2024:

• For the improved locals and parameters navigation:
  • Code navigation for parameters and locals should return the correct results when coming from the new code paths, especially in cases involving shadowing and similar name reuse. (languages: Java, Go, MATLAB)
  • Find references for symbols potentially accessible in other files will avoid incorrectly only returning results within the same file. Conversely, Go to definition will avoid incorrectly jumping to a similarly named entity in the same file when the reference could potentially be for a symbol that may have been defined in another file. (languages: Java, Go, MATLAB, Perl)
  • The reference panel should show up correctly for MATLAB

There are no other customer facing changes.