Switch to ESM

Author: XhmikosR

README.md

@@ -12,8 +12,10 @@ npm install resolve-dependency-path
 
 ## Usage
 
+### ESM
+
 ```js
-const resolvePath = require('resolve-dependency-path');
+import resolvePath from 'resolve-dependency-path';
 
 const resolved = resolvePath({
   dependency: './foobar',
@@ -22,6 +24,12 @@ const resolved = resolvePath({
 });
 ```
 
+### CommonJS
+
+```js
+const { default: resolvePath } = require('resolve-dependency-path');
+```
+
 ### Options
 
 | Option | Type | Required | Description |

index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Resolve a dependency specifier to an absolute file path.
+ *
+ * @param  {object} options
+ * @param  {string} options.dependency - The dependency specifier (e.g. `'./bar'` or `'lodash'`)
+ * @param  {string} options.filename   - Absolute or relative path of the file that contains the dependency
+ * @param  {string} options.directory  - Root directory used to resolve non-relative dependencies
+ * @returns {string} Resolved absolute path including the inferred file extension
+ * @throws {Error} When any of the required options is missing or falsy
+ */
+export default function resolveDependencyPath({ dependency, filename, directory }?: {
+    dependency: string;
+    filename: string;
+    directory: string;
+}): string;

index.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const path = require('node:path');
+import path from 'node:path';
 
 /**
  * Resolve a dependency specifier to an absolute file path.
@@ -12,7 +10,7 @@ const path = require('node:path');
  * @returns {string} Resolved absolute path including the inferred file extension
  * @throws {Error} When any of the required options is missing or falsy
  */
-module.exports = function({ dependency, filename, directory } = {}) {
+export default function resolveDependencyPath({ dependency, filename, directory } = {}) {
   if (!dependency) throw new Error('dependency path not given');
   if (!filename) throw new Error('filename not given');
   if (!directory) throw new Error('directory not given');
@@ -21,7 +19,7 @@ module.exports = function({ dependency, filename, directory } = {}) {
   const extension = getDependencyExtension(dependency, filename);
 
   return filepath + extension;
-};
+}
 
 /**
  * @param  {string} dependency

package-lock.json

@@ -2,9 +2,16 @@
   "name": "resolve-dependency-path",
   "version": "4.0.1",
   "description": "Convert a dependency path into a filepath",
-  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
     "lint": "xo",
@@ -29,7 +36,7 @@
   },
   "homepage": "https://github.com/dependents/node-resolve-dependency-path",
   "engines": {
-    "node": ">=20"
+    "node": ">=20.19.0 || >=22.12.0"
   },
   "devDependencies": {
     "c8": "^11.0.0",

package.json

@@ -1,9 +1,10 @@
-'use strict';
+import assert from 'node:assert/strict';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { suite } from 'uvu';
+import resolvePath from '../index.js';
 
-const assert = require('node:assert').strict;
-const path = require('node:path');
-const { suite } = require('uvu');
-const resolvePath = require('../index.js');
+const directory = fileURLToPath(new URL('.', import.meta.url));
 
 const test = suite('resolve-dependency-path');
 const multiPeriod = suite('multiple period filenames');
@@ -27,22 +28,20 @@ test('throws if the directory is missing', () => {
   assert.throws(() => {
     resolvePath({
       dependency: './bar',
-      filename: path.join(__dirname, '/foo.js')
+      filename: path.join(directory, '/foo.js')
     });
   }, /^Error: directory not given$/);
 });
 
 test('resolves with absolute paths', () => {
   const dependency = './bar';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(resolved.startsWith(directory), true);
 });
 
 test('resolves w/initial period, w/ending in .js', () => {
   const dependency = './index';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/index.js');
@@ -51,7 +50,6 @@ test('resolves w/initial period, w/ending in .js', () => {
 
 test('resolves w/initial period, w/o ending in .js', () => {
   const dependency = './index.js';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/index.js');
@@ -60,7 +58,6 @@ test('resolves w/initial period, w/o ending in .js', () => {
 
 test('resolves w/o initial period, w/o ending in .js', () => {
   const dependency = 'index';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/index.js');
@@ -69,7 +66,6 @@ test('resolves w/o initial period, w/o ending in .js', () => {
 
 test('resolves w/o initial period, w/ending in .js', () => {
   const dependency = 'index.js';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/index.js');
@@ -78,7 +74,6 @@ test('resolves w/o initial period, w/ending in .js', () => {
 
 test('resolves relative paths', () => {
   const dependency = './bar.js';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/bar.js');
@@ -87,7 +82,6 @@ test('resolves relative paths', () => {
 
 test('resolves non-relative paths', () => {
   const dependency = 'feature2/bar';
-  const directory = __dirname;
   const filename = path.join(directory, '/feature1/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/feature2/bar.js');
@@ -96,7 +90,6 @@ test('resolves non-relative paths', () => {
 
 multiPeriod('resolves with multiple periods in the dependency path', () => {
   const dependency = './bar.baz.qux';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   const expected = path.join(directory, '/bar.baz.qux.js');
@@ -105,7 +98,6 @@ multiPeriod('resolves with multiple periods in the dependency path', () => {
 
 multiPeriod('does not duplicate extensions', () => {
   const dependency = '../index.js';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   // Extension after removing the .js extension
@@ -115,55 +107,48 @@ multiPeriod('does not duplicate extensions', () => {
 
 multiPeriod('does not add the incorrect extension for sass files', () => {
   const dependency = 'styles';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.scss');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.scss');
 });
 
 multiPeriod('does not add the incorrect extension for mustache files', () => {
   const dependency = 'hgn!templates/foo.mustache';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.mustache');
 });
 
 implicitPlugins('resolve w/initial period', () => {
   const dependency = './templates/file.css!';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.css');
 });
 
 implicitPlugins('resolve w/o initial period', () => {
   const dependency = 'templates/file.css!';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.css');
 });
 
 explicitPlugins('resolve w/initial period', () => {
   const dependency = './templates/file.txt!text';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.txt');
 });
 
 explicitPlugins('resolve w/o initial period', () => {
   const dependency = 'templates/file.txt!text';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.txt');
 });
 
 webpackSupport.skip('resolves properly', () => {
   const dependency = './styles/foo.css';
-  const directory = __dirname;
   const filename = path.join(directory, '/foo.js');
   const resolved = resolvePath({ dependency, filename, directory });
   assert.equal(path.extname(resolved), '.css');

test/test.js

@@ -1,8 +1,7 @@
-'use strict';
-
-module.exports = [
+export default [
   {
     ignores: [
+      'index.d.ts',
       'test/fixtures/**'
     ]
   },
@@ -46,8 +45,6 @@ module.exports = [
       ],
       'prefer-template': 'error',
       'require-unicode-regexp': 'off',
-      'unicorn/no-anonymous-default-export': 'off',
-      'unicorn/prefer-module': 'off',
       'unicorn/prefer-top-level-await': 'off',
       'unicorn/prevent-abbreviations': 'off'
     }