Consider using npm module name instead of relative path in adapter config generated by commitizen init

The setup instructions in the readme use the module name of the adapter (i.e. cz-conventional-changelog), but the actual config generated by commitizen init uses a relative path to the module:

https://github.com/commitizen/cz-cli/blob/d5e24245dda078464d8c964f5d052bcad1da14f5/src/commitizen/adapter.js#L35-L41

According to the readme:

commitizen.path is resolved via require.resolve and supports

• npm modules
• directories relative to process.cwd() containing an index.js file
• file base names relative to process.cwd() with js extension
• full relative file names
• absolute paths.

One downside of using a relative path is that developers cannot use their global commitizen install to create a commit if they have not yet run npm install in the repo, because this results in an error:

Error: Could not resolve /Users/mickdekkers/Projects/foo/node_modules/cz-conventional-changelog.
Cannot find module '/Users/mickdekkers/Projects/foo/node_modules/cz-conventional-changelog'

This change should fix the issue, although I’m not sure whether it would be considered breaking:

let commitizenAdapterConfig = { 
   config: { 
     commitizen: { 
-      path: `./node_modules/${adapterNpmName}`
+      path: adapterNpmName
     } 
   } 
 }; 

[mickdekkers]

@LinusU yeah, that’s my proposed solution. I think you may be right; since it only applies to initialization and doesn’t affect existing projects, it shouldn’t be a breaking change.

[LinusU]

We are only talking about the generated config here, right? So I’m not sure if it would be considered breaking?

I also don’t think we would need to install any dependencies automatically? Although that would potentially also be nice!

edit:

We are only talking about changing this line, right?

https://github.com/commitizen/cz-cli/blob/07b92bcc9f1e82fcbd8226184ded771762af86da/src/commitizen/adapter.js#L38