sourcegraph/client
Peter Guy 72c00d397a
fix(search): VSCode Search extension: bring back matched lines in search results. (#63524)
Due to changes in the code base, the search extension code when run from
`main` shows file names only in the search results page - no matches in
the files. This is a regression from the behavior in the deployed
extension.

Deployed extension:
<img width="1504" alt="Screenshot 2024-06-27 at 10 04 37"
src="https://github.com/sourcegraph/sourcegraph/assets/129280/edd97903-d03f-4612-98c8-c8f286f0cb3b">

Running from `main`:
<img width="1502" alt="Screenshot 2024-06-27 at 10 11 17"
src="https://github.com/sourcegraph/sourcegraph/assets/129280/d7aefcfe-3a25-4486-9fa6-a5e6bc7c6a8e">

Turns out the reason is because some shared code expects chunk matches,
while the search queries were all returning line matches.

Added support for line matches in the shared code, and then fixed an
issue with the search results display not keeping up with `MatchGroups`.

## Test plan
Build and run locally.

### Build
```
git switch peterguy/vscode-bring-back-matched-lines-in-search-results
cd client/vscode
pnpm run build
```
### Run
- Launch extension in VSCode: open the `Run and Debug` sidebar view in
VS Code, then select `Launch VS Code Extension` from the dropdown menu.
- Run a search using the search bar.
- See that the results contain matched lines in the files and not just a
list of file names. Compare to the currently-deployed extension - the
search results should look generally the same.
2024-06-27 13:24:51 -06:00
..
branded fix(search): VSCode Search extension: bring back matched lines in search results. (#63524) 2024-06-27 13:24:51 -06:00
browser chore(ci): remove Percy visual tests (#63515) 2024-06-27 16:20:06 +02:00
build-config [React]: Add initial usage of the new web worker-based cody web chat (#62792) 2024-06-26 12:13:29 -03:00
client-api v2t: add v2 telemetry to the client/shared folder (#62586) 2024-06-03 16:34:28 -07:00
codeintellify Migrate deprecated rxjs functions/methods (#61222) 2024-04-08 11:23:34 +02:00
cody-context-filters-test-dataset Create a shared Cody Ignore dataset (#61968) 2024-05-09 13:18:35 +00:00
cody-shared Rename smartContext to smartContextWindow (#62948) 2024-05-28 10:00:34 -07:00
cody-ui Cody web: Bring back old packages from git history (#61376) 2024-04-08 14:21:41 +02:00
common chore: Bump go-enry and Zoekt to handle new languages (#63281) 2024-06-20 22:19:39 +08:00
eslint-plugin-wildcard chore: upgrade to Aspect CLI 5.8.5 (#57961) 2023-10-30 17:01:58 +02:00
extension-api Docs: update links to point to new site (#60381) 2024-02-13 00:23:47 +00:00
extension-api-types use @typescript-eslint projectService for faster eslint (#57851) 2023-10-24 01:40:40 +00:00
http-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
jetbrains looser eslint rules (#63511) 2024-06-27 08:42:51 +00:00
observability-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
observability-server reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
shared chore(ci): remove Percy visual tests (#63515) 2024-06-27 16:20:06 +02:00
storybook fix: update links for dev docs (#62758) 2024-05-17 13:47:34 +02:00
template-parser reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
testing chore(bazel): enable rules_esbuild sandbox with object-inspect workaround (#61969) 2024-06-05 15:34:29 +01:00
vscode fix(search): VSCode Search extension: bring back matched lines in search results. (#63524) 2024-06-27 13:24:51 -06:00
web saved searches: use default pattern type (#63487) 2024-06-27 16:24:49 +02:00
web-sveltekit remove Cody "upsells"—and all Cody links if Cody is disabled (#63430) 2024-06-27 05:29:54 +00:00
wildcard looser eslint rules (#63511) 2024-06-27 08:42:51 +00:00
BUILD.bazel Added ts_projects for storybook files in client/* (#59400) 2024-01-09 10:37:53 -08:00
README.md use esbuild for client/web builds (#57365) 2023-10-23 10:59:06 -07:00

Frontend packages

List

  • web: The web application deployed to http://sourcegraph.com/
  • browser: The Sourcegraph browser extension adds tooltips to code on different code hosts.
  • vscode: The Sourcegraph VS Code extension.
  • extension-api: The Sourcegraph extension API types for the Sourcegraph extensions. Published as sourcegraph.
  • extension-api-types: The Sourcegraph extension API types for client applications that embed Sourcegraph extensions and need to communicate with them. Published as @sourcegraph/extension-api-types.
  • sandboxes: All demos-mvp (minimum viable product) for the Sourcegraph web application.
  • shared: Contains common TypeScript/React/SCSS client code shared between the browser extension and the web app. Everything in this package is code-host agnostic.
  • branded: Contains React components and implements the visual design language we use across our web app and e.g. in the options menu of the browser extension. Over time, components from shared and branded packages should be moved into the wildcard package.
  • wildcard: Package that encapsulates storybook configuration and contains our Wildcard design system components. If we're using a component in two or more different areas (e.g. web-app and browser-extension) then it should live in the wildcard package. Otherwise the components should be better colocated with the code where they're actually used.
  • search: Search-related code that may be shared between all clients, both branded (e.g. web, VS Code extension) and unbranded (e.g. browser extension)
  • storybook: Storybook configuration.

Further migration plan

  1. Fix circular dependency in TS project-references graph wildcard package should not rely on web and probably shared, branded too. Ideally it should be an independent self-contained package.

  2. Decide on package naming and update existing package names. Especially it should be done for a shared package because we have multiple shared folders inside of other packages. It's hard to understand from where dependency is coming from and it's not possible to refactor import paths using find-and-replace.

  3. Investigate if we can painlessly switch to npm workspaces.

  4. Content of packages shared and branded should be moved to wildcard and refactored using the latest FE rules and conventions. Having different packages clearly communicates the migration plan. Developers first should look for components in the wildcard package and then fall-back to legacy packages if wildcard doesn't have the solution to their problem yet.

  5. shared contains utility functions, types, polyfills, etc which is not a part of the Wildcard component library. These modules should be moved into utils package and other new packages: e.g. api for GraphQL client and type generators, etc.

  6. Packages should use package name (e.g. @sourcegraph/wildcard) for imports instead of the relative paths (e.g. ../../../../wildcard/src/components/Markdown) to avoid long relative-paths and make dependency graph between packages clear. (Typescript will warn if packages have circular dependencies). It's easy to refactor such isolated packages, extract functionality into new ones, or even into new repositories.