Skip to content
This repository was archived by the owner on Jan 20, 2023. It is now read-only.

Commit fb03ceb

Browse files
UziTechUziTech
committed
fix: Convert package to ESM
1 parent 9f583e5 commit fb03ceb

File tree

16 files changed

+1114
-432
lines changed

16 files changed

+1114
-432
lines changed

‎.github/workflows/test.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ jobs:
2525
node-version: ${{ matrix.node-version }}
2626
cache: npm
2727
- run: npm ci
28-
- name: Ensure dependencies are compatible with the version of node
29-
run: npx ls-engines
28+
# waiting on https://github.com/ljharb/ls-engines/pull/23 to be fixed
29+
# - name: Ensure dependencies are compatible with the version of node
30+
# run: npx ls-engines
3031
- run: npm run test:ci
3132
test:
3233
runs-on: ubuntu-latest

‎index.js‎

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,70 @@
11
/* eslint require-atomic-updates: off */
22

3-
const AggregateError = require('aggregate-error');
4-
const getPkg = require('./lib/get-pkg.js');
5-
const verifyApm = require('./lib/verify.js');
6-
const prepareApm = require('./lib/prepare.js');
7-
const publishApm = require('./lib/publish.js');
3+
import AggregateError from 'aggregate-error';
4+
import getPkg from './lib/get-pkg.js';
5+
import verifyApm from './lib/verify.js';
6+
import prepareApm from './lib/prepare.js';
7+
import publishApm from './lib/publish.js';
88

99
let verified;
1010
let prepared;
1111

12-
async function verifyConditions(pluginConfig, context) {
13-
const errors = await verifyApm(pluginConfig, context);
12+
const plugin = {
13+
async verifyConditions(pluginConfig, context) {
14+
const errors = await verifyApm(pluginConfig, context);
1415

15-
try {
16-
await getPkg(pluginConfig, context);
17-
} catch (error) {
18-
errors.push(...error);
19-
}
16+
try {
17+
await getPkg(pluginConfig, context);
18+
} catch (error) {
19+
errors.push(...error.errors);
20+
}
2021

21-
if (errors.length > 0) {
22-
throw new AggregateError(errors);
23-
}
22+
if (errors.length > 0) {
23+
throw new AggregateError(errors);
24+
}
2425

25-
verified = true;
26-
}
26+
verified = true;
27+
},
2728

28-
async function prepare(pluginConfig, context) {
29-
const errors = verified ? [] : await verifyApm(pluginConfig, context);
29+
async prepare(pluginConfig, context) {
30+
const errors = verified ? [] : await verifyApm(pluginConfig, context);
3031

31-
try {
32-
await getPkg(pluginConfig, context);
33-
} catch (error) {
34-
errors.push(...error);
35-
}
32+
try {
33+
await getPkg(pluginConfig, context);
34+
} catch (error) {
35+
errors.push(...error.errors);
36+
}
3637

37-
if (errors.length > 0) {
38-
throw new AggregateError(errors);
39-
}
38+
if (errors.length > 0) {
39+
throw new AggregateError(errors);
40+
}
4041

41-
await prepareApm(pluginConfig, context);
42+
await prepareApm(pluginConfig, context);
4243

43-
prepared = true;
44-
}
44+
prepared = true;
45+
},
4546

46-
async function publish(pluginConfig, context) {
47-
let pkg;
48-
const errors = verified ? [] : await verifyApm(pluginConfig, context);
47+
async publish(pluginConfig, context) {
48+
let pkg;
49+
const errors = verified ? [] : await verifyApm(pluginConfig, context);
4950

50-
try {
51-
pkg = await getPkg(pluginConfig, context);
52-
} catch (error) {
53-
errors.push(...error);
54-
}
51+
try {
52+
pkg = await getPkg(pluginConfig, context);
53+
} catch (error) {
54+
errors.push(...error.errors);
55+
}
5556

56-
if (errors.length > 0) {
57-
throw new AggregateError(errors);
58-
}
57+
if (errors.length > 0) {
58+
throw new AggregateError(errors);
59+
}
5960

60-
if (!prepared) {
61-
await prepareApm(pluginConfig, context);
62-
prepared = true;
63-
}
61+
if (!prepared) {
62+
await prepareApm(pluginConfig, context);
63+
prepared = true;
64+
}
6465

65-
return publishApm(pluginConfig, pkg, context);
66-
}
66+
return publishApm(pluginConfig, pkg, context);
67+
},
68+
};
6769

68-
module.exports = {verifyConditions, prepare, publish};
70+
export default plugin;

‎lib/definitions/errors.js‎

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,50 @@
1-
const pkg = require('../../package.json');
1+
import {dirname, resolve} from 'node:path';
2+
import {fileURLToPath} from 'node:url';
3+
import {readPackageSync} from 'read-pkg';
24

5+
const __dirname = dirname(fileURLToPath(import.meta.url));
6+
const pkg = readPackageSync({cwd: resolve(__dirname, '../../')});
37
const [homepage] = pkg.homepage.split('#');
48
const linkify = (file) => `${homepage}/blob/master/${file}`;
59

