feat: Converts project to module, uses import/export syntax

Author: Justintime50

.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: '22'
+          node-version: '24'
       - name: Install dependencies
         run: npm install
       - name: Run Eslint
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        nodeversion: ['16', '18', '20', '22']
+        nodeversion: ['16', '18', '20', '22', '24']
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -35,9 +35,4 @@ jobs:
           npm install
           git submodule init && git submodule update
       - name: Run tests
-        run: npm run coverage
-      - name: Coveralls
-        if: github.ref == 'refs/heads/main'
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+        run: npm run test

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: '22'
+          node-version: '24'
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: |

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v6.0.0 (2025-08-05)
+
+- Converts project to module, uses import/export syntax
+
 ## v5.0.0 (2024-07-16)
 
 - Drops support for Node < 16

README.md

@@ -5,7 +5,6 @@
 Dummy Address Data (DAD) - Retrieve real addresses from all around the world.
 
 [![Build Status](https://github.com/Justintime50/dad-node/workflows/build/badge.svg)](https://github.com/Justintime50/dad-node/actions)
-[![Coverage Status](https://coveralls.io/repos/github/Justintime50/dad-node/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/dad-node?branch=main)
 [![NPM](https://img.shields.io/npm/v/dad-tool)](https://www.npmjs.com/package/dad-tool)
 [![Licence](https://img.shields.io/github/license/justintime50/dad-node)](https://opensource.org/licenses/mit-license.php)
 

cli.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-const dad = require('./index');
+import { random } from './index.js';
 
 // If dad-tool is utilized via CLI, return a random address from a list
 // Usage: dad-tool US_UT
 !(async function () {
   const address_list = process.argv.slice(2);
-  const address = dad.random(address_list[0]);
+  const address = random(address_list[0]);
   console.log(address);
 })();

dad

@@ -1,26 +1,30 @@
 #!/usr/bin/env node
-const path = require('path');
-const dataRouter = require('./lib/dataRouter');
+import { promises as fs } from 'fs';
+import path, { join } from 'path';
+import { fileURLToPath } from 'url';
+
+import { variables } from './lib/dataRouter.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // Pull an entire list of addresses
-function list(data) {
-  const list = require(path.join(__dirname, dataRouter.variables(data)));
-  return list;
+export async function list(data) {
+  const filePath = join(__dirname, variables(data));
+  const fileContent = await fs.readFile(filePath, 'utf-8');
+  return JSON.parse(fileContent);
 }
 
 // Pull a single random address from a list
-function random(data) {
-  const randomAddress = require(path.join(__dirname, dataRouter.variables(data)));
-  const address = randomAddress[Math.floor(Math.random() * randomAddress.length)];
+export async function random(data) {
+  const filePath = join(__dirname, variables(data));
+  const fileContent = await fs.readFile(filePath, 'utf-8');
+  const addressList = JSON.parse(fileContent);
+  const address = addressList[Math.floor(Math.random() * addressList.length)];
   return address;
 }
 
 // Get a list of all ISO country codes
-function isoCountryCodes() {
-  const isoData = require('./dad/src/other/country-codes.min.json');
-  return isoData;
+export async function isoCountryCodes() {
+  const fileContent = await fs.readFile('./dad/src/other/country-codes.min.json', 'utf-8');
+  return JSON.parse(fileContent);
 }
-
-exports.list = list;
-exports.random = random;
-exports.isoCountryCodes = isoCountryCodes;

index.js

@@ -1,4 +1,4 @@
-function variables(data) {
+export function variables(data) {
   // DAD variables
   const addressDirectory = 'dad/src/addresses';
   const fileExtension = '-addresses.min.json';
@@ -50,5 +50,3 @@ function variables(data) {
 
   return dataFilePath;
 }
-
-exports.variables = variables;