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

[mickdekkers]

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:

cz-cli/src/commitizen/adapter.js

Lines 35 to 41 in d5e2424

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

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
     } 
   } 
 }; 

[LinusU]

Yeah, I found this to be quite confusing myself, PR welcome 👍

[jimthedev]

This change would be breaking. With that said I think we can support this by first checking if the path exists and if not then we see if the npm module exists in either the deps or dev deps. If it does then we can install it as a transient dependency first before running commit.

@mickdekkers @LinusU Does that sound right?

[mickdekkers]

@jimthedev sounds interesting, what do you mean by "install it as a transient dependency"?

[jimthedev]

@mickdekkers I mean we would run npm install --no-save cz-my-adapter@1.2.3. Effectively we would detect that the npm install hasn't been run yet and would install module. This ensures that the package.json and package lock is not touched but that commitizen could run.

One tricky thing is that npm changed from --save being implied at a certain version of npm so we might have to detect their npm version.

[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?

cz-cli/src/commitizen/adapter.js

Line 38 in 07b92bc

path: `./node_modules/${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.