♻️ Migrate cli to ESM

babel.config.json

@@ -0,0 +1,30 @@
+{
+  "presets": [
+    "@babel/preset-flow"
+  ],
+  "plugins": [
+    [
+      "module-resolver",
+      {
+        "alias": {
+          "@utils": "./src/utils",
+          "@commands": "./src/commands",
+          "@constants": "./src/constants"
+        }
+      }
+    ],
+    "@babel/plugin-syntax-import-assertions",
+    "module-extension-resolver"
+  ],
+  "env": {
+    "test": {
+      "presets": [
+        "@babel/preset-env",
+        "@babel/preset-flow"
+      ],
+      "plugins": [
+        "babel-plugin-transform-import-meta"
+      ]
+    }
+  }
+}

package.json

@@ -1,9 +1,10 @@
 {
   "name": "gitmoji-cli",
   "version": "6.3.0",
+  "type": "module",
   "description": "A gitmoji client for using emojis on commit messages.",
   "engines": {
-    "node": ">=14"
+    "node": ">=14.16"
   },
   "bin": {
     "gitmoji": "lib/cli.js"
@@ -43,26 +44,29 @@
   },
   "homepage": "https://github.com/carloscuesta/gitmoji-cli#readme",
   "dependencies": {
-    "chalk": "4.1.0",
+    "chalk": "^5.0.1",
     "conf": "10.2.0",
-    "execa": "5.1.1",
+    "execa": "^6.1.0",
     "fuse.js": "6.6.2",
-    "inquirer": "8.2.4",
+    "inquirer": "8.x",
     "inquirer-autocomplete-prompt": "2.0.0",
-    "meow": "9.0.0",
-    "node-fetch": "2.6.7",
-    "ora": "5.4.1",
-    "path-exists": "4.0.0",
+    "meow": "^10.1.3",
+    "node-fetch": "^3.2.10",
+    "ora": "^6.1.2",
+    "path-exists": "^5.0.0",
     "proxy-agent": "5.0.0",
-    "update-notifier": "5.1.0",
+    "update-notifier": "^6.0.2",
     "validator": "^13.7.0"
   },
   "devDependencies": {
     "@babel/cli": "7.18.10",
     "@babel/core": "7.19.1",
+    "@babel/plugin-syntax-import-assertions": "^7.18.6",
     "@babel/preset-env": "7.19.1",
     "@babel/preset-flow": "7.18.6",
+    "babel-plugin-module-extension-resolver": "^1.0.0-rc.2",
     "babel-plugin-module-resolver": "^4.1.0",
+    "babel-plugin-transform-import-meta": "^2.2.0",
     "codecov": "3.8.3",
     "flow-bin": "^0.187.0",
     "husky": "8.0.1",
@@ -73,31 +77,6 @@
     "pkg": "5.8.0",
     "prettier": "2.7.1"
   },
-  "babel": {
-    "presets": [
-      [
-        "@babel/preset-env",
-        {
-          "targets": {
-            "node": "12"
-          }
-        }
-      ],
-      "@babel/preset-flow"
-    ],
-    "plugins": [
-      [
-        "module-resolver",
-        {
-          "alias": {
-            "@utils": "./src/utils",
-            "@commands": "./src/commands",
-            "@constants": "./src/constants"
-          }
-        }
-      ]
-    ]
-  },
   "jest": {
     "coverageDirectory": "./coverage/",
     "collectCoverage": true,
@@ -110,7 +89,10 @@
     "setupFiles": [
       "./test/setupTests.js"
     ],
+    "transformIgnorePatterns": [],
     "moduleNameMapper": {
+      "^#ansi-styles$": "<rootDir>/node_modules/chalk/source/vendor/ansi-styles/index.js",
+      "^#supports-color$": "<rootDir>/node_modules/chalk/source/vendor/supports-color/index.js",
       "@utils/(.*)$": "<rootDir>/src/utils/$1",
       "@commands/(.*)$": "<rootDir>/src/commands/$1",
       "@constants/(.*)$": "<rootDir>/src/constants/$1"

src/cli.js

@@ -2,13 +2,17 @@
 // @flow
 import meow from 'meow'
 import updateNotifier from 'update-notifier'
+import { readFileSync } from 'fs'
 
-import pkg from '../package.json'
-import commands from './commands'
 import FLAGS from '@constants/flags'
 import findGitmojiCommand from '@utils/findGitmojiCommand'
+import commands from './commands'
+
+const packageJson: Object = readFileSync(
+  new URL('../package.json', import.meta.url)
+)
 
-updateNotifier({ pkg }).notify({ isGlobal: true })
+updateNotifier({ pkg: JSON.parse(packageJson) }).notify({ isGlobal: true })
 
 const cli = meow(
   `
@@ -28,6 +32,7 @@ const cli = meow(
     $ gitmoji bug linter -s
 `,
   {
+    importMeta: { url: import.meta.url },
     flags: {
       [FLAGS.COMMIT]: { type: 'boolean', alias: 'c' },
       [FLAGS.CONFIG]: { type: 'boolean', alias: 'g' },

src/commands/commit/prompts.js

@@ -1,15 +1,16 @@
 // @flow
 import inquirer from 'inquirer'
+import inquirerAutocompletePrompt from 'inquirer-autocomplete-prompt'
 
 import configurationVault from '@utils/configurationVault'
 import filterGitmojis from '@utils/filterGitmojis'
 import getDefaultCommitContent from '@utils/getDefaultCommitContent'
-import { type CommitOptions } from './index'
+import { type CommitOptions } from '.'
 import guard from './guard'
 
 const TITLE_MAX_LENGTH_COUNT: number = 48
 
-inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'))
+inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt)
 
 export type Gitmoji = {
   code: string,

src/commands/commit/withClient/index.js

@@ -1,5 +1,5 @@
 // @flow
-import execa from 'execa'
+import { execa } from 'execa'
 import fs from 'fs'
 import chalk from 'chalk'
 

src/commands/commit/withHook/index.js

@@ -1,5 +1,5 @@
 // @flow
-import execa from 'execa'
+import { execa } from 'execa'
 import fs from 'fs'
 
 import { type Answers } from '../prompts'

src/commands/config/guard.js

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import isURL from 'validator/lib/isURL'
+import isURL from 'validator/lib/isURL.js'
 
 const errors = {
   url: chalk.red('Enter a valid API URL')

src/utils/configurationVault/getConfiguration.js

@@ -1,6 +1,6 @@
 import Conf from 'conf'
 import { cwd } from 'process'
-import pathExists from 'path-exists'
+import { pathExistsSync } from 'path-exists'
 
 import { CONFIG, EMOJI_COMMIT_FORMATS } from '@constants/configuration'
 
@@ -30,11 +30,11 @@ const getConfiguration = (): { get: Function, set: Function } => {
     const packageJson = `${cwd()}/package.json`
     const configurationFile = `${cwd()}/.gitmojirc.json`
 
-    if (pathExists.sync(packageJson) && require(packageJson)?.gitmoji) {
+    if (pathExistsSync(packageJson) && require(packageJson)?.gitmoji) {
       return require(packageJson).gitmoji
     }
 
-    if (pathExists.sync(configurationFile) && require(configurationFile)) {
+    if (pathExistsSync(configurationFile) && require(configurationFile)) {
       return require(configurationFile)
     }
 

src/utils/emojisCache.js

@@ -2,7 +2,7 @@
 import fs from 'fs'
 import os from 'os'
 import path from 'path'
-import pathExists from 'path-exists'
+import { pathExistsSync } from 'path-exists'
 
 export const GITMOJI_CACHE: Object = {
   FOLDER: '.gitmoji',
@@ -16,7 +16,7 @@ export const CACHE_PATH: string = path.join(
 )
 
 const createEmojis = (emojis: Array<Object>): void => {
-  if (!pathExists.sync(path.dirname(CACHE_PATH))) {
+  if (!pathExistsSync(path.dirname(CACHE_PATH))) {
     fs.mkdirSync(path.dirname(CACHE_PATH))
   }
 
@@ -31,7 +31,7 @@ const getEmojis = (): Array<Object> => {
   }
 }
 
-const isAvailable = (): boolean => pathExists.sync(CACHE_PATH)
+const isAvailable = (): boolean => pathExistsSync(CACHE_PATH)
 
 export default {
   createEmojis,

src/utils/getAbsoluteHooksPath.js

@@ -1,5 +1,5 @@
 // @flow
-import execa from 'execa'
+import { execa } from 'execa'
 import path from 'path'
 
 const getAbsoluteHooksPath = async (hookName: string): Promise<string> => {

src/utils/getDefaultCommitContent.js

@@ -1,7 +1,7 @@
 // @flow
 import fs from 'fs'
 
-import { type CommitOptions } from '@commands/commit/index'
+import { type CommitOptions } from '@commands/commit'
 import COMMIT_MODES from '@constants/commit'
 
 const COMMIT_FILE_PATH_INDEX = 3

test/__snapshots__/cli.spec.js.snap

@@ -58,6 +58,7 @@ exports[`cli should match meow with cli information 1`] = `
           "type": "boolean",
         },
       },
+      "importMeta": "import.meta.url",
     },
   ],
 ]

test/cli.spec.js

@@ -16,6 +16,8 @@ describe('cli', () => {
   })
 
   it('should match meow with cli information', () => {
+    meow.mock.calls[0][1].importMeta = 'import.meta.url'
+
     expect(meow.mock.calls).toMatchSnapshot()
   })
 

test/commands/commit.spec.js

@@ -1,5 +1,5 @@
 import inquirer from 'inquirer'
-import execa from 'execa'
+import { execa } from 'execa'
 import fs from 'fs'
 import chalk from 'chalk'
 const mockProcess = require('jest-mock-process')

test/setupTests.js

@@ -3,6 +3,9 @@ import fetchMock from 'jest-fetch-mock'
 jest.setMock('node-fetch', fetchMock)
 jest.mock('path-exists')
 jest.mock('fs')
+jest
+  .requireMock('fs')
+  .readFileSync.mockImplementation(jest.requireActual('fs').readFileSync)
 jest.mock('ora', () =>
   jest.fn().mockReturnValue({
     start: jest.fn(function () {

test/utils/configurationVault/getConfiguration.spec.js

@@ -1,5 +1,5 @@
 import Conf from 'conf'
-import pathExists from 'path-exists'
+import { pathExistsSync } from 'path-exists'
 
 import { CONFIG, EMOJI_COMMIT_FORMATS } from '@constants/configuration'
 import getConfiguration from '@utils/configurationVault/getConfiguration'
@@ -33,7 +33,7 @@ describe('getConfiguration', () => {
       })
 
       beforeAll(() => {
-        pathExists.sync.mockImplementation((path) => {
+        pathExistsSync.mockImplementation((path) => {
           return path.includes('package.json')
         })
       })
@@ -73,7 +73,7 @@ describe('getConfiguration', () => {
       })
 
       beforeAll(() => {
-        pathExists.sync.mockImplementation((path) => {
+        pathExistsSync.mockImplementation((path) => {
           return path.includes('.gitmojirc.json')
         })
       })
@@ -107,7 +107,7 @@ describe('getConfiguration', () => {
 
     describe('when package.json and .gitmojirc are not available', () => {
       beforeAll(() => {
-        pathExists.sync.mockReturnValue(false)
+        pathExistsSync.mockReturnValue(false)
       })
 
       it('should return local configuration', () => {
@@ -119,7 +119,7 @@ describe('getConfiguration', () => {
 
     describe('when no configuration is available', () => {
       beforeAll(() => {
-        pathExists.sync.mockReturnValue(false)
+        pathExistsSync.mockReturnValue(false)
         Conf().store = undefined
       })
 

test/utils/emojisCache.spec.js

@@ -1,4 +1,4 @@
-import pathExists from 'path-exists'
+import { pathExistsSync } from 'path-exists'
 import fs from 'fs'
 import path from 'path'
 
@@ -25,14 +25,14 @@ describe('emojisCache', () => {
     emojisCache.isAvailable()
 
     it('should check that cache path exists', () => {
-      expect(pathExists.sync).toHaveBeenCalledWith(CACHE_PATH)
+      expect(pathExistsSync).toHaveBeenCalledWith(CACHE_PATH)
     })
   })
 
   describe('createEmojis', () => {
     describe('when cache directory does not exists', () => {
       beforeAll(() => {
-        pathExists.sync.mockReturnValue(false)
+        pathExistsSync.mockReturnValue(false)
         emojisCache.createEmojis(stubs.gitmojis)
       })
 
@@ -50,7 +50,7 @@ describe('emojisCache', () => {
 
     describe('when cache directory exists', () => {
       beforeAll(() => {
-        pathExists.sync.mockReturnValue(true)
+        pathExistsSync.mockReturnValue(true)
         fs.mkdirSync.mockClear()
         fs.writeFileSync.mockClear()
         emojisCache.createEmojis(stubs.gitmojis)

test/utils/getAbsoluteHooksPath.spec.js

@@ -1,4 +1,4 @@
-import execa from 'execa'
+import { execa } from 'execa'
 
 import getAbsoluteHooksPath from '../../src/utils/getAbsoluteHooksPath'
 import * as stubs from './stubs'