feat: convert to ES Modules

BREAKING CHANGE: this changes the min Node.js version and changes the
API

.github/workflows/sync-issue-labels.yaml

@@ -10,10 +10,10 @@ on:
     branches:
       - saga
     paths:
-      - ".github/workflows/sync-issue-labels.yaml"
+      - '.github/workflows/sync-issue-labels.yaml'
   workflow_dispatch:
   schedule:
-    - cron: "0 0 * * *"
+    - cron: '0 0 * * *'
 
 jobs:
   sync_issue_labels:

.github/workflows/test-and-release.yaml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: "18.x"
+          node-version: '20.x'
       - name: Authenticate with NPM registry
         run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
       - name: Keep npm cache around to speed up installs
@@ -24,6 +24,8 @@ jobs:
           key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }}
       - name: Install dependencies
         run: npm ci --no-audit
+      - name: Format source code with prettier
+        run: npx prettier -c ./
       - name: Lint
         run: npx standard
       - name: Test

.github/workflows/update-repo-info.yaml

@@ -7,8 +7,8 @@ on:
     branches:
       - saga
     paths:
-      - "package.json"
-      - ".github/workflows/update-repo-info.yaml"
+      - 'package.json'
+      - '.github/workflows/update-repo-info.yaml'
   workflow_dispatch:
 
 jobs:

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none"
+}

README.md

@@ -18,9 +18,9 @@ Returns random 8-letter words from the [Webster's Unabridged Dictionary](http://
     npm i --save --save-exact @nordicsemiconductor/random-words
 
 ```javascript
-const { randomWords } = require("@nordicsemiconductor/random-words");
+import { randomWords } from '@nordicsemiconductor/random-words'
 
-randomWords().then(console.log); // [ 'scoparin', 'prowling', 'priedieu', 'gantline' ]
+console.log(randomWords()) // [ 'scoparin', 'prowling', 'priedieu', 'gantline' ]
 ```
 
 ## CLI Usage

cli.js

@@ -1,9 +1,4 @@
 #!/usr/bin/env node
-const { randomWords } = require("./index");
+import { randomWords } from './index.js'
 
-const cli = async () => {
-  const words = await randomWords();
-  process.stdout.write(words.join(" "));
-};
-
-cli();
+process.stdout.write(randomWords().join(' '))

commitlint.config.cjs

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

example.js

@@ -1,3 +1,3 @@
-const { randomWords } = require("@nordicsemiconductor/random-words");
+import { randomWords } from '@nordicsemiconductor/random-words'
 
-randomWords().then(console.log);
+console.log(randomWords())

index.d.ts

@@ -1,6 +1,4 @@
 /**
  * Generate random words
  */
-export declare const randomWords: (params?: {
-  numWords: number;
-}) => Promise<string[]>;
+export declare const randomWords: (params?: { numWords: number }) => string[]

index.js

@@ -1,20 +1,20 @@
-const { words, count } = require("./words");
-const randomNumber = require("random-number-csprng");
+import { words } from './words.js'
+import { randomInt } from 'node:crypto'
 
-async function* randomWord() {
+/* eslint-disable generator-star-spacing */
+/* eslint-disable space-before-function-paren */
+function* randomWord() {
   while (true) {
-    const number = await randomNumber(0, count - 1);
-    yield words[number];
+    const number = randomInt(0, words.length - 1)
+    yield words[number]
   }
 }
 
-module.exports = {
-  randomWords: async ({ numWords } = { numWords: 4 }) => {
-    const randomWords = [];
-    const r = randomWord();
-    for (let i = 0; i < parseInt(numWords, 10); i++) {
-      randomWords.push((await r.next()).value);
-    }
-    return randomWords;
-  },
-};
+export const randomWords = ({ numWords } = { numWords: 4 }) => {
+  const randomWords = []
+  const r = randomWord()
+  for (let i = 0; i < parseInt(numWords, 10); i++) {
+    randomWords.push(r.next().value)
+  }
+  return randomWords
+}