Add Wayland clipboard support

Fixes #38

Author: sindresorhus

index.d.ts

@@ -9,9 +9,6 @@ declare const clipboard: {
 	import clipboard from 'clipboardy';
 
 	await clipboard.write('🦄');
-
-	await clipboard.read();
-	//=> '🦄'
 	```
 	*/
 	write(text: string): Promise<void>;
@@ -23,9 +20,7 @@ declare const clipboard: {
 	```
 	import clipboard from 'clipboardy';
 
-	await clipboard.write('🦄');
-
-	await clipboard.read();
+	const content = await clipboard.read();
 	//=> '🦄'
 	```
 	*/
@@ -43,9 +38,6 @@ declare const clipboard: {
 	import clipboard from 'clipboardy';
 
 	clipboard.writeSync('🦄');
-
-	clipboard.readSync();
-	//=> '🦄'
 	```
 	*/
 	writeSync(text: string): void;
@@ -59,9 +51,7 @@ declare const clipboard: {
 	```
 	import clipboard from 'clipboardy';
 
-	clipboard.writeSync('🦄');
-
-	clipboard.readSync();
+	const content = clipboard.readSync();
 	//=> '🦄'
 	```
 	*/

index.js

@@ -1,7 +1,9 @@
 import process from 'node:process';
 import isWSL from 'is-wsl';
+import isWayland from 'is-wayland';
 import termux from './lib/termux.js';
 import linux from './lib/linux.js';
+import wayland from './lib/wayland.js';
 import macos from './lib/macos.js';
 import windows from './lib/windows.js';
 
@@ -29,31 +31,40 @@ const platformLib = (() => {
 				return windows;
 			}
 
+			// Check for Wayland session on Linux
+			if (isWayland()) {
+				return wayland;
+			}
+
 			return linux;
 		}
 	}
 })();
 
