@battlefieldduck/xterm-svelte 2.1.0 → 2.1.1

package/README.md

@@ -57,9 +57,9 @@ Here's a basic example of how to use xterm-svelte in your SvelteKit application:
 		Terminal
 	} from '@battlefieldduck/xterm-svelte';
 
-	let terminal: Terminal;
+	let terminal = $state<Terminal>();
 
-	let options: ITerminalOptions & ITerminalInitOnlyOptions = {
+	const options: ITerminalOptions & ITerminalInitOnlyOptions = {
 		fontFamily: 'Consolas'
 	};
 
@@ -68,10 +68,10 @@ Here's a basic example of how to use xterm-svelte in your SvelteKit application:
 
 		// FitAddon Usage
 		const fitAddon = new (await XtermAddon.FitAddon()).FitAddon();
-		terminal.loadAddon(fitAddon);
+		terminal?.loadAddon(fitAddon);
 		fitAddon.fit();
 
-		terminal.write('Hello World');
+		terminal?.write('Hello World');
 	}
 
 	function onData(data: string) {
@@ -92,23 +92,22 @@ Here's a basic example of how to use xterm-svelte in your SvelteKit application:
 
 The `onLoad()` function fires when the xterm terminal is first initialized. You can use this function to perform actions such as initializing xterm addons.
 
-### Why is the `terminal` undefined?
-
-One possible cause is that you called the `terminal` function before it was initialized. For example, if you run the `terminal` function in the `onMount` function without wrapping it with `if (terminal !== undefined)`, it can lead to this issue.
-
 ## Real-world uses
-
-- [Thymis](https://thymis.io): Thymis is an open-source project that aims to provide a seamless and secure IoT device management solution.
-With Thymis, users can easily configure and manage their devices running on the NixOS operating system.
+- [Bitor](https://github.com/bitorscanner/Bitor): Bitor Scanning Software
+- [Asm editor](https://github.com/Specy/asm-editor): A modern webapp to write, run and learn M68K, MIPS, RISC-V, X86 assembly
+- [Sylve](https://github.com/AlchemillaHQ/Sylve): Lightweight GUI for managing Bhyve, Jails, ZFS, networking, and more on FreeBSD
 - [And much more...](https://github.com/BattlefieldDuck/xterm-svelte/network/dependents)
 
 ## Contributing
+
 Contributions are welcome! Please feel free to submit pull requests or open issues.
 
 ![https://github.com/BattlefieldDuck/xterm-svelte/graphs/contributors](https://contrib.rocks/image?repo=BattlefieldDuck/xterm-svelte)
 
 ## License
+
 xterm-svelte is licensed under the MIT License. See the `LICENSE` file for more details.
 
 ## Stargazers over time
+
 [![Stargazers over time](https://starchart.cc/BattlefieldDuck/xterm-svelte.svg?variant=adaptive)](https://starchart.cc/BattlefieldDuck/xterm-svelte)

package/dist/Xterm.svelte

@@ -1,12 +1,12 @@
 <script lang="ts">
 	import '@xterm/xterm/css/xterm.css';
 	import { onMount } from 'svelte';
-	import type { XtermProps } from './index.js';
+	import type { Terminal, XtermProps } from './index.js';
 
 	let parent = $state<HTMLElement>();
 
 	let {
-		terminal = $bindable(),
+		terminal = $bindable<Terminal | undefined>(),
 		options,
 		onBell,
 		onBinary,
@@ -25,7 +25,7 @@
 	}: XtermProps = $props();
 
 	onMount(async () => {
-		const { Terminal } = await import('@xterm/xterm');
+		const Terminal = (await import('@xterm/xterm')).Terminal;
 
 		terminal = new Terminal(options);
 		terminal.onBell(() => onBell?.());

package/dist/XtermProps.d.ts

@@ -1,6 +1,6 @@
-import type { Terminal } from "@xterm/xterm";
+import type { Terminal } from '@xterm/xterm';
 import type { ITerminalOptions, ITerminalInitOnlyOptions } from './index.js';
-import type { HTMLAttributes } from "svelte/elements";
+import type { HTMLAttributes } from 'svelte/elements';
 export type XtermProps = {
     /**
      * Represents an xterm.js terminal.

package/package.json

@@ -1,14 +1,7 @@
 {
 	"name": "@battlefieldduck/xterm-svelte",
-	"version": "2.1.0",
+	"version": "2.1.1",
 	"description": "A SvelteKit wrapper for Xterm.js, enabling terminal embedding in SvelteKit apps, managing Xterm addons, and providing seamless updates with the latest SvelteKit and Xterm.js versions.",
-	"keywords": [
-		"svelte",
-		"xterm",
-		"xterm-js",
-		"sveltekit",
-		"xterm-svelte"
-	],
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/BattlefieldDuck/xterm-svelte.git"
@@ -20,57 +13,67 @@
 	"license": "MIT",
 	"scripts": {
 		"dev": "vite dev",
-		"build": "vite build && npm run package",
+		"build": "vite build && npm run prepack",
 		"preview": "vite preview",
-		"package": "svelte-kit sync && svelte-package && publint",
-		"prepublishOnly": "npm run package",
-		"test": "npm run test:integration && npm run test:unit",
+		"prepare": "svelte-kit sync || echo ''",
+		"prepack": "svelte-kit sync && svelte-package && publint",
 		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
 		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-		"lint": "prettier --check . && eslint .",
 		"format": "prettier --write .",
-		"test:integration": "playwright test",
-		"test:unit": "vitest"
+		"lint": "prettier --check . && eslint .",
+		"test:e2e": "playwright test",
+		"test": "npm run test:e2e"
 	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
 			"svelte": "./dist/index.js"
 		}
 	},
-	"files": [
-		"dist",
-		"!dist/**/*.test.*",
-		"!dist/**/*.spec.*"
-	],
 	"peerDependencies": {
 		"svelte": "^5.0.0"
 	},
 	"devDependencies": {
-		"@playwright/test": "^1.28.1",
-		"@sveltejs/adapter-auto": "^3.0.0",
-		"@sveltejs/kit": "^2.5.27",
+		"@eslint/compat": "^1.2.5",
+		"@eslint/js": "^9.22.0",
+		"@playwright/test": "^1.49.1",
+		"@sveltejs/adapter-auto": "^6.0.0",
+		"@sveltejs/kit": "^2.22.0",
 		"@sveltejs/package": "^2.0.0",
-		"@sveltejs/vite-plugin-svelte": "^4.0.0",
-		"@types/eslint": "^8.56.0",
-		"@typescript-eslint/eslint-plugin": "^7.7.1",
-		"@typescript-eslint/parser": "^7.7.1",
-		"eslint": "^8.56.0",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-plugin-svelte": "^2.45.1",
-		"prettier": "^3.1.1",
-		"prettier-plugin-svelte": "^3.2.6",
-		"publint": "^0.2.7",
+		"@sveltejs/vite-plugin-svelte": "^6.0.0",
+		"@types/node": "^24",
+		"eslint": "^9.22.0",
+		"eslint-config-prettier": "^10.0.1",
+		"eslint-plugin-svelte": "^3.0.0",
+		"globals": "^16.0.0",
+		"prettier": "^3.4.2",
+		"prettier-plugin-svelte": "^3.3.3",
+		"publint": "^0.3.2",
 		"svelte": "^5.0.0",
 		"svelte-check": "^4.0.0",
-		"tslib": "^2.4.1",
-		"typescript": "^5.5.0",
-		"vite": "^5.4.4",
-		"vitest": "^2.0.3"
+		"typescript": "^5.0.0",
+		"typescript-eslint": "^8.20.0",
+		"vite": "^7.0.4",
+		"vite-plugin-devtools-json": "^1.0.0"
 	},
-	"svelte": "./dist/index.js",
-	"types": "./dist/index.d.ts",
-	"type": "module",
+	"keywords": [
+		"svelte",
+		"xterm",
+		"xterm-js",
+		"sveltekit",
+		"xterm-svelte"
+	],
 	"dependencies": {
 		"@xterm/addon-attach": "^0.11.0",
 		"@xterm/addon-canvas": "^0.7.0",