feat: type module, native fetch, vitest

.github/workflows/main.yml

@@ -15,27 +15,25 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/[email protected]
 
-      - name: setup node ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
-      - name: cache node_modules
-        id: node-cache
-        uses: actions/cache@v2
+      - name: Setup node ${{ matrix.node-version }}
+        uses: actions/[email protected]
         with:
-          path: node_modules
-          key: node-${{ matrix.node-version }}-${{ hashFiles('package-lock.json') }}
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: install dependencies
-        if: steps.node-cache.outputs.cache-hit != 'true'
-        run: npm ci
+      - name: Install dependencies
+        run: pnpm install
 
-      - run: npm run test
+      - run: pnpm test
 
-      - run: npx codecov
+      - name: Codecov
+        uses: codecov/[email protected]

.husky/commit-msg

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname $0)/_/husky.sh"
-
-npx --no-install commitlint --edit $1
+npx --no -- commitlint --edit $1

.prettierrc

@@ -1,5 +1,5 @@
 {
+  "semi": false,
   "singleQuote": true,
-  "trailingComma": "all",
   "proseWrap": "always"
 }

README.md

@@ -7,7 +7,7 @@ Discover & control Roku devices from NodeJS.
 
 **requirements:**
 
-- node `10 or higher`
+- node `18 or higher`
 - a Roku device connected to your network
 - a router/network that supports UPnP (for ssdp)
 
@@ -18,28 +18,19 @@ Discover & control Roku devices from NodeJS.
 ## Usage
 
 ```js
-// es2015
-import { RokuClient, Keys } from 'roku-client';
+import { RokuClient, Keys } from 'roku-client'
 
-// commonjs
-const { RokuClient, Keys } = require('roku-client');
+const client = await RokuClient.discover(/* timeout, defaults to 10 seconds */)
+console.log(`roku device found at ${client.ip}`)
 
-RokuClient.discover(/* timeout, defaults to 10 seconds */)
-  .then((client) => {
-    console.log(`roku device found at ${client.ip}`);
-    return client.apps();
-  })
-  .then((apps) => {
-    apps.forEach((app) => console.log(app));
-    // [{ id, name, type, version }, ...]
-  })
-  .catch((err) => {
-    console.error(err.stack);
-  });
+const apps = await client.apps()
+
+apps.forEach((app) => console.log(app))
+// [{ id, name, type, version }, ...]
 
 // Or, if the roku address is already known
-const client = new RokuClient('http://192.168.1.17:8060');
-client.keypress(Keys.VOLUME_UP);
+const client = new RokuClient('http://192.168.1.17:8060')
+client.keypress(Keys.VOLUME_UP)
 ```
 
 ## RokuClient.discover()
@@ -55,12 +46,12 @@ can be called which will wait the full timeout and return a promise that
 resolves to an array of clients for all the addresses found.
 
 ```js
-import { RokuClient } from 'roku-client';
+import { RokuClient } from 'roku-client'
 
 RokuClient.discoverAll().then((clients) => {
-  console.log(clients.map((c) => c.ip));
+  console.log(clients.map((c) => c.ip))
   // ['http://192.168.1.17:8060', 'http://192.168.1.18:8060', ...]
-});
+})
 ```
 
 ## API Methods
@@ -90,10 +81,10 @@ RokuClient.discoverAll().then((clients) => {
 accessed programmatically:
 
 ```js
-import { Keys } from 'roku-client';
+import { Keys } from 'roku-client'
 
-Keys.HOME; // 'Home'
-Keys.LEFT; // 'Left'
+Keys.HOME // 'Home'
+Keys.LEFT // 'Left'
 ```
 
 ### Commander
@@ -129,13 +120,13 @@ client
   .then(/* commands succeeded */)
   .catch((err) => {
     /* commands failed */
-  });
+  })
 ```
 
 ##### Turn the volume up by 10
 
 ```js
-client.command().volumeUp(10).send();
+client.command().volumeUp(10).send()
 ```
 
 ##### Conditionally perform a command
@@ -146,7 +137,7 @@ client
   .exec((cmd) => (goUp ? cmd.up(10) : cmd.down(10)))
   .right()
   .select()
-  .send();
+  .send()
 ```
 
 ##### Konami code
@@ -162,23 +153,23 @@ client
   .right()
   .text('ba')
   .enter()
-  .send();
+  .send()
 ```
 
 ##### Wait before performing the next command
 
 ```js
-client.command().enter().wait(1000).text('some text').send();
+client.command().enter().wait(1000).text('some text').send()
 ```
 
 ##### Usage as a macro
 
 ```js
-const volumeUp5 = client.command().volumeUp(5);
-const volumeDown5 = client.command().volumeDown(5);
+const volumeUp5 = client.command().volumeUp(5)
+const volumeDown5 = client.command().volumeDown(5)
 
-volumeUp5.send();
-volumeUp5.send();
+volumeUp5.send()
+volumeUp5.send()
 ```
 
 ## Usage in the Browser
@@ -191,15 +182,14 @@ mechanism is out of the question. I was able to stub that part out with a
 "browsers" field in package.json. The final nail in the coffin is that roku
 devices don't set CORS headers, so even after getting the library to run,
 browsers block the requests. At this point I've decided there isn't any point in
-making this library isomorphic. In the future I might replace [fetch-ponyfill]
-with something more light weight.
+making this library isomorphic.
 
 If you have a good reason for this library to work in browsers, let me know by
 opening an issue!
 
 ## Testing
 
-`$ npm run test`
+`$ pnpm test`
 
 This will run the linter, unit tests, and coverage.
 
@@ -221,7 +211,7 @@ Tested on OSX & raspberry pi w/ raspbian jessie, and with Roku TV.
 [npm]: https://img.shields.io/npm/v/roku-client.svg?logo=npm
 [npm-url]: https://npmjs.com/package/roku-client
 [build]:
-  https://img.shields.io/github/workflow/status/bschlenk/node-roku-client/Node.js%20CI?logo=github
+  https://img.shields.io/github/actions/workflow/status/bschlenk/node-roku-client/main.yml?logo=github&branch=master
 [build-url]:
   https://github.com/bschlenk/node-roku-client/actions?query=workflow%3A%22Node.js+CI%22
 [codecov]:
@@ -231,5 +221,3 @@ Tested on OSX & raspberry pi w/ raspbian jessie, and with Roku TV.
 [device-info.ts]:
   https://github.com/bschlenk/node-roku-client/blob/master/lib/device-info.ts
 [skypack.dev]: https://www.skypack.dev
-[node-fetch]: https://www.npmjs.com/package/node-fetch
-[fetch-ponyfill]: https://www.npmjs.com/package/fetch-ponyfill

commitlint.config.js

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
   extends: ['@commitlint/config-conventional'],
-};
+}

eslint.config.js

@@ -0,0 +1,22 @@
+import bschlenk, { globals } from '@bschlenk/eslint-config';
+
+export default [
+  { ignores: ['**/dist/'] },
+  { files: ['**/*.js', '**/*.ts'] },
+
+  {
+    languageOptions: {
+      parserOptions: { project: './tsconfig.json' },
+      globals: { ...globals.es2022 },
+    },
+  },
+
+  ...bschlenk.configs.typescript,
+
+  {
+    rules: {
+      '@typescript-eslint/no-empty-object-type': 'off',
+      '@typescript-eslint/no-unsafe-declaration-merging': 'off',
+    },
+  },
+];