fix: Convert package to ESM

Author: UziTech

.github/workflows/test.yml

@@ -25,8 +25,9 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
       - run: npm ci
-      - name: Ensure dependencies are compatible with the version of node
-        run: npx ls-engines
+      # waiting on https://github.com/ljharb/ls-engines/pull/23 to be fixed
+      # - name: Ensure dependencies are compatible with the version of node
+      #   run: npx ls-engines
       - run: npm run test:ci
   test:
     runs-on: ubuntu-latest

index.js

@@ -1,15 +1,15 @@
 /* eslint require-atomic-updates: off */
 
-const AggregateError = require('aggregate-error');
-const getPkg = require('./lib/get-pkg.js');
-const verifyApm = require('./lib/verify.js');
-const prepareApm = require('./lib/prepare.js');
-const publishApm = require('./lib/publish.js');
+import AggregateError from 'aggregate-error';
+import getPkg from './lib/get-pkg.js';
+import verifyApm from './lib/verify.js';
+import prepareApm from './lib/prepare.js';
+import publishApm from './lib/publish.js';
 
 let verified;
 let prepared;
 
-async function verifyConditions(pluginConfig, context) {
+export async function verifyConditions(pluginConfig, context) {
   const errors = await verifyApm(pluginConfig, context);
 
   try {
@@ -25,7 +25,7 @@ async function verifyConditions(pluginConfig, context) {
   verified = true;
 }
 
-async function prepare(pluginConfig, context) {
+export async function prepare(pluginConfig, context) {
   const errors = verified ? [] : await verifyApm(pluginConfig, context);
 
   try {
@@ -43,7 +43,7 @@ async function prepare(pluginConfig, context) {
   prepared = true;
 }
 
-async function publish(pluginConfig, context) {
+export async function publish(pluginConfig, context) {
   let pkg;
   const errors = verified ? [] : await verifyApm(pluginConfig, context);
 
@@ -64,5 +64,3 @@ async function publish(pluginConfig, context) {
 
   return publishApm(pluginConfig, pkg, context);
 }
-
-module.exports = {verifyConditions, prepare, publish};

lib/definitions/errors.js

@@ -1,33 +1,46 @@
-const pkg = require('../../package.json');
+import {dirname, resolve} from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {readPackageSync} from 'read-pkg';
 
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const pkg = readPackageSync({cwd: resolve(__dirname, '../../')});
 const [homepage] = pkg.homepage.split('#');
 const linkify = (file) => `${homepage}/blob/master/${file}`;
 
-module.exports = {
-  ENOAPMTOKEN: () => ({
+export function ENOAPMTOKEN() {
+  return {
     message: 'No apm token specified.',
     details: `An [apm token](${linkify(
       'README.md#atom-authentication'
     )}) must be created and set in the \`ATOM_ACCESS_TOKEN\` environment variable on your CI environment.
 
 Please visit your account page on [atom.io](https://atom.io/account) and to set it in the \`ATOM_ACCESS_TOKEN\` environment variable on your CI environment.`,
-  }),
-  ENOAPMCLI: () => ({
+  };
+}
+
+export function ENOAPMCL() {
+  return {
     message: 'The apm CLI must be installed.',
     details: `The \`apm\` command line has to be installed in your CI environment and available in the \`PATH\` environment varialbe.
 
 See [Atom installation](${linkify('README.md#atom-installation')}) for more details.`,
-  }),
-  ENOPKGNAME: () => ({
+  };
+}
+
+export function ENOPKGNAM() {
+  return {
     message: 'Missing `name` property in `package.json`.',
     details: `The \`package.json\`'s [name](https://docs.npmjs.com/files/package.json#name) property is required in order to publish an Atom package.
 
 Please make sure to add a valid \`name\` for your package in your \`package.json\`.`,
-  }),
-  ENOPKG: () => ({
+  };
+}
+
+export function ENOPK() {
+  return {
     message: 'Missing `package.json` file.',
     details: `A [package.json file](https://docs.npmjs.com/files/package.json) at the root of your project is required to publish an Atom package.
 
 Please follow the [npm guideline](https://docs.npmjs.com/getting-started/creating-node-modules) to create a valid \`package.json\` file.`,
-  }),
-};
+  };
+}

lib/get-error.js

@@ -1,7 +1,7 @@
-const SemanticReleaseError = require('@semantic-release/error');
-const ERROR_DEFINITIONS = require('./definitions/errors.js');
+import SemanticReleaseError from '@semantic-release/error';
+import * as ERROR_DEFINITIONS from './definitions/errors.js';
 
-module.exports = (code, ctx = {}) => {
+export default function getError(code, ctx = {}) {
   const {message, details} = ERROR_DEFINITIONS[code](ctx);
   return new SemanticReleaseError(message, code, details);
-};
+}

lib/get-pkg.js

@@ -1,10 +1,10 @@
-const readPkg = require('read-pkg');
-const AggregateError = require('aggregate-error');
-const getError = require('./get-error.js');
+import {readPackage} from 'read-pkg';
+import AggregateError from 'aggregate-error';
+import getError from './get-error.js';
 
-module.exports = async (pluginConfig, {cwd}) => {
+export default async function getPkg(pluginConfig, {cwd}) {
   try {
-    const pkg = await readPkg({cwd});
+    const pkg = await readPackage({cwd});
 
     if (!pkg.name) {
       throw getError('ENOPKGNAME');
@@ -15,4 +15,4 @@ module.exports = async (pluginConfig, {cwd}) => {
     const error_ = error.code === 'ENOENT' ? new AggregateError([getError('ENOPKG')]) : new AggregateError([error]);
     throw error_;
   }
-};
+}

lib/prepare.js

@@ -1,11 +1,11 @@
-const execa = require('execa');
+import execa from 'execa';
 
-module.exports = async (pluginConfig, {cwd, env, stdout, stderr, nextRelease: {version}, logger}) => {
+export default async function prepareApm(pluginConfig, {cwd, env, stdout, stderr, nextRelease: {version}, logger}) {
   logger.log(`Write version ${version} to package.json`);
 
   const versionResult = execa('npm', ['version', version, '--no-git-tag-version'], {cwd, env});
   versionResult.stdout.pipe(stdout, {end: false});
   versionResult.stderr.pipe(stderr, {end: false});
 
   await versionResult;
-};
+}

lib/publish.js

@@ -1,6 +1,6 @@
-const execa = require('execa');
+import execa from 'execa';
 
-module.exports = async (pluginConfig, {name}, context) => {
+export default async function publishApm(pluginConfig, {name}, context) {
   const {
     cwd,
     env,
@@ -22,4 +22,4 @@ module.exports = async (pluginConfig, {name}, context) => {
 
   logger.log(`Published ${name}@${version}`);
   return {name: 'Atom package', url: `https://atom.io/packages/${name}`};
-};
+}

lib/resolve-config.js

@@ -1,3 +1,5 @@
-module.exports = (pluginConfig, {env}) => ({
-  apmToken: env.ATOM_ACCESS_TOKEN,
-});
+export default function resolveConfig(pluginConfig, {env}) {
+  return {
+    apmToken: env.ATOM_ACCESS_TOKEN,
+  };
+}

lib/verify.js

@@ -1,8 +1,8 @@
-const execa = require('execa');
-const resolveConfig = require('./resolve-config.js');
-const getError = require('./get-error.js');
+import execa from 'execa';
+import resolveConfig from './resolve-config.js';
+import getError from './get-error.js';
 
-module.exports = async (pluginConfig, context) => {
+export  default async function verifyApm(pluginConfig, context) {
   const {cwd, env} = context;
   const errors = [];
   const {apmToken} = resolveConfig(pluginConfig, context);
@@ -16,4 +16,4 @@ module.exports = async (pluginConfig, context) => {
   }
 
   return errors;
-};
+}