Skip to content

Commit 650497b

Browse files
devthejodevthejo
authored
Merge pull request #20 from shinsenter/fix/preserve_instructions
fix: build commands disappeared
2 parents 75b1773 + edaec48 commit 650497b

File tree

6 files changed

+178
-58
lines changed

6 files changed

+178
-58
lines changed

‎src/lib/parseDockerfile.js‎

Lines changed: 86 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -10,75 +10,103 @@ module.exports = function parseDockerfile(content, options = {}) {
1010
...parseOptions,
1111
})
1212
const lines = content.split(/\r?\n/)
13+
14+
// Get 0-based start line index from instruction metadata
15+
// (prefer header fields over lineno)
16+
const getStartLineIndex = (instruction) => {
17+
for (const key of ["lineno", "startLine", "startline", "line"]) {
18+
if (instruction[key]) return instruction[key] - 1
19+
}
20+
return 0
21+
}
22+
23+
// Get raw text from lines[start..end]
24+
const getRaw = (start, end) => lines.slice(start, end + 1).join("\n")
25+
26+
// Check if line starts with instruction
27+
const startsWithInstruction = (line, name) => {
28+
if (!name) return false
29+
const token = (line || "").replace(/^\s+/, "").split(/\s+/, 1)[0]
30+
return token.toUpperCase() === String(name).toUpperCase()
31+
}
32+
33+
// Extract here-doc delimiter token from args
34+
const getHereDocDelimiter = (args) => {
35+
const text = String(args ?? "")
36+
const m = text.match(/<<-?\s*(['"]?)([A-Za-z0-9_]+)\1/)
37+
return m ? m[2] : null
38+
}
39+
40+
// Find the closing line of a here-doc block
41+
const findHereDocClose = (startIndex, delimiter) => {
42+
for (let j = startIndex + 1; j < instructions.length; j++) {
43+
const seg = instructions[j]
44+
const segRaw = seg.raw != null ? String(seg.raw).trim() : ""
45+
if (seg.name === delimiter || segRaw === delimiter) {
46+
return { closeIndex: j, closeLineIdx: getStartLineIndex(seg) }
47+
}
48+
}
49+
return null
50+
}
51+
52+
const results = []
1353
for (let i = 0; i < instructions.length; i++) {
1454
const instruction = instructions[i]
55+
const name = instruction.name.toUpperCase()
1556

16-
// Determine start line (0-based) from available fields; fallback to 0
17-
const startIdx =
18-
(instruction.lineno && instruction.lineno - 1) ||
19-
(instruction.startLine && instruction.startLine - 1) ||
20-
(instruction.startline && instruction.startline - 1) ||
21-
(instruction.line && instruction.line - 1) ||
22-
0
23-
24-
// Determine next instruction start (for fallback end bound)
25-
const next = instructions[i + 1]
26-
const nextStartIdx = next
27-
? (next.lineno && next.lineno - 1) ||
28-
(next.startLine && next.startLine - 1) ||
29-
(next.startline && next.startline - 1) ||
30-
(next.line && next.line - 1) ||
31-
lines.length
32-
: lines.length
33-
34-
// End index: prefer docker-file-parser's lineno (last line of instruction), else before next instruction
35-
const endIdx =
36-
instruction.lineno && Number.isInteger(instruction.lineno)
37-
? instruction.lineno - 1
38-
: Math.max(startIdx, nextStartIdx - 1)
39-
40-
// Recover the true start by scanning upward from endIdx until the header line (instruction keyword) is found
41-
const headerToken = (line) => {
42-
if (!line) return null
43-
const m = line.match(/^\s*([A-Za-z]+)/)
44-
return m ? m[1] : null
45-
}
46-
const startsWithName = (line, name) => {
47-
if (!name) return false
48-
const tok = headerToken(line)
49-
return tok ? tok.toUpperCase() === String(name).toUpperCase() : false
57+
if (
58+
name === "COMMENT" &&
59+
removeSyntaxComments &&
60+
syntaxCommentRegex.test(instruction.args)
61+
) {
62+
// Remove syntax comment
63+
continue
5064
}
5165

52-
let startIdxScan = endIdx
53-
if (instruction.name !== "COMMENT") {
54-
while (
55-
startIdxScan >= 0 &&
56-
!startsWithName(lines[startIdxScan] || "", instruction.name)
57-
) {
58-
startIdxScan--
66+
if (name === "FROM") {
67+
// Normalize "AS" casing but keep args semantics
68+
if (typeof instruction.args === "string") {
69+
instruction.args = instruction.args.replace(/(\s+)as(\s+)/g, "$1AS$2")
5970
}
60-
if (startIdxScan < 0) {
61-
startIdxScan = startIdx
71+
instruction.raw = generateRawInstruction(instruction)
72+
}
73+
74+
// Determine start line (0-based), end line from available fields; fallback to 0
75+
let startIdx = getStartLineIndex(instruction)
76+
const endIdx = startIdx // Default to the same line as the start line
77+
78+
// Find the corresponding start line that really starts with the instruction
79+
if (name !== "COMMENT") {
80+
while (startIdx > 0 && !startsWithInstruction(lines[startIdx], name)) {
81+
startIdx--
6282
}
6383
}
6484

65-
const defaultRaw = lines.slice(startIdxScan, endIdx + 1).join("\n")
85+
// Merge multi-line instructions (RUN, ARG, ENV, etc.)
86+
let closeIndex = i
87+
let closeLineIdx = endIdx
6688

67-
if (instruction.name === "COMMENT") {
68-
if (removeSyntaxComments && syntaxCommentRegex.test(instruction.args)) {
69-
instruction.raw = ""
70-
} else {
71-
// Preserve exact original comment formatting (including indentation)
72-
instruction.raw = defaultRaw
89+
// Check for here-doc in RUN instructions
90+
if (name === "RUN") {
91+
const delimiter = getHereDocDelimiter(instruction.args)
92+
if (delimiter) {
93+
const close = findHereDocClose(i, delimiter)
94+
if (close) {
95+
closeIndex = close.closeIndex
96+
closeLineIdx = close.closeLineIdx
97+
}
7398
}
74-
} else if (instruction.name === "FROM") {
75-
// Normalize "AS" casing but keep args semantics
76-
instruction.args = instruction.args.replace(/(\s+)as(\s+)/gi, "$1AS$2")
77-
instruction.raw = generateRawInstruction(instruction)
78-
} else {
79-
// Preserve exact original formatting for all other instructions (e.g., RUN with continuations/indentation)
80-
instruction.raw = defaultRaw
8199
}
100+
101+
// Update instruction metadata
102+
instruction.lineno = startIdx + 1
103+
instruction.raw = getRaw(startIdx, closeLineIdx)
104+
105+
// Skip merged child instructions (i+1 ... closeIndex)
106+
if (closeIndex > i) i = closeIndex
107+
108+
results.push(instruction)
82109
}
83-
return instructions
110+
111+
return results
84112
}

‎test/__snapshots__/issues/preserve-environment-variables.expected.dockerfile‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# See: https://codeberg.org/devthefuture/dockerfile-x/issues/28
2+
FROM debian:latest
3+
ARG DEBUG
4+
RUN <<'EOF'
5+
DEBIAN_FRONTEND=noninteractive \
6+
DEBCONF_NOWARNINGS=yes \
7+
APT_LISTCHANGES_FRONTEND=none \
8+
apt-get update
9+
EOF

‎test/__snapshots__/issues/preserve-instructions.expected.dockerfile‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# See: https://codeberg.org/devthefuture/dockerfile-x/issues/27
2+
FROM debian:latest
3+
ARG DEBUG
4+
RUN <<'EOF'
5+
[ -z "$DEBUG" ] || set -ex && set -e
6+
if command -v something; then
7+
something \
8+
--arg1 test1 \
9+
--arg2 test2
10+
else
11+
echo "something not found"
12+
fi
13+
EOF
14+
RUN [ -x "/hogehoge" ] \
15+
&& echo "OK" \
16+
|| true
17+
ARG DEBUG1
18+
ENV DEBUG2=1 DEBUG3=2 DEBUG4=3 \
19+
TEST1=1 TEST2=2 TEST3=3 \
20+
TIMEZONE=Asia/Tokyo
21+
RUN <<TEST
22+
[ -z "$DEBUG" ] || set -ex && set -e
23+
if command -v something; then
24+
something \
25+
--arg1 test1 \
26+
--arg2 test2
27+
else
28+
echo "something not found"
29+
fi
30+
TEST

‎test/fixs.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,10 @@ describe("issues", () => {
1616
it("include-target", async () => {
1717
await testFixture("issue1")
1818
})
19+
it("preserve-instructions", async () => {
20+
await testFixture("issue27")
21+
})
22+
it("preserve-environment-variables", async () => {
23+
await testFixture("issue28")
24+
})
1925
})

‎test/fixtures/issue27.dockerfile‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# syntax=devthefuture/dockerfile-x
2+
# See: https://codeberg.org/devthefuture/dockerfile-x/issues/27
3+
FROM debian:latest
4+
ARG DEBUG
5+
6+
RUN <<'EOF'
7+
[ -z "$DEBUG" ] || set -ex && set -e
8+
if command -v something; then
9+
something \
10+
--arg1 test1 \
11+
--arg2 test2
12+
else
13+
echo "something not found"
14+
fi
15+
EOF
16+
17+
RUN [ -x "/hogehoge" ] \
18+
&& echo "OK" \
19+
|| true
20+
21+
ARG DEBUG1
22+
23+
ENV DEBUG2=1 DEBUG3=2 DEBUG4=3 \
24+
TEST1=1 TEST2=2 TEST3=3 \
25+
TIMEZONE=Asia/Tokyo
26+
27+
RUN <<TEST
28+
[ -z "$DEBUG" ] || set -ex && set -e
29+
if command -v something; then
30+
something \
31+
--arg1 test1 \
32+
--arg2 test2
33+
else
34+
echo "something not found"
35+
fi
36+
TEST

‎test/fixtures/issue28.dockerfile‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# syntax=devthefuture/dockerfile-x
2+
# See: https://codeberg.org/devthefuture/dockerfile-x/issues/28
3+
FROM debian:latest
4+
ARG DEBUG
5+
6+
RUN <<'EOF'
7+
DEBIAN_FRONTEND=noninteractive \
8+
DEBCONF_NOWARNINGS=yes \
9+
APT_LISTCHANGES_FRONTEND=none \
10+
apt-get update
11+
EOF

0 commit comments

Comments
 (0)