Release 0.4.0

* **Breaking Change:** Switch from CommonJS to ECMAScript modules
* **Breaking Change:** Bump minimum supported Node.js version to LTS release 18
* Replace `to-ico` package dependency with `png-to-ico` to avoid audit problems with transient dependencies
* Replace `nyc` package dev dependency with `c8` for ESM support
* Replace broad use of Symbols with ES2022 private class fields
* Bump dependencies

Author: Alasdair Mercer

.nycrc .c8rc.json

@@ -4,6 +4,6 @@
   "statements": 95,
   "functions": 95,
   "branches": 95,
-  "include": [ "src/**/*.js" ],
+  "include": [ "src/**/*.mjs" ],
   "reporter": [ "lcov" ]
 }

.eslintrc.json

@@ -1,10 +1,11 @@
 {
   "extends": "eslint:recommended",
   "parserOptions": {
-    "ecmaVersion": 8
+    "ecmaVersion": 2023,
+    "sourceType": "module"
   },
   "env": {
-    "es6": true,
+    "es2023": true,
     "node": true
   },
   "rules": {

.github/workflows/ci.yml

@@ -17,21 +17,21 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node: [18.x]
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ matrix.node }}
       - name: Install dependencies
         run: npm install
       - name: Lint packages
         run: npm run lint
       - name: Test packages
         run: npm test
       - name: Report test coverage
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -20,7 +20,6 @@ Thumbs.db
 
 # Tests
 /coverage
-/.nyc_output
 
 # IDEs and editors
 /.idea

CHANGES.md

@@ -1,3 +1,11 @@
+## Version 0.4.0, 2023.08.26
+
+* **Breaking Change:** Switch from CommonJS to ECMAScript modules
+* **Breaking Change:** Bump minimum supported Node.js version to LTS release 18
+* Replace `to-ico` package dependency with `png-to-ico` to avoid audit problems with transient dependencies
+* Replace broad use of Symbols with ES2022 private class fields
+* Bump dependencies
+
 ## Version 0.3.2, 2022.05.17
 
 * Fix bug where Git repository branch was not being detected

CONTRIBUTING.md

@@ -16,7 +16,7 @@ $ npm install
 $ npm test
 ```
 
-You must have at least [Node.js](https://nodejs.org) version 12.20.0 or newer installed.
+You must have at least [Node.js](https://nodejs.org) version 18 or newer installed.
 
 All pull requests should be made to the `main` branch.
 

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (C) 2022 neocotic
+Copyright (C) 2023 neocotic
 
 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

@@ -1,6 +1,6 @@
 # Brander
 
-[![Build Status](https://img.shields.io/github/workflow/status/neocotic/brander/CI/develop?style=flat-square)](https://github.com/neocotic/brander/actions/workflows/ci.yml)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/neocotic/brander/CI?style=flat-square)](https://github.com/neocotic/brander/actions/workflows/ci.yml)
 [![Coverage](https://img.shields.io/codecov/c/github/neocotic/brander/develop.svg?style=flat-square)](https://codecov.io/gh/neocotic/brander)
 [![License](https://img.shields.io/npm/l/brander.svg?style=flat-square)](https://github.com/neocotic/brander/blob/main/LICENSE.md)
 [![Release](https://img.shields.io/npm/v/brander.svg?style=flat-square)](https://npmjs.com/package/brander)
@@ -28,7 +28,7 @@ Alternatively, if you're wanting to use `brander` command, you'll probably prefe
 $ npm install --global brander
 ```
 
-You'll need to have at least [Node.js](https://nodejs.org) 12.20.0 or newer.
+You'll need to have at least [Node.js](https://nodejs.org) 18 or newer.
 
 ## Usage
 
@@ -51,6 +51,6 @@ A list of Brander contributors can be found in [AUTHORS.md](https://github.com/n
 
 ## License
 
-Copyright © 2022 neocotic
+Copyright © 2023 neocotic
 
 See [LICENSE.md](https://github.com/neocotic/brander/raw/main/LICENSE.md) for more information on our MIT license.

bin/brander bin/brander.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 /*
- * Copyright (C) 2022 neocotic
+ * Copyright (C) 2023 neocotic
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,16 +22,17 @@
  * SOFTWARE.
  */
 
-'use strict';
-
 /* eslint-disable no-process-exit */
 
-const debug = require('debug');
-const { program } = require('commander');
+import { program } from 'commander';
+import debug from 'debug';
+import { createRequire } from 'node:module';
+
+import { Brander } from '../src/brander.mjs';
+import { ConfigLoader } from '../src/config/config-loader.mjs';
+import { Logger } from '../src/logger.mjs';
 
-const Brander = require('../src/brander');
-const ConfigLoader = require('../src/config/config-loader');
-const Logger = require('../src/logger');
+const require = createRequire(import.meta.url);
 const { version } = require('../package.json');
 
 (async() => {