6-
module.exports = {
7-
ENOAPMTOKEN: () => ({
8-
message: 'No apm token specified.',
9-
details: `An [apm token](${linkify(
10-
'README.md#atom-authentication'
11-
)}) must be created and set in the \`ATOM_ACCESS_TOKEN\` environment variable on your CI environment.
10+
const errors = {
11+
ENOAPMTOKEN() {
12+
return {
13+
message: 'No apm token specified.',
14+
details: `An [apm token](${linkify(
15+
'README.md#atom-authentication'
16+
)}) must be created and set in the \`ATOM_ACCESS_TOKEN\` environment variable on your CI environment.
1217
1318
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.`,
14-
}),
15-
ENOAPMCLI: () => ({
16-
message: 'The apm CLI must be installed.',
17-
details: `The \`apm\` command line has to be installed in your CI environment and available in the \`PATH\` environment varialbe.
19+
};
20+
},
21+
22+
ENOAPMCLI() {
23+
return {
24+
message: 'The apm CLI must be installed.',
25+
details: `The \`apm\` command line has to be installed in your CI environment and available in the \`PATH\` environment varialbe.
1826
1927
See [Atom installation](${linkify('README.md#atom-installation')}) for more details.`,
20-
}),
21-
ENOPKGNAME: () => ({
22-
message: 'Missing `name` property in `package.json`.',
23-
details: `The \`package.json\`'s [name](https://docs.npmjs.com/files/package.json#name) property is required in order to publish an Atom package.
28+
};
29+
},
30+
31+
ENOPKGNAME() {
32+
return {
33+
message: 'Missing `name` property in `package.json`.',
34+
details: `The \`package.json\`'s [name](https://docs.npmjs.com/files/package.json#name) property is required in order to publish an Atom package.
2435
2536
Please make sure to add a valid \`name\` for your package in your \`package.json\`.`,
26-
}),
27-
ENOPKG: () => ({
28-
message: 'Missing `package.json` file.',
29-
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.
37+
};
38+
},
39+
40+
ENOPKG() {
41+
return {
42+
message: 'Missing `package.json` file.',
43+
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.
3044
3145
Please follow the [npm guideline](https://docs.npmjs.com/getting-started/creating-node-modules) to create a valid \`package.json\` file.`,
32-
}),
46+
};
47+
},
3348
};
49+
50+
export default errors;

‎lib/get-error.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
const SemanticReleaseError = require('@semantic-release/error');
2-
const ERROR_DEFINITIONS = require('./definitions/errors.js');
1+
import SemanticReleaseError from '@semantic-release/error';
2+
import ERROR_DEFINITIONS from './definitions/errors.js';
33

4-
module.exports = (code, ctx = {}) => {
4+
export default function getError(code, ctx = {}) {
55
const {message, details} = ERROR_DEFINITIONS[code](ctx);
66
return new SemanticReleaseError(message, code, details);
7-
};
7+
}

‎lib/get-pkg.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
const readPkg = require('read-pkg');
2-
const AggregateError = require('aggregate-error');
3-
const getError = require('./get-error.js');
1+
import {readPackage} from 'read-pkg';
2+
import AggregateError from 'aggregate-error';
3+
import getError from './get-error.js';
44

5-
module.exports = async (pluginConfig, {cwd}) => {
5+
export default async function getPkg(pluginConfig, {cwd}) {
66
try {
7-
const pkg = await readPkg({cwd});
7+
const pkg = await readPackage({cwd});
88

99
if (!pkg.name) {
1010
throw getError('ENOPKGNAME');
@@ -15,4 +15,4 @@ module.exports = async (pluginConfig, {cwd}) => {
1515
const error_ = error.code === 'ENOENT' ? new AggregateError([getError('ENOPKG')]) : new AggregateError([error]);
1616
throw error_;
1717
}
18-
};
18+
}

‎lib/prepare.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
const execa = require('execa');
1+
import execa from 'execa';
22

3-
module.exports = async (pluginConfig, {cwd, env, stdout, stderr, nextRelease: {version}, logger}) => {
3+
export default async function prepare(pluginConfig, {cwd, env, stdout, stderr, nextRelease: {version}, logger}) {
44
logger.log(`Write version ${version} to package.json`);
55

66
const versionResult = execa('npm', ['version', version, '--no-git-tag-version'], {cwd, env});
77
versionResult.stdout.pipe(stdout, {end: false});
88
versionResult.stderr.pipe(stderr, {end: false});
99

1010
await versionResult;
11-
};
11+
}

‎lib/publish.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
const execa = require('execa');
1+
import execa from 'execa';
22

3-
module.exports = async (pluginConfig, {name}, context) => {
3+
export default async function publish(pluginConfig, {name}, context) {
44
const {
55
cwd,
66
env,
@@ -22,4 +22,4 @@ module.exports = async (pluginConfig, {name}, context) => {
2222

2323
logger.log(`Published ${name}@${version}`);
2424
return {name: 'Atom package', url: `https://atom.io/packages/${name}`};
25-
};
25+
}

‎lib/resolve-config.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
module.exports = (pluginConfig, {env}) => ({
2-
apmToken: env.ATOM_ACCESS_TOKEN,
3-
});
1+
export default function resolveConfig(pluginConfig, {env}) {
2+
return {
3+
apmToken: env.ATOM_ACCESS_TOKEN,
4+
};
5+
}

‎lib/verify.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
const execa = require('execa');
2-
const resolveConfig = require('./resolve-config.js');
3-
const getError = require('./get-error.js');
1+
import execa from 'execa';
2+
import resolveConfig from './resolve-config.js';
3+
import getError from './get-error.js';
44

5-
module.exports = async (pluginConfig, context) => {
5+
export default async function verify(pluginConfig, context) {
66
const {cwd, env} = context;
77
const errors = [];
88
const {apmToken} = resolveConfig(pluginConfig, context);
@@ -16,4 +16,4 @@ module.exports = async (pluginConfig, context) => {
1616
}
1717

1818
return errors;
19-
};
19+
}

0 commit comments

Comments
 (0)