fix: don't remove comments between key and value in object-shorthand

[KubaJastrz]

Fixes #18441

Prerequisites checklist

• I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Check for comments between the last key token and the value in the property node.

Is there anything you'd like reviewers to focus on?

[netlify]

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	58fe097
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/66462f0d22ffbe000822cf3b

[Tanujkanti4441]

how about if we give a fix here through appending the comment before or after the property something like:

var x = {
a /* comment */: a,
b
}

can be fixed to

var x = {
/* comment */ a,
b
}

or

var x = {
a, /* comment */ 
b
}

[KubaJastrz]

I think in that case it becomes a feature request, not a bug fix. You can create an issue for this idea.

Whatever the decision is, I'd recommend that both identifiers and function expressions were handled identically (which they aren't right now, hence this PR).

[mdjermanovic]

I think it's fine not to provide the fix when there's a comment between the two identifiers and let the author fix this manually as it isn't clear where the new position for the comment should be.

[mdjermanovic]

Suggested change

	const lastKeyToken = sourceCode.getLastToken(node.key);
	// x: /* */ x
	if (sourceCode.commentsExistBetween(lastKeyToken, node.value)) {
	return null;
	}
	// x: /* */ x
	if (sourceCode.commentsExistBetween(node.key, node.value)) {
	return null;
	}

We can use node.key directly.

[KubaJastrz]

d5c6fe1

[mdjermanovic]

Suggested change

	const lastKeyToken = sourceCode.getLastToken(node.key);
	// "x": /* */ x
	if (sourceCode.commentsExistBetween(lastKeyToken, node.value)) {
	return null;
	}
	// "x": /* */ x
	if (sourceCode.commentsExistBetween(node.key, node.value)) {
	return null;
	}

Same here.

[KubaJastrz]

d5c6fe1

[aladdin-add]

LGTM, thanks!

[mdjermanovic]

Just noticed an edge case that wasn't covered (see the new test cases).

[mdjermanovic]

Suggested change

	if (sourceCode.commentsExistBetween(node.key, node.value)) {
	if (sourceCode.getCommentsInside(node).length > 0) {

Since we're replacing the entire node with just an identifier name, seems best to check if there are comments anywhere inside the node.

[KubaJastrz]

58fe097

[mdjermanovic]

Suggested change

	if (sourceCode.commentsExistBetween(node.key, node.value)) {
	if (sourceCode.getCommentsInside(node).length > 0) {

Same here.

[KubaJastrz]

58fe097

[mdjermanovic]

LGTM, thanks!