{"id":19493126,"url":"https://github.com/pehrs/vscode-vespa","last_synced_at":"2025-04-25T20:31:01.819Z","repository":{"id":214612484,"uuid":"736942159","full_name":"pehrs/vscode-vespa","owner":"pehrs","description":"Vespa AI Extension for  Visual Studio Code ","archived":false,"fork":false,"pushed_at":"2025-02-23T09:32:32.000Z","size":3904,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T03:11:24.294Z","etag":null,"topics":["admin","completion","syntax-highlighting","vespa","vespa-engine","vespaai","visual-studio","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pehrs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-29T10:22:44.000Z","updated_at":"2025-02-23T09:32:35.000Z","dependencies_parsed_at":"2024-01-01T14:42:22.418Z","dependency_job_id":"fb310875-0387-4e1e-b40a-a45df3ff2b38","html_url":"https://github.com/pehrs/vscode-vespa","commit_stats":null,"previous_names":["pehrs/vscode-vespa"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pehrs%2Fvscode-vespa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pehrs%2Fvscode-vespa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pehrs%2Fvscode-vespa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pehrs%2Fvscode-vespa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pehrs","download_url":"https://codeload.github.com/pehrs/vscode-vespa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250890262,"owners_count":21503459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin","completion","syntax-highlighting","vespa","vespa-engine","vespaai","visual-studio","vscode","vscode-extension"],"created_at":"2024-11-10T21:24:31.846Z","updated_at":"2025-04-25T20:31:01.791Z","avatar_url":"https://github.com/pehrs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vscode-vespa - Vespa YQL request support for Visual Studio Code\n\nThe [VS Code Vespa extension](https://github.com/pehrs/vscode-vespa) provides rich language support for the [Vespa YQL Language](https://docs.vespa.ai/en/query-language.html).\n\n\n## Features\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"media/vscode-vespa.gif\" width=75%\u003e\n\u003cbr/\u003e\n\u003c/p\u003e\n\n* Run YQL requests against your vespa clusters and present the result in a webview table..\n\n* Simple completion support is given for request snippets and the YQL query string.\n\n* Optionally render a zipkin view if you enable tracing for your YQL request.\n\n* Vespa Explorer \n\n  * Explore and download application files.\n\n\n### Keybindings\n\n`vscode-vespa` has the following keybindings by default (You can change them in the keybinding editor if you need to):\n\n| Keybinding | Description |\n|------------|-------------|\n| ctrl+enter | Run the YQL request on the currently connected Vespa Cluster |\n| ctrl+home  | Open the Vespa Cluster Info panel |\n| ctrl+end   | Select Vespa cluster to connect to |\n\n\n## Requirements\n\n[Vespa cluster running](https://docs.vespa.ai/en/getting-started.html) with the config and query endpoints available (ports 19071, 19050 and 8080).\n\n(Optional) [Zipkin Server](https://zipkin.io/) running\n\nSee the sections below for details on how to run vespa and zipkin for development.\n\n### Run Vespa cluster and deploy sample app with Docker Compose\n\n```shell\n\ncd vespa-sample-app\n\n./vespa-cluster-start.sh\n\n# Deploy the sample app\n./deploy-app.sh\n\n# Wait until vespa is up and running, then\n./books-insert.sh\n```\n\n### Zipkin\n\nOptionally if you wish to view traces of your Vespa queries you can start a zipkin server.\n\n```shell\n# Start Zipkin server\ndocker run --name zipkin -d -p 9411:9411 openzipkin/zipkin\n\n# Stop Zipkin server\ndocker rm -f zipkin\n```\n\n## Extension Settings\n\nThe `vscode-vespa` extension is configured via a config file in `$HOME/.config/vscode-vespa/vespa-config.json`.\nIf the config file is not present then `vscode-vespa` will create a default config:\n\n```json\n{\n\t\"defaultCluster\": \"localhost\",\n\t\"clusters\": [\n\t\t{\n\t\t\t\"name\": \"localhost\",\n\t\t\t\"queryEndpoint\": \"http://localhost:8080/search\",\n\t\t\t\"configEndpoint\": \"http://localhost:19071\",\n\t\t\t\"controllerEndpoint\": \"http://localhost:19050\",\n\t\t\t\"zipkinEndpoint\": \"http://localhost:9411\",\n\t\t}\n\t],\n\t\"httpTimeout\": \"2s\",\n}\n```\n\nYou can edit the config file directly in vscode by selecting the \n\"Edit Vespa Cluster Configuration\" command in the YQL editor menu.\n\n## Known Issues\n\n### YQL (.yql) Syntax\n\nThis is work in progress. \n\nWe have started working on a [yql request syntax file](syntaxes/yqlReq.tmLanguage.json) and added support for coloring of the `yql` parameter via the [yql syntax](syntaxes/yql.tmLanguage.json). These are based on the [vscode JSON syntax](https://github.com/microsoft/vscode/blob/main/extensions/json/syntaxes/JSON.tmLanguage.json) and [vscode SQL syntax](https://github.com/microsoft/vscode/blob/main/extensions/sql/syntaxes/sql.tmLanguage.json)\n\n### Schema (.sd) Syntax\n\nThis is work in progress. \n\nWe have started working on this in a new [Vespa Schema syntax](syntaxes/sd.tmLanguage.json).\n\n### Zipkin traces\nThe zipkin traces are work-in-progress as the Vespa trace format is quite hard to parse.\nWe have use the [TransformVespaTrace.jsx](https://github.com/vespa-engine/vespa/blob/master/client/js/app/src/app/pages/querybuilder/TransformVespaTrace.jsx) \nfrom [Vespa](https://github.com/vespa-engine/vespa) as the \"source of truth\" on how to parse the Vespa traces.\n\n\n### Language Server\n\nIn the source code there is a beginings of a \n[language server](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide) in the [server/](server/) dir.\nThis is not enabled as the features it gives, at the moment, are limited.\n\n## Release Notes\n\nPlease read the [CHANGELOG](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpehrs%2Fvscode-vespa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpehrs%2Fvscode-vespa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpehrs%2Fvscode-vespa/lists"}