cross-platform Deno library for writing and reading clipboard.

Last update: Dec 3, 2022

Related tags

Overview

deno-clippy

This is cross-platform Deno library for writing and reading clipboard.
You can read from/write image and text.

This library uses Rust's arboard through FFI.
Therefore, it is basically not necessary to prepare some external commands when using this library.

However, if arboard returns an error, deno-clippy will fall back and use an external command (for example, xclip on Linux).
If arboard does not work properly and an error occurs, installing the external command may work.

Known issue.

Currently, arboard is not work on Linux.
So, please install xclip when you using library on Linux.

Example

import * as clippy from "https://deno.land/x/clippy/mod.ts";
import { readAll } from "https://deno.land/[email protected]/streams/conversion.ts";

// write image to clipboard
const f = await Deno.open("testdata/out.png");
await clippy.write_image(f);
f.close();

// read image from clipboard
const r = await clippy.read_image();
const data = await readAll(r);

// write text to clipboard
await clippy.write_text("hello clippy");

// read text from clipboard
const text = await clippy.read_text();

Contribution

Any contribution including documentations are welcome.

Development

To develop this library, the following must be installed.

Rust
Deno(v1.24.3 or earlier)
deno_bindgen
xclip(on Linux)
make

If you modify the Rust code (under src/), you need to generate bindings/bindings.ts using deno_bindgen(just run make build).
bindings.ts is the glue code to handle dylib from Deno, and basically should not be edited and committed.
bindings.ts will only be changed for new releases as follows.

 const url = new URL(
-  "https://github.com/skanehira/deno-clippy/releases/download/v0.0.1/",
+  "https://github.com/skanehira/deno-clippy/releases/download/v0.1.0/",
   import.meta.url,
 )
 let uri = url.toString()

After implementation is complete, be sure to write tests as well.
The tests are to ensure the quality of this library.

The following is how to run the test.

# clean up dylib cache, and generate bindings.ts, dylib and run deno's test.
$ make deno-test
# run rust's tests.
$ make ffi-test
# run deno-test and ffi-test
$ make test

Author

skanehira

The logo was designed by @hashrock, licensed under CC BY-NC-ND 4.0.

Comments

Issue when using write_text

import { write_text } from "https://deno.land/x/[email protected]/mod.ts";

await write_text("Foo");

error: Uncaught (in promise) TypeError: Deno.dlopen is not a function
  return Deno.dlopen(file, symbols);
              ^
    at prepare (https://deno.land/x/[email protected]/plug.ts:117:15)
    at async https://deno.land/x/[email protected]/bindings/bindings.ts:51:14

opened by cvburgess 4

Failed in X11 Linux

% deno test -A --unstable
running 2 tests from ./mod_test.ts
image: write to/read from clipboard ... FAILED (135ms)
text: write to/read from clipboard ... FAILED (107ms)

 ERRORS

image: write to/read from clipboard => ./mod_test.ts:4:6
error: Error: The clipboard contents were not available in the requested format or the clipboard is empty.
    throw new Error(result.Error.error);
          ^
    at read_image (file:///home/shougo/src/deno-clippy/mod.ts:32:11)
    at file:///home/shougo/src/deno-clippy/mod_test.ts:9:35

text: write to/read from clipboard => ./mod_test.ts:14:6
error: Error: The clipboard contents were not available in the requested format or the clipboard is empty.
    throw new Error(result.Error.error);
          ^
    at read_text (file:///home/shougo/src/deno-clippy/mod.ts:16:11)
    at file:///home/shougo/src/deno-clippy/mod_test.ts:17:21

 FAILURES

image: write to/read from clipboard => ./mod_test.ts:4:6
text: write to/read from clipboard => ./mod_test.ts:14:6

FAILED | 0 passed | 2 failed (279ms)

error: Test failed

The latest version.

opened by Shougo 2

Doesn't work with Deno 1.25.0

Deno v1.25.0 doesn't work because of a destructive change in FFI. Fix this issue when deno_bindgen supports v1.25.0.

https://github.com/denoland/deno_bindgen/issues/90

opened by skanehira 1