fix: prefix in .npmrc error log

[rahulio96]

Summary

The original issue (#6081) wanted the project's .npmrc to set a prefix value for npm to use in both npm prefix and npm install <package> However, we made the changes according to wraithgar's comment.

Currently, when running npm prefix or npm install, there is no error logged communicating to the user that prefix cannot be changed in the project config.

This solution gives the error message more clarity to make debugging easier and lets the user know that prefix cannot be changed from the project level.

Also added the accompanying tap test to ensure the expected error is outputted.

PLEASE NOTE:

If prefix is set to a value, the error will be logged anytime a user enters in a npm or npx command, which means that the logging is not specific to just npm prefix or npm install <package>, but also applies to commands such as npm exec.

Testing

Reproduce Original Issue:

1. Add .npmrc file into your project’s directory
2. Set prefix to some location e.g. prefix=./vendor
3. Run npm prefix or npm install <package>
4. npm prefix will give the current directory’s prefix, and npm install <package> will install the package in the current directory.
5. No error would be logged to tell user that prefix cannot be changed from project level

File tap test:

• Enter in terminal:
• TAP_SNAPSHOT=1 node . run test workspaces/config/test/index.js

Run the entire tap test:

• Enter in terminal:
• node . run test

Dummy Project Test:

• Made a dummy project with a vendor folder and a .npmrc file with prefix=./vendor
• Used aliasing to see if the error is being logged:
• Enter in terminal:
• alias localnpm="node /workspaces/cli/"
• localnpm prefix
• localnpm install <package>

References

Fixes #6081

[wraithgar]

Suggested change

	if (type === 'project') {
	const parsedConfigPrefix = parsedConfig.prefix
	// Log error if prefix is mentioned in project .npmrc
	if (parsedConfigPrefix) {
	log.error(`prefix=${parsedConfigPrefix} cannot be changed from project config: ${file}`)
	}
	}
	return this.#loadObject(parsedConfig, type, file)
	},
	if (type === 'project' && parsedConfig.prefix) {
	// Log error if prefix is mentioned in project .npmrc
	log.error('config', `prefix=${parsedConfigPrefix} cannot be changed from project config: ${file}.`)
	}
	return this.#loadObject(parsedConfig, type, file)
	},

We don't need to cast a whole new variable for one if statement, just assess it in place.

[wraithgar]

Also added the logging prefix to the log output

[rahulio96]

However, parsedConfigPrefix is also used for the logged error, would you still prefer if we got rid of it?

[wraithgar]

Yeah that's one lest instance where we're logging user input which is always a good thing to avoid.

[wraithgar]

I had originally removed it and added it back at the last second, I should have trusted my first instinct.

[rahulio96]

Ok, are you suggesting that we change the log error to be:
log.error('config', `prefix cannot be changed from project config: ${file}.`)

Or are you suggesting this?
log.error('config', `prefix=${parsedConfig.prefix} cannot be changed from project config: ${file}.`)

[wraithgar]

log.error('config', `prefix cannot be changed from project config: ${file}.`)

[rahulio96]

Got it, appreciate the response.

[wraithgar]

Adding config to that logging statement changed the shape of the array in the test. Update the test to expect the new format and this should be good to ship

[rahulio96]

Yeah just noticed that too, thanks!

[wraithgar]

This is very helpful thank you.

[rahulio96]

No problem, hope it helps.