commitizen / commitizen/cz-cli

Unable to execute commitizen from within nested directory inside the repository

Open
#742 4 comments 2 reactions 1 assignee Claimed by @dmwelch View on GitHub
bug help / pr wanted
Dominant language
JavaScript
Stars
17.5k
Forks
566
Avg merge
8h 16m
Merged PRs (30d)
1

Description

In my setup, the git repository is placed in `/home/user/Code/namespace/prj-name/`, but all the CI/CD code is placed in `/home/user/Code/namespace/prj-name/cx` (in part, because it is not a JS project, and I want to "simplify" the directories/files structure at the root of the project).

Before that, I had everything in the project root, and it was running fine, but I'm in the middle of a refactoring process for the build system, hence the change.

Husky seems to adapt pretty well to this setup (I even checked the generated shell scripts inside `.git/hooks`, and it takes care of changing directory before running the hooks).

But... `commitizen` fails to do the same, and it insists on trying to load the modules from the "root" of the project, even if I set the `$NODE_PATH` environment variable to point the `/home/user/Code/namespace/prj-name/cx` directory (where `$PWD` points too, due to how Husky works).

Here you can see the error message, sadly it does not show the involved line numbers, and I couldn't follow the "jump" from `dist/commitizen.js` to `dist/commitizen/adapter.js`:
```
> @namespace/prj-name@0.0.1 git-cz /home/user/Code/namespace/prj-name/cx
> git-cz "--hook"

Could not resolve /home/user/Code/namespace/prj-name/node_modules/cz-conventional-changelog. Cannot find module '/home/user/Code/namespace/prj-name/node_modules/cz-conventional-changelog'
Require stack:
- /home/user/Code/namespace/prj-name/cx/node_modules/commitizen/dist/commitizen/adapter.js
- /home/user/Code/namespace/prj-name/cx/node_modules/commitizen/dist/commitizen.js
- /home/user/Code/namespace/prj-name/cx/node_modules/commitizen/dist/cli/git-cz.js
- /home/user/Code/namespace/prj-name/cx/node_modules/commitizen/bin/git-cz.js
- /home/user/Code/namespace/prj-name/cx/node_modules/commitizen/bin/git-cz
```

Here a simplified version of my `package.json` file (also in the `cx` directory):
```json
{
"name": "@namespace/prj-name",
"version": "0.0.1",
"description": "Project Name",
"scripts": {
"commitlint": "commitlint",
"git-cz": "git-cz"
},
"dependencies": {
"@commitlint/cli": "^8.3.5",
"@commitlint/config-conventional": "^8.3.4",
"commitizen": "^4.1.2",
"cz-conventional-changelog": "^3.2.0",
"husky": "^4.2.5"
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
],
"rules": {
"header-min-length": [2, "always", 8],
"header-max-length": [2, "always", 72],
"subject-min-length": [2, "always", 3],
"subject-max-length": [2, "always", 50],
"body-max-line-length": [2, "always", 80]
}
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"husky": {
"hooks": {
"prepare-commit-msg": "exec < /dev/tty && npm run git-cz -- --hook || true",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}
```

Is there any configuration option (or environment variable) I can use to tell commitizen how to behave?

Thanks for your attention.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.