-const clipboard = {};
+const clipboard = {
+	async write(text) {
+		if (typeof text !== 'string') {
+			throw new TypeError(`Expected a string, got ${typeof text}`);
+		}
 
-clipboard.write = async text => {
-	if (typeof text !== 'string') {
-		throw new TypeError(`Expected a string, got ${typeof text}`);
-	}
+		await platformLib.copy({input: text});
+	},
 
-	await platformLib.copy({input: text});
-};
+	async read() {
+		return platformLib.paste({stripFinalNewline: false});
+	},
 
-clipboard.read = async () => platformLib.paste({stripFinalNewline: false});
+	writeSync(text) {
+		if (typeof text !== 'string') {
+			throw new TypeError(`Expected a string, got ${typeof text}`);
+		}
 
-clipboard.writeSync = text => {
-	if (typeof text !== 'string') {
-		throw new TypeError(`Expected a string, got ${typeof text}`);
-	}
+		platformLib.copySync({input: text});
+	},
 
-	platformLib.copySync({input: text});
+	readSync() {
+		return platformLib.pasteSync({stripFinalNewline: false});
+	},
 };
 
-clipboard.readSync = () => platformLib.pasteSync({stripFinalNewline: false});
-
 export default clipboard;

lib/linux.js

@@ -11,11 +11,13 @@ const copyArguments = ['--clipboard', '--input'];
 const pasteArguments = ['--clipboard', '--output'];
 
 const makeError = (xselError, fallbackError) => {
-	let error;
-	if (xselError.code === 'ENOENT') {
-		error = new Error('Couldn\'t find the `xsel` binary and fallback didn\'t work. On Debian/Ubuntu you can install xsel with: sudo apt install xsel');
-	} else {
-		error = new Error('Both xsel and fallback failed');
+	const message = xselError.code === 'ENOENT'
+		? 'Couldn\'t find the `xsel` binary and fallback didn\'t work. On Debian/Ubuntu you can install xsel with: sudo apt install xsel'
+		: 'Both xsel and fallback failed';
+
+	const error = new Error(message);
+
+	if (xselError.code !== 'ENOENT') {
 		error.xselError = xselError;
 	}
 

lib/termux.js

@@ -2,7 +2,7 @@ import {execa, execaSync} from 'execa';
 
 const handler = error => {
 	if (error.code === 'ENOENT') {
-		throw new Error('Couldn\'t find the termux-api scripts. You can install them with: apt install termux-api');
+		throw new Error('Couldn\'t find the `termux-api` scripts. You can install them with: apt install termux-api');
 	}
 
 	throw error;

lib/wayland.js

@@ -0,0 +1,70 @@
+import {execa, execaSync} from 'execa';
+import linux from './linux.js';
+
+// Common arguments for text clipboard operations
+const textArgs = ['--type', 'text/plain'];
+
+const makeError = (command, error) => {
+	if (error.code === 'ENOENT') {
+		return new Error(`Couldn't find the \`${command}\` binary. On Debian/Ubuntu you can install wl-clipboard with: sudo apt install wl-clipboard`);
+	}
+
+	return new Error(`Command \`${command}\` failed: ${error.message}`);
+};
+
+const tryWaylandWithFallback = async (command, arguments_, options, fallbackMethod) => {
+	try {
+		const result = await execa(command, arguments_, options);
+		return result.stdout;
+	} catch (error) {
+		// Handle empty clipboard on wl-paste
+		if (command === 'wl-paste' && /nothing is copied|no selection|selection owner/i.test(error.stderr || '')) {
+			return '';
+		}
+
+		// Fall back to X11 if wl-clipboard not found OR Wayland not available
+		if (error.code === 'ENOENT'
+			|| /wayland|wayland_display|failed to connect|display/i.test(error.stderr || '')) {
+			return fallbackMethod(options);
+		}
+
+		throw makeError(command, error);
+	}
+};
+
+const tryWaylandWithFallbackSync = (command, arguments_, options, fallbackMethod) => {
+	try {
+		const result = execaSync(command, arguments_, options);
+		return result.stdout;
+	} catch (error) {
+		// Handle empty clipboard on wl-paste
+		if (command === 'wl-paste' && /nothing is copied|no selection|selection owner/i.test(error.stderr || '')) {
+			return '';
+		}
+
+		// Fall back to X11 if wl-clipboard not found OR Wayland not available
+		if (error.code === 'ENOENT'
+			|| /wayland|wayland_display|failed to connect|display/i.test(error.stderr || '')) {
+			return fallbackMethod(options);
+		}
+
+		throw makeError(command, error);
+	}
+};
+
+const clipboard = {
+	async copy(options) {
+		await tryWaylandWithFallback('wl-copy', textArgs, options, linux.copy);
+	},
+	copySync(options) {
+		tryWaylandWithFallbackSync('wl-copy', textArgs, options, linux.copySync);
+	},
+	async paste(options) {
+		return tryWaylandWithFallback('wl-paste', [...textArgs, '--no-newline'], options, linux.paste);
+	},
+	pasteSync(options) {
+		return tryWaylandWithFallbackSync('wl-paste', [...textArgs, '--no-newline'], options, linux.pasteSync);
+	},
+};
+
+export default clipboard;

lib/windows.js

@@ -1,6 +1,5 @@
 import {Buffer} from 'node:buffer';
 import path from 'node:path';
-import process from 'node:process';
 import {fileURLToPath} from 'node:url';
 import {execa, execaSync} from 'execa';
 import {is64bitSync} from 'is64bit';
@@ -30,6 +29,7 @@ const createEncodedCommand = script => {
 // Robust PowerShell commands with error handling
 const psCopyScript = `
 try {
+	[Console]::InputEncoding = [System.Text.Encoding]::UTF8
 	$input = [Console]::In.ReadToEnd()
 	if ($input -eq $null) { $input = '' }
 	Set-Clipboard -Value $input

package.json

@@ -20,7 +20,6 @@
 	"engines": {
 		"node": ">=18"
 	},
-	"sideEffects": false,
 	"scripts": {
 		"test": "xo && ava && tsd"
 	},
@@ -46,6 +45,7 @@
 	],
 	"dependencies": {
 		"execa": "^8.0.1",
+		"is-wayland": "^0.1.0",
 		"is-wsl": "^3.1.0",
 		"is64bit": "^2.0.0"
 	},

readme.md

@@ -2,7 +2,7 @@
 
 > Access the system clipboard (copy/paste)
 
-Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with [Termux](https://termux.com/), and [modern browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#Browser_compatibility).
+Cross-platform. Supports: macOS, Windows, Linux (including Wayland), OpenBSD, FreeBSD, Android with [Termux](https://termux.com/), and [modern browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#Browser_compatibility).
 
 ## Install
 
@@ -15,6 +15,12 @@ npm install clipboardy
 ```js
 import clipboard from 'clipboardy';
 
+await clipboard.write('🦄');
+
+await clipboard.read();
+//=> '🦄'
+
+// Or use the synchronous API
 clipboard.writeSync('🦄');
 
 clipboard.readSync();
@@ -23,27 +29,36 @@ clipboard.readSync();
 
 ## API
 
-In the browser, it requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
+**Browser usage:** Requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) (HTTPS). Synchronous methods are not available in browsers.
 
 ### clipboard
 
 #### .write(text)
 
 Write (copy) to the clipboard asynchronously.
 
-Returns a `Promise`.
+Returns a `Promise<void>`.
 
 ##### text
 
 Type: `string`
 
 The text to write to the clipboard.
 
+```js
+await clipboard.write('🦄');
+```
+
 #### .read()
 
 Read (paste) from the clipboard asynchronously.
 
-Returns a `Promise`.
+Returns a `Promise<string>`.
+
+```js
+const content = await clipboard.read();
+//=> '🦄'
+```
 
 #### .writeSync(text)
 
@@ -57,12 +72,23 @@ Type: `string`
 
 The text to write to the clipboard.
 
+```js
+clipboard.writeSync('🦄');
+```
+
 #### .readSync()
 
 Read (paste) from the clipboard synchronously.
 
+Returns a `string`.
+
 **Doesn't work in browsers.**
 
+```js
+const content = clipboard.readSync();
+//=> '🦄'
+```
+
 ## FAQ
 
 #### Where can I find the source of the bundled binaries?
@@ -71,6 +97,10 @@ The [Linux binary](fallbacks/linux/xsel) is just a bundled version of [`xsel`](h
 
 On Windows, clipboardy first tries the native PowerShell cmdlets (`Set-Clipboard`/`Get-Clipboard`) and falls back to the bundled binary if PowerShell is unavailable or restricted.
 
+#### Does this work on Wayland?
+
+Yes. On Linux, clipboardy automatically detects Wayland sessions and uses [`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) when available. If not, it gracefully falls back to X11 tools. Also works with WSLg (Windows Subsystem for Linux GUI). Install `wl-clipboard` using your distribution's package manager.
+
 ## Related
 
 - [clipboard-cli](https://github.com/sindresorhus/clipboard-cli) - CLI for this module