feat: ES Module (#72)

BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: Node 12+ required

.github/workflows/test.yml

@@ -3,24 +3,36 @@ on:
   push:
     branches:
       - master
-      - "greenkeeper/**"
   pull_request:
-    types: [opened, synchronize]
+    types:
+      - opened
+      - synchronize
 
 jobs:
-  test:
+  test_matrix:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node_version: [10, 12, 14]
+        node_version:
+          - 12
+          - 14
+          - 16
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node_version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node_version }}
-      - name: Install
-        run: npm ci
-      - name: Test
-        run: npm test
+          cache: npm
+      - run: npm ci
+      - run: npm run test:code
+
+  test:
+    runs-on: ubuntu-latest
+    needs: test_matrix
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run test:types

.gitignore

@@ -1,3 +1 @@
-coverage
-node_modules
-pkg
+node_modules

LICENSE.md

@@ -1,6 +1,6 @@
 # [ISC License](https://spdx.org/licenses/ISC)
 
-Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m)
+Copyright (c) 2018-2021, Gregor Martynus (https://github.com/gr2m)
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

README.md

@@ -1,10 +1,9 @@
 # universal-user-agent
 
-> Get a user agent string in both browser and node
+> Get a user agent string across all JavaScript Runtime Environments
 
 [![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent)
-[![Build Status](https://github.com/gr2m/universal-user-agent/workflows/Test/badge.svg)](https://github.com/gr2m/universal-user-agent/actions?query=workflow%3ATest+branch%3Amaster)
-[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/)
+[![Build Status](https://github.com/gr2m/universal-user-agent/workflows/Test/badge.svg)](https://github.com/gr2m/universal-user-agent/actions/workflows/test.yml?query=workflow%3ATest)
 
 ```js
 const { getUserAgent } = require("universal-user-agent");
@@ -16,10 +15,6 @@ const userAgent = getUserAgent();
 // in node: Node.js/v8.9.4 (macOS High Sierra; x64)
 ```
 
-## Credits
-
-The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent).
-
 ## License
 
 [ISC](LICENSE.md)

index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a User Agent String based on the current environment (Browser, Node, Deno, etc).
+ */
+export function getUserAgent(): string;

src/index.ts → index.js

@@ -1,4 +1,4 @@
-export function getUserAgent(): string {
+export function getUserAgent() {
   if (typeof navigator === "object" && "userAgent" in navigator) {
     return navigator.userAgent;
   }

index.test-d.ts

@@ -0,0 +1,5 @@
+import { expectType } from "tsd";
+
+import { getUserAgent } from "./index.js";
+
+expectType<string>(getUserAgent());