luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[2.x] Comments in dot files (#8841) (#8847) 

**Problem**
Hash comments doesn't work in dot files.

**Solution**
This reapplies the comment removal sed,
with improved inline comment handling.
This commit is contained in:
eugene yokota 2026-03-01 05:26:58 -05:00 committed by GitHub
parent 38acd80147
commit d4d5e72961
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
launcher-package/integration-test/src/test/scala/RunnerScriptTest.scala
View File

@ -288,11 +288,16 @@ object RunnerScriptTest extends verify.BasicTestSuite with ShellScriptUtil:
// Test for issue #8755: Inline comments should be supported in .jvmopts
testOutput(
"sbt with inline comments in .jvmopts",
jvmoptsFileContents =
"--add-opens=java.base/java.util=ALL-UNNAMED # This is an inline comment\n-Dtest.key=value # Another comment",
jvmoptsFileContents = """--add-opens=java.base/java.util=ALL-UNNAMED # This is an inline comment
|-Dtest.key=value # Another comment
|-Dtest.key2=file:/log4j2#prod.xml""".stripMargin,
windowsSupport = false,
)("-v"): (out: List[String]) =>
// Verify that options are present (comments should be stripped)
assert(
!out.contains[String]("#"),
"Comments are stripped out"
)
assert(
out.contains[String]("--add-opens=java.base/java.util=ALL-UNNAMED"),
"Option with inline comment should be parsed correctly"
@ -301,6 +306,10 @@ object RunnerScriptTest extends verify.BasicTestSuite with ShellScriptUtil:
out.contains[String]("-Dtest.key=value"),
"System property with inline comment should be parsed correctly"
)
assert(
out.contains[String]("-Dtest.key2=file:/log4j2#prod.xml"),
"System property with inline comment should be parsed correctly"
)
// Verify comments themselves are NOT present as separate arguments
assert(
!out.exists(_.contains("This is an inline comment")),

2
sbt
View File

@ -772,7 +772,7 @@ process_args () {
loadConfigFile() {
# Make sure the last line is read even if it doesn't have a terminating \n
# Output lines literally without shell expansion to handle special characters safely
cat "$1" | sed $'/^\#/d;s/\r$//' | while read -r line || [[ -n "$line" ]]; do
cat "$1" | sed $'/^\#/d;s/[[:space:]]\{1,\}#.*//;s/\r$//' | while read -r line || [[ -n "$line" ]]; do
# Use printf with properly quoted variable to prevent shell expansion
# This safely handles special characters like |, *, &, etc.
printf '%s\n' "$line"