correctly configure ES Module for packages/icons

Author: AtofStryker

packages/icons/.eslintignore

@@ -1,6 +1,8 @@
 **/dist
 index.js
+index.mjs
 **/*.d.ts
+**/*.d.mts
 **/package-lock.json
 **/tsconfig.json
 **/cypress/fixtures

packages/icons/.gitignore

@@ -1,3 +1,5 @@
 **/dist
 index.js
-index.d.ts
+index.mjs
+index.d.ts
+index.d.mts

packages/icons/index.mts

@@ -0,0 +1,19 @@
+import path from 'path'
+
+const dist = [import.meta.dirname, 'dist']
+
+function distPath (...args: string[]) {
+  return path.join.apply(path, dist.concat([...args]))
+}
+
+export const getPathToFavicon = (filename: string) => {
+  return distPath('favicon', filename)
+}
+
+export const getPathToIcon = (filename: string) => {
+  return distPath('icons', filename)
+}
+
+export const getPathToLogo = (filename: string) => {
+  return distPath('logo', filename)
+}

packages/icons/package.json

@@ -31,5 +31,6 @@
   ],
   "types": "index.d.ts",
   "license": "MIT",
+  "module": "index.mjs",
   "nx": {}
 }

packages/icons/test/icons.spec.ts

@@ -1,18 +1,22 @@
 import { describe, it, expect } from 'vitest'
-import * as icons from '../index'
+import * as iconsESM from '../index.mjs'
+import * as iconsCjs from '../index.js'
 
 const cwd = process.cwd()
 
 describe('Cypress Icons', function () {
   it('returns path to favicon', function () {
-    expect(icons.getPathToFavicon('favicon-red.ico')).toEqual(`${cwd }/dist/favicon/favicon-red.ico`)
+    expect(iconsESM.getPathToFavicon('favicon-red.ico')).toEqual(`${cwd }/dist/favicon/favicon-red.ico`)
+    expect(iconsCjs.getPathToFavicon('favicon-red.ico')).toEqual(`${cwd }/dist/favicon/favicon-red.ico`)
   })
 
   it('returns path to icon', function () {
-    expect(icons.getPathToIcon('cypress.icns')).toEqual(`${cwd }/dist/icons/cypress.icns`)
+    expect(iconsESM.getPathToIcon('cypress.icns')).toEqual(`${cwd }/dist/icons/cypress.icns`)
+    expect(iconsCjs.getPathToIcon('cypress.icns')).toEqual(`${cwd }/dist/icons/cypress.icns`)
   })
 
   it('returns path to logo', function () {
-    expect(icons.getPathToLogo('cypress-bw.png')).toEqual(`${cwd }/dist/logo/cypress-bw.png`)
+    expect(iconsESM.getPathToLogo('cypress-bw.png')).toEqual(`${cwd }/dist/logo/cypress-bw.png`)
+    expect(iconsCjs.getPathToLogo('cypress-bw.png')).toEqual(`${cwd }/dist/logo/cypress-bw.png`)
   })
 })

packages/icons/tsconfig.base.json

@@ -1,7 +1,4 @@
 {
-  "include": [
-    "index.ts"
-  ],
   "compilerOptions": {
     "allowJs": false,
     "noImplicitAny": true,

packages/icons/tsconfig.cjs.json

@@ -1,5 +1,8 @@
 {
   "extends": "./tsconfig.base.json",
+  "include": [
+    "index.ts"
+  ],
   "compilerOptions": {
     "target": "ES2022",
     "module": "CommonJS",

packages/icons/tsconfig.esm.json

@@ -1,5 +1,8 @@
 {
   "extends": "./tsconfig.base.json",
+  "include": [
+    "index.mts"
+  ],
   "compilerOptions": {
     "target": "ES2022",
     "module": "ES2022",