Ignore comments within String constants

Open

#81 opened on Jan 5, 2024 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 3/5
Estimated time: 1-2 days
Newbie friendliness: 45/100

Issue type: Bug
Clarity: Mostly clear
Activity status: Stale
Tech stack: java, kotlin
Domain: testing

Research direction

Start with CommentTracker.kt lines 51-54 and SourceFile.kt lines 83-87, then reproduce the Java text-block example where // selfieonce appears inside a string constant. Trace how comments are recognized and verify that comment-like text within string constants is not treated as a comment or forbidden snapshot value.

Written by the indexing model from the issue text.

Description

bug

This code is too simple.

https://github.com/diffplug/selfie/blob/6c3d0ee489152ff87aff5251b05e75314491ad3c/selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/guts/CommentTracker.kt#L51-L54

https://github.com/diffplug/selfie/blob/6c3d0ee489152ff87aff5251b05e75314491ad3c/selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/guts/SourceFile.kt#L83-L87

For example:

class Test {
  @Test public void example() {
    expectSelfie("underTest").toBe("""
This is a string constant
// selfieonce
The comment above is not really a comment.
We effectively have a "forbidden value" that can't be inside inline snapshots.
     """)
  }
}

Dominant language: Kotlin
Stars: 101
Forks: 18
Avg merge: 6d 11h
Merged PRs (30d): 5

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

TOML `rename` is not applied to a type inside `Box<T>` (Swift, Kotlin, Python) Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

mozilla/uniffi-rs#3006 · Opened Sep 23, 2026
2 rename bugs Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

yairm210/Unciv#15634 · 1 comment · Opened Sep 23, 2026
Hide camera-based functionality if the device does not have a camera Open

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

ankidroid/Anki-Android#21999 · Opened Sep 22, 2026
libzkp.so in jniLibs/x86_64 is a 32-bit ELF binary instead of 64-bit Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

openwallet-foundation/multipaz#2028 · Opened Sep 22, 2026
Make tombstone merge timestamp threshold configurable Open

Improvement Java Platform: Java

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

getsentry/sentry-java#6145 · 1 comment · Opened Sep 22, 2026

More Kotlin issues