feat: support esm format configs (#120)

JounQin · web-flow · commit fc2acfc92830 · 2025-03-20T23:12:25.000+08:00
diff --git a/.changeset/selfish-owls-collect.md b/.changeset/selfish-owls-collect.md
@@ -0,0 +1,5 @@
+---
+"simple-git-hooks": minor
+---
+
+feat: support esm format configs
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -8,5 +8,13 @@ module.exports = {
     "extends": "eslint:recommended",
     "parserOptions": {
         "ecmaVersion": 12
-    }
+    },
+    "overrides": [
+        {
+            "files": ["*.mjs"],
+            "parserOptions": {
+                "sourceType": "module"
+            }
+        }
+    ]
 };
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -39,7 +39,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -16,6 +16,7 @@ jobs:
     - name: Lint
       uses: actions/setup-node@v4
       with:
-        node-version: 14.x
-    - run: yarn --frozen-lockfile
+        node-version: 18.x
+        cache: yarn
+    - run: yarn --frozen-lockfile --ignore-engines
     - run: yarn lint
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -16,6 +16,7 @@ jobs:
     - name: Lint
       uses: actions/setup-node@v4
       with:
-        node-version: 14.x
-    - run: yarn --frozen-lockfile
+        node-version: 18.x
+        cache: yarn
+    - run: yarn --frozen-lockfile --ignore-engines
     - run: yarn test
diff --git a/README.md b/README.md
@@ -120,11 +120,13 @@ Note that you should manually run `npx simple-git-hooks` **every time you change
 
 ### Additional configuration options
 
-You can also add a `.simple-git-hooks.cjs`, `.simple-git-hooks.js`, `simple-git-hooks.cjs`, `simple-git-hooks.js`, `.simple-git-hooks.json` or `simple-git-hooks.json` file to the project and write the configuration inside it.
+You can also add a `.simple-git-hooks.cjs`, `.simple-git-hooks.js`, `.simple-git-hooks.mjs`, `simple-git-hooks.cjs`, `simple-git-hooks.js`, `simple-git-hooks.mjs`, `.simple-git-hooks.json` or `simple-git-hooks.json` file to the project and write the configuration inside it.
 
 This way `simple-git-hooks` configuration in `package.json` will not take effect any more.
 
-`.simple-git-hooks.cjs`, `.simple-git-hooks.js` or `simple-git-hooks.cjs`, `simple-git-hooks.js` should look like the following.
+`.simple-git-hooks.cjs`, `.simple-git-hooks.js`, `.simple-git-hooks.mjs` or `simple-git-hooks.cjs`, `simple-git-hooks.js`, `simple-git-hooks.mjs` should look like the following.
+
+#### CommonJS
 
 ```js
 module.exports = {
@@ -133,6 +135,16 @@ module.exports = {
 };
 ```
 
+
+#### ES Modules
+
+```js
+export default {
+  "pre-commit": "npx lint-staged",
+  "pre-push": "npm run format",
+};
+```
+
 `.simple-git-hooks.json` or `simple-git-hooks.json` should look like the following.
 
 ```json
diff --git a/_tests/project_with_configuration_in_alternative_separate_cjs/package.json b/_tests/project_with_configuration_in_alternative_separate_cjs/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-alternative-cjs",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_alternative_separate_js/package.json b/_tests/project_with_configuration_in_alternative_separate_js/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-alternative-js",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_alternative_separate_json/package.json b/_tests/project_with_configuration_in_alternative_separate_json/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-alternative-json",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_alternative_separate_mjs/.simple-git-hooks.mjs b/_tests/project_with_configuration_in_alternative_separate_mjs/.simple-git-hooks.mjs
@@ -0,0 +1,4 @@
+export default {
+  "pre-push": "exit 1",
+  "pre-commit": "exit 1"
+}
diff --git a/_tests/project_with_configuration_in_alternative_separate_mjs/package.json b/_tests/project_with_configuration_in_alternative_separate_mjs/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "simple-git-hooks-test-package-alternative-mjs",
+  "version": "1.0.0",
+  "devDependencies": {
+    "simple-git-hooks": "1.0.0"
+  }
+}
diff --git a/_tests/project_with_configuration_in_package_json/package.json b/_tests/project_with_configuration_in_package_json/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-pkg-json",
   "version": "1.0.0",
   "simple-git-hooks": {
     "pre-commit": "exit 1"
diff --git a/_tests/project_with_configuration_in_separate_cjs/package.json b/_tests/project_with_configuration_in_separate_cjs/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-cjs",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_separate_js/package.json b/_tests/project_with_configuration_in_separate_js/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-js",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_separate_json/package.json b/_tests/project_with_configuration_in_separate_json/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-json",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_configuration_in_separate_mjs/package.json b/_tests/project_with_configuration_in_separate_mjs/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "simple-git-hooks-test-package-mjs",
+  "version": "1.0.0",
+  "devDependencies": {
+    "simple-git-hooks": "1.0.0"
+  }
+}
diff --git a/_tests/project_with_configuration_in_separate_mjs/simple-git-hooks.mjs b/_tests/project_with_configuration_in_separate_mjs/simple-git-hooks.mjs
@@ -0,0 +1,4 @@
+export default {
+  "pre-push": "exit 1",
+  "pre-commit": "exit 1"
+}
diff --git a/_tests/project_with_custom_configuration/package.json b/_tests/project_with_custom_configuration/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-custom",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_incorrect_configuration_in_package_json/package.json b/_tests/project_with_incorrect_configuration_in_package_json/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-incorrect",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_simple_git_hooks_in_deps/package.json b/_tests/project_with_simple_git_hooks_in_deps/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-deps",
   "version": "1.0.0",
   "dependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_simple_git_hooks_in_dev_deps/package.json b/_tests/project_with_simple_git_hooks_in_dev_deps/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-dev-deps",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_with_unused_configuration_in_package_json/package.json b/_tests/project_with_unused_configuration_in_package_json/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-unused",
   "version": "1.0.0",
   "simple-git-hooks": {
     "pre-commit": "exit 1",
diff --git a/_tests/project_without_configuration/package.json b/_tests/project_without_configuration/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-without-config",
   "version": "1.0.0",
   "devDependencies": {
     "simple-git-hooks": "1.0.0"
diff --git a/_tests/project_without_simple_git_hooks/package.json b/_tests/project_without_simple_git_hooks/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "simple-git-hooks-test-package",
+  "name": "simple-git-hooks-test-package-without",
   "version": "1.0.0",
   "devDependencies": {
   },
diff --git a/cli.js b/cli.js
@@ -13,9 +13,6 @@ if (['1', 'true'].includes(SKIP_INSTALL_SIMPLE_GIT_HOOKS)) {
     return
 }
 
-try {
-    setHooksFromConfig(process.cwd(), process.argv)
-    console.log('[INFO] Successfully set all git hooks')
-} catch (e) {
-    console.log('[ERROR], Was not able to set git hooks. Error: ' + e)
-}
+setHooksFromConfig(process.cwd(), process.argv)
+    .then(() => console.log('[INFO] Successfully set all git hooks'))
+    .catch(e => console.log('[ERROR], Was not able to set git hooks. Error: ' + e))
diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
   "name": "simple-git-hooks",
+  "type": "commonjs",
   "version": "2.11.1",
   "description": "A simple, zero dependency tool for setting up git hooks for small projects",
   "author": "Mikhail Gorbunov <toplenboren@gmail.com>",
@@ -15,7 +16,7 @@
   "scripts": {
     "postinstall": "node ./postinstall.js",
     "lint": "eslint *.js",
-    "test": "jest",
+    "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
     "release": "clean-pkg-json && changeset publish",
     "uninstall": "node ./uninstall.js"
   },
diff --git a/postinstall.js b/postinstall.js
@@ -6,7 +6,7 @@ const {checkSimpleGitHooksInDependencies, getProjectRootDirectoryFromNodeModules
 /**
  * Creates the pre-commit from command in config by default
  */
-function postinstall() {
+async function postinstall() {
     let projectDirectory;
 
     /* When script is run after install, the process.cwd() would be like <project_folder>/node_modules/simple-git-hooks
@@ -21,7 +21,7 @@ function postinstall() {
 
     if (checkSimpleGitHooksInDependencies(projectDirectory)) {
         try {
-            setHooksFromConfig(projectDirectory)
+            await setHooksFromConfig(projectDirectory)
         } catch (err) {
             console.log('[ERROR] Was not able to set git hooks. Reason: ' + err)
         }
diff --git a/simple-git-hooks.js b/simple-git-hooks.js
@@ -1,5 +1,6 @@
 const fs = require('fs')
 const path = require('path')
+const url = require('url')
 
 const VALID_GIT_HOOKS = [
     'applypatch-msg',
@@ -158,12 +159,12 @@ function checkSimpleGitHooksInDependencies(projectRootPath) {
  * @param {string} projectRootPath
  * @param {string[]} [argv]
  */
-function setHooksFromConfig(projectRootPath=process.cwd(), argv=process.argv) {
+async function setHooksFromConfig(projectRootPath=process.cwd(), argv=process.argv) {
     const customConfigPath = _getCustomConfigPath(argv)
-    const config = _getConfig(projectRootPath, customConfigPath)
+    const config = await _getConfig(projectRootPath, customConfigPath)
 
     if (!config) {
-        throw('[ERROR] Config was not found! Please add `.simple-git-hooks.js` or `simple-git-hooks.js` or `.simple-git-hooks.json` or `simple-git-hooks.json` or `simple-git-hooks` entry in package.json.\r\nCheck README for details')
+        throw('[ERROR] Config was not found! Please add `.simple-git-hooks.cjs` or `.simple-git-hooks.js` or `.simple-git-hooks.mjs` or `simple-git-hooks.cjs` or `simple-git-hooks.js` or `simple-git-hooks.mjs` or `.simple-git-hooks.json` or `simple-git-hooks.json` or `simple-git-hooks` entry in package.json.\r\nCheck README for details')
     }
 
     const preserveUnused = Array.isArray(config.preserveUnused) ? config.preserveUnused : config.preserveUnused ? VALID_GIT_HOOKS: []
@@ -274,10 +275,10 @@ function _getCustomConfigPath(argv=[]) {
  * @param {string} projectRootPath
  * @param {string} [configFileName]
  * @throws TypeError if projectRootPath is not string
- * @return {{string: string} | undefined}
+ * @return {Promise<{[key: string]: unknown} | undefined>}
  * @private
  */
-function _getConfig(projectRootPath, configFileName='') {
+async function _getConfig(projectRootPath, configFileName='') {
     if (typeof projectRootPath !== 'string') {
         throw TypeError("Check project root path! Expected a string, but got " + typeof projectRootPath)
     }
@@ -286,8 +287,10 @@ function _getConfig(projectRootPath, configFileName='') {
     const sources = [
         () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.cjs'),
         () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.js'),
+        () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.mjs'),
         () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.cjs'),
         () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.js'),
+        () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.mjs'),
         () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.json'),
         () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.json'),
         () => _getConfigFromPackageJson(projectRootPath),
@@ -299,11 +302,12 @@ function _getConfig(projectRootPath, configFileName='') {
     }
 
     for (let executeSource of sources) {
-        let config = executeSource()
-        if (config && _validateHooks(config)) {
-            return config
-        }
-        else if (config && !_validateHooks(config)) {
+        let config = await executeSource()
+        if (config) {
+            if (_validateHooks(config)) {
+                return config
+            }
+
             throw('[ERROR] Config was not in correct format. Please check git hooks or options name')
         }
     }
@@ -316,22 +320,22 @@ function _getConfig(projectRootPath, configFileName='') {
  * @param {string} projectRootPath
  * @throws TypeError if packageJsonPath is not a string
  * @throws Error if package.json couldn't be read or was not validated
- * @return {{string: string} | undefined}
+ * @return {Promise<{[key: string]: unknown}> | {[key: string]: unknown} | undefined}
  */
 function _getConfigFromPackageJson(projectRootPath = process.cwd()) {
     const {packageJsonContent} = _getPackageJson(projectRootPath)
     const config = packageJsonContent['simple-git-hooks'];
-    return typeof config === 'string' ? _getConfig(config) : packageJsonContent['simple-git-hooks']
+    return typeof config === 'string' ? _getConfig(config) : config
 }
 
 /**
  * Gets user-set config from file
  * Since the file is not required in node.js projects it returns undefined if something is off
  * @param {string} projectRootPath
  * @param {string} fileName
- * @return {{string: string} | undefined}
+ * @return {Promise<{[key: string]: unknown} | undefined>}
  */
-function _getConfigFromFile(projectRootPath, fileName) {
+async function _getConfigFromFile(projectRootPath, fileName) {
     if (typeof projectRootPath !== "string") {
         throw TypeError("projectRootPath is not a string")
     }
@@ -347,7 +351,12 @@ function _getConfigFromFile(projectRootPath, fileName) {
         if (filePath === __filename) {
             return undefined
         }
-        return require(filePath) // handle `.js` and `.json`
+        // handle `.json` with `require`, `import()` requires `with:{type:'json'}` which does not work for all engines
+        if (filePath.endsWith('.json')) {
+            return require(filePath)
+        }
+        const result =  await import(url.pathToFileURL(filePath)) // handle `.cjs`, `.js`, `.mjs`
+        return result.default || result
     } catch (err) {
         return undefined
     }
diff --git a/simple-git-hooks.test.js b/simple-git-hooks.test.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"simple-git-hooks": minor
 +---
++
 +feat: support esm format configs
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "simple-git-hooks-test-package",`
	`2`	`+ "name": "simple-git-hooks-test-package-alternative-cjs",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"devDependencies": {`
`5`	`5`	`"simple-git-hooks": "1.0.0"`