Skip to content

Migrate extension webviews to Svelte 5#815

Open
nobody5050 wants to merge 25 commits intowpilibsuite:2027from
nobody5050:feat/convert-to-svelte
Open

Migrate extension webviews to Svelte 5#815
nobody5050 wants to merge 25 commits intowpilibsuite:2027from
nobody5050:feat/convert-to-svelte

Conversation

@nobody5050
Copy link
Copy Markdown

@nobody5050 nobody5050 commented Nov 9, 2025

This PR converts the webviews to a frontend framework, namely Svelte 5. All of the webviews are now built with rollup and share a lot more infrastructure, so i18n and similar should be easier to maintain. They also have the benefit of sharing components so the different wizards are easier to keep in sync.

Closes #55

Status:

  • Dependency View
  • Project Creator
  • Project Importer
  • Help
  • Riolog

- Help
- Project Creator
- Project Importer
- Dependency View
@github-actions github-actions Bot added the 2027 label Nov 9, 2025
Comment thread .vscode/launch.json Outdated
@nobody5050 nobody5050 changed the title Convert webviews to Svelte Migrate extension webviews to Svelte 5 Dec 29, 2025
Comment thread vscode-wpilib/package-lock.json Outdated
@Gold856
Copy link
Copy Markdown
Member

Gold856 commented Feb 19, 2026

Per https://code.visualstudio.com/api/extension-guides/webview#passing-messages-from-a-webview-to-an-extension:

For security reasons, you must keep the VS Code API object private and make sure it is never leaked into the global scope.

Copy link
Copy Markdown
Member

@Gold856 Gold856 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may or may not review this more closely later, but just some broad details I'm noticing (and some of the recommendations may be wrong since I completed the Basic Svelte tutorial like 30 minutes ago):

  • Almost all props seem to be optional, but that doesn't actually seem to be the case in practice; they're either defaulted in the child component or initialized with a value in the parent. In fact, several type definitions have their optional declaration erased because of that. How many props can we change to not be optional?
  • Speaking of props, we're passing an insane number of props to several child components. Can some of this be replaced with global state in .svelte.ts files? Global state is kinda icky, but these webviews are small, so globals aren't used in very far away places.
  • Let's try to completely dump Webpack in this PR. I'm not interested in dealing with multiple build systems.
  • Can we make the config files use ES modules?
  • There's a lot of functions without JSDoc. Try to add some API docs to newly added shared functions/components.
  • Can we reduce the main.ts boilerplate by inlining as much as possible?

Comment thread vscode-wpilib/src/webviews/svelte/riolog/time.ts Outdated
{/if}
</div>
</div>
{:else}
Copy link
Copy Markdown
Member

@Gold856 Gold856 Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a seriously impressive amount of indentation (8 indents!) There has to be a way to simplify that...

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternative as best I can tell would need to make use of $derived spam and would be truly unreadable. At least this is readable. Open to suggestions for other ways to solve it.

Comment thread vscode-wpilib/rolldown.webviews.config.mjs
Comment thread vscode-wpilib/resources/webviews/help.html Outdated
Comment thread vscode-wpilib/tsconfig.json Outdated
Comment thread vscode-wpilib/src/webviews/svelte/projectcreator/ProjectCreator.svelte Outdated
Comment thread vscode-wpilib/src/webviews/svelte/lib/i18n.ts
Comment thread vscode-wpilib/src/webviews/svelte/riolog/RioLog.svelte
Comment thread vscode-wpilib/rollup.config.js Outdated
Comment thread vscode-wpilib/resources/webviews/help.html Outdated
@nobody5050 nobody5050 requested a review from Gold856 April 14, 2026 05:26
Comment thread vscode-wpilib/src/webviews/svelte/riolog/RioLog.svelte Outdated
Comment thread vscode-wpilib/resources/media/main.css
Comment thread vscode-wpilib/src/riolog/rioconnector.ts Outdated
Comment thread vscode-wpilib/src/riolog/rioconnector.ts Outdated
Comment on lines +5 to +19
type DistHtmlOptions = {
webview: vscode.Webview;
extensionRoot: vscode.Uri;
distHtmlFileName: string;
extraCss?: vscode.Uri[];
appAttributes?: Record<string, string>;
};

type RewriteHtmlOptions = {
webview: vscode.Webview;
extensionRoot: vscode.Uri;
html: string;
extraCss?: vscode.Uri[];
appAttributes?: Record<string, string>;
};
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unify these and make the non-common fields a separate parameter at the call site.

Comment thread vscode-wpilib/src/webviews/distWebviewHtml.ts Outdated
Comment thread vscode-wpilib/.vscodeignore
Comment thread vscode-wpilib/package.json Outdated
Comment thread vscode-wpilib/rollup.webviews.config.mjs Outdated
} from './types';

const vscode = acquireVsCodeApi();
const t = createTranslator('projectcreator');
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ugh. The current translation infrastructure is riddled with tech debt. Keeping compat with a future l10n transition would mean all calls look like l10n.t.

- Add rollup configuration to .vscodeignore
- Re-sort package.json
- Better checks for workspace in DependencyView
- Clean up unused code in various files
- Update TypeScript configuration to target ES2021 (allows promise.any)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants