{"id":19872760,"url":"https://github.com/snuffydev/svelte-language-server-web","last_synced_at":"2025-05-02T09:31:27.722Z","repository":{"id":182681226,"uuid":"664836569","full_name":"snuffyDev/svelte-language-server-web","owner":"snuffyDev","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-05T23:33:05.000Z","size":26808,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T00:51:12.809Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/snuffyDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-07-10T21:29:16.000Z","updated_at":"2024-10-08T02:26:15.000Z","dependencies_parsed_at":"2023-07-20T23:28:14.139Z","dependency_job_id":"b41a9458-e17a-423b-9c90-ad1c75fa07be","html_url":"https://github.com/snuffyDev/svelte-language-server-web","commit_stats":null,"previous_names":["snuffydev/svelte-language-server-web"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snuffyDev%2Fsvelte-language-server-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snuffyDev%2Fsvelte-language-server-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snuffyDev%2Fsvelte-language-server-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snuffyDev%2Fsvelte-language-server-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snuffyDev","download_url":"https://codeload.github.com/snuffyDev/svelte-language-server-web/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252015812,"owners_count":21680828,"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":[],"created_at":"2024-11-12T16:16:37.307Z","updated_at":"2025-05-02T09:31:22.714Z","avatar_url":"https://github.com/snuffyDev.png","language":"TypeScript","funding_links":["https://opencollective.com/svelte"],"categories":[],"sub_categories":[],"readme":"# svelte-language-server-web\n\nSvelte language server within a web worker.\n\nBased on/inspired by: https://github.com/asafamr/monaco-svelte/\n\n\u003e Warning: this is highly experimental, and is _nearly_ production ready!\n\n## Features\n\n- Uses latest packages for `typescript`, `svelte`, `svelte-preprocess`, etc.\n- Editor-agnostic, use with Monaco, VSCode Web, CodeMirror...\n- Supports SvelteKit\n  - also supports SvelteKit's auto-generated type definitions for your routes and endpoints!\n- Works fully like you'd expect!\n- Path aliases (`$lib/`, `@/`, or anything defined in `tsconfig.json/jsconfig.json`)\n- Automatic type acquisition (ATA)\n  - You must send a `package.json` file (as an object) to the Worker for this feature to work.\n- TypeScript Language Server (for `.js/.ts` file intellisense)\n\n## How it works\n\nThe core of all of this is the `module_shims` directory. Therein lies most of the custom code, such as the `fs` module which is used and injected wherever `fs` is imported. Essentially this repo emulates Node.js wherever it can, otherwise it will just do a barebones shim so that 'it works'.\n\nHowever, good news is, there shouldn't be many pain points. As far as I've tested, all functionality works just like in the official Svelte Language Server!\n\n## Demo\n\nNeed convinced? [Try it out here!](https://svelte-language-server-web.vercel.app/)\n\n_(demo uses CodeMirror 6, paired with https://github.com/FurqanSoftware/codemirror-languageserver)_\n\n## Usage\n\nCreating the Svelte Language Server worker:\n\n```ts\n// /worker.ts\nimport { SvelteLanguageWorker } from \"svelte-language-server-web/svelteWorker\";\n\nexport default SvelteLanguageWorker();\n```\n\nCreating the TypeScript Language Server worker:\n\n```ts\n// /tsWorker.ts\nimport { TypeScriptWorker } from \"svelte-language-server-web/tsWorker\";\n\nexport default TypeScriptWorker();\n```\n\nUsing the worker (CodeMirror 6):\n\n```ts\nimport { WorkerRPC } from \"svelte-language-server-web\";\n\nconst files = {\n  \"/package.json\": \"...\", // package.json as a string\n  \"/tsconfig.json\": \"...\", // tsconfig.json as a string\n  \"/src/App.svelte\": \"...\", // Svelte Component as a string\n  // .. rest of your files\n};\n\n// setup the svelte worker\nconst svelteWorker = new Worker(new URL(\"./worker.ts\", import.meta.url), {\n  type: \"module\",\n});\n\n// setup the typescript worker\nconst tsWorker = new Worker(new URL(\"./tsWorker.ts\", import.meta.url), {\n  type: \"module\",\n});\n\nconst svelteLanguageServer = new WorkerRPC(svelteWorker, {\n  rootUri: null,\n  workspaceFolders: null,\n  // full options can be found here: https://github.com/FurqanSoftware/codemirror-languageserver/blob/master/src/index.ts#L466-L476\n});\n\nconst tsLanguageServer = new WorkerRPC(tsWorker, {\n  rootUri: null,\n  workspaceFolders: null,\n});\n\nawait Promise.all([\n  /**\n   * fetch the type definitions for your dependencies\n   * (can be called at any time to fetch type definitions for packages on-demand)\n   */\n  svelteLanguageServer.fetchTypes(files[\"/package.json\"]),\n  tsLanguageServer.fetchTypes(files[\"/package.json\"]),\n\n  /**\n   * add your project's files\n   * (can be called at any time to add files on-demand)\n   */\n  svelteLanguageServer.addFiles(files),\n  tsLanguageServer.addFiles(files),\n\n  // setup and finish setup\n  svelteLanguageServer.setup(files),\n  tsLanguageServer.setup(files),\n]);\n\n// create the EditorState per document\nconst state = EditorState.create({\n  doc: files[\"/src/App.svelte\"],\n  extensions: [\n    languageServerWithTransport({\n      transport: svelteLanguageServer,\n      documentUri: \"file:///src/App.svelte\", // documentUri must start with `file:///`\n      languageId: \"svelte\",\n      workspaceFolders: null,\n      rootUri: \"file:///\",\n      allowHTMLContent: true,\n      autoClose: false,\n      client: svelteLanguageServer.client(),\n    }),\n  ],\n});\n\n// Create the editor with basic setup and Svelte + TypeScript language server integration\nconst editor = new EditorView({\n  state,\n  parent: document.getElementById(\"editor\")!,\n  extensions: [],\n});\n```\n\nMore complete examples of usage can be found in `/examples` within the repository.\n\n## Supporting Svelte\n\n\u003e (from: https://github.com/sveltejs/language-tools/blob/master/README.md)\n\u003e Be sure to support their great work!\n\nSvelte is an MIT-licensed open source project with its ongoing development made possible entirely by the support of awesome volunteers. If you'd like to support their efforts, please consider:\n\n- [Becoming a backer on Open Collective](https://opencollective.com/svelte).\n\nFunds donated via Open Collective will be used for compensating expenses related to Svelte's development such as hosting costs. If sufficient donations are received, funds may also be used to support Svelte's development more directly.\n\n## License\n\n[MIT](LICENSE)\n\n## Credits\n\n- [The Svelte maintainers](https://github.com/sveltejs/) for their interest in this project, as well as their support\n- [sveltejs/language-tools](https://github.com/sveltejs/language-tools/) for the original code this repo is based on\n- [asafamr/monaco-svelte](https://github.com/asafamr/monaco-svelte/) for originally inspiring this repo\n- [asafamr/svelte-vscode-web](https://github.com/asafamr/svelte-vscode-web/) for originally inspiring this repo, and for originally doing the heavy lifting with the config, as well as certain patches\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnuffydev%2Fsvelte-language-server-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnuffydev%2Fsvelte-language-server-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnuffydev%2Fsvelte-language-server-web/lists"}