Deno first

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+        with:
+          version: "1.8.3"
+
+      - name: Lint and formatting
+        run: biome ci .
+
+      - name: Set up Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: 1.x
+
+      - name: Run tests
+        run: deno test

.gitignore

@@ -1,5 +1,4 @@
 dist
 node_modules
-.vscode
 package-lock.json
 yarn.lock

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["biomejs.biome", "denoland.vscode-deno"]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "deno.enable": true,
+    "editor.defaultFormatter": "biomejs.biome"
+}

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 3.0.0
+
+-   `text-clipper` has become a Deno-first library and is now available on [Jsr.io](https://jsr.io).
+    Instructions for installation on Node.js/Bun are still included.
+
 ## 2.2.0
 
 -   Implement #14: Add `stripTags` option.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Arend van Beelen jr., Speakap B.V.
+Copyright (c) 2016-2024 Arend van Beelen jr., Speakap B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,9 +2,6 @@
 
 Fast and correct clip functions for HTML and plain text.
 
-[![Build Status](https://travis-ci.org/arendjr/text-clipper.svg?branch=master)](https://travis-ci.org/arendjr/text-clipper)
-[![text-clipper on NPM](https://img.shields.io/npm/v/text-clipper.svg)](https://www.npmjs.com/package/text-clipper)
-
 ## Why use text-clipper?
 
 text-clipper offers the following advantages over similar libraries that allow clipping HTML:
@@ -22,43 +19,46 @@ text-clipper offers the following advantages over similar libraries that allow c
 
 ## Usage
 
-### Node.js
+### Deno
 
-First install the `text-clipper` package:
+First install the package:
 
 ```sh
-$ yarn add text-clipper  # or: npm install --save text-clipper
+$ deno add @arendjr/text-clipper
 ```
 
-If compatibility with Internet Explorer is required, make sure you have a polyfill for
-`Array.prototype.includes()`.
-
 Once installed, you can use it as follows:
 
 ```js
-import clip from "text-clipper"; // or: const clip = require("text-clipper").default;
+import clip from "@arendjr/text-clipper";
 
 const clippedString = clip(string, 80); // returns a string of at most 80 characters
 
 const clippedHtml = clip(htmlString, 140, { html: true, maxLines: 5 });
 ```
 
-### Deno
+### Bun
 
-When using Deno, you can import right away:
+Install using the following command instead:
 
-```js
-import clip from "https://raw.githubusercontent.com/arendjr/text-clipper/master/mod.ts";
+```sh
+$ bunx jsr add @arendjr/text-clipper
 ```
 
-And use it like this:
+For usage instructions, see above.
 
-```js
-const clippedString = clip(string, 80); // returns a string of at most 80 characters
+### Node.js
 
-const clippedHtml = clip(htmlString, 140, { html: true, maxLines: 5 });
+Install using one of the following commands, depending on your package manager:
+
+```sh
+$ npx jsr add @arendjr/text-clipper # If using NPM
+$ yarn dlx jsr add @arendjr/text-clipper # If using Yarn
+$ pnpm dlx jsr add @arendjr/text-clipper # If using PNPM
 ```
 
+For usage instructions, see above.
+
 ## Options
 
 ### breakWords
@@ -107,3 +107,13 @@ clip(input, 140, { html: true, stripTags: ["img", "svg"] });
 ```
 
 Tag names must be specified in lowercase.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+Licensed under the MIT License.
+
+See [LICENSE](LICENSE).

deno.json

@@ -0,0 +1,12 @@
+{
+    "name": "@arendjr/text-clipper",
+    "version": "3.0.0",
+    "compilerOptions": {
+        "allowJs": true,
+        "strict": true
+    },
+    "lock": false,
+    "publish": {
+        "include": ["src"]
+    }
+}

tests/unit/examples.test.ts

@@ -0,0 +1,10 @@
+import { assertEquals } from "jsr:@std/assert";
+
+import clip from "../../src/index.ts";
+
+Deno.test("examples: test examples from the README", () => {
+    assertEquals(clip("foo", 3), "foo");
+    assertEquals(clip("foo", 2), "f…");
+    assertEquals(clip("foo bar", 5), "foo …");
+    assertEquals(clip("foo\nbar", 5), "foo");
+});