remove multiline comment support, add requirement that project has to be first, manifest last

Author: KristofferC

base/loading.jl

@@ -258,88 +258,80 @@ end
 
 
 function extract_inline_section(path::String, type::Symbol)
-    buf = IOBuffer()
-    start_fence = "#!$type begin"
-    end_fence = "#!$type end"
+    # Read all lines
+    lines = readlines(path)
+
+    # For manifest, read backwards by reversing the lines
+    if type === :manifest
+        lines = reverse(lines)
+        start_marker = "#!manifest end"
+        end_marker = "#!manifest begin"
+        section_name = "manifest"
+        position_error = "must come last"
+    else
+        start_marker = "#!project begin"
+        end_marker = "#!project end"
+        section_name = "project"
+        position_error = "must come first"
+    end
+
     state = :none
-    multiline_mode = false
-    in_multiline = false
+    at_start = true
+    content_lines = String[]
 
-    for (lineno, line) in enumerate(eachline(path))
+    for (lineno, line) in enumerate(lines)
         stripped = lstrip(line)
-        state == :done && break
 
-        if startswith(stripped, start_fence)
-            state = :reading_first
+        # Skip empty lines and comments (including shebang) before content
+        if at_start && (isempty(stripped) || startswith(stripped, '#'))
+            if startswith(stripped, start_marker)
+                state = :reading
+                at_start = false
+                continue
+            end
             continue
-        elseif startswith(stripped, end_fence)
-            state = :done
+        end
+
+        # Found start marker after content - error
+        if startswith(stripped, start_marker)
+            if !at_start
+                error("#!$section_name section $position_error in $path")
+            end
+            state = :reading
+            at_start = false
             continue
-        elseif state === :reading_first
-            # First line determines the format
-            if startswith(stripped, "#=")
-                multiline_mode = true
-                state = :reading
-                # Check if the opening #= and closing =# are on the same line
-                if endswith(rstrip(stripped), "=#")
-                    # Single-line multi-line comment
-                    content = rstrip(stripped)[3:end-2]
-                    write(buf, content)
-                    in_multiline = false
-                else
-                    # Multi-line comment continues
-                    in_multiline = true
-                    content = stripped[3:end]  # Remove #= from start
-                    write(buf, content)
-                    write(buf, '\n')
-                end
+        end
+
+        at_start = false
+
+        # Found end marker
+        if startswith(stripped, end_marker) && state === :reading
+            state = :done
+            break
+        end
+
+        # Extract content
+        if state === :reading
+            if startswith(stripped, '#')
+                toml_line = lstrip(chop(stripped, head=1, tail=0))
+                push!(content_lines, toml_line)
             else
-                # Line-by-line format
-                multiline_mode = false
-                state = :reading
-                # Process this first line
-                if startswith(stripped, '#')
-                    toml_line = lstrip(chop(stripped, head=1, tail=0))
-                    write(buf, toml_line)
-                else
-                    write(buf, line)
-                end
-                write(buf, '\n')
+                push!(content_lines, line)
             end
-        elseif state === :reading
-            if multiline_mode && in_multiline
-                # In multi-line comment mode, look for closing =#
-                if endswith(rstrip(stripped), "=#")
-                    # Found closing delimiter
-                    content = rstrip(stripped)[1:end-2]  # Remove =# from end
-                    write(buf, content)
-                    in_multiline = false
-                else
-                    # Still inside multi-line comment
-                    write(buf, line)
-                    write(buf, '\n')
-                end
-            elseif !multiline_mode
-                # Line-by-line comment mode, strip # from each line
-                if startswith(stripped, '#')
-                    toml_line = lstrip(chop(stripped, head=1, tail=0))
-                    write(buf, toml_line)
-                else
-                    write(buf, line)
-                end
-                write(buf, '\n')
-            end
-            # If multiline_mode && !in_multiline, the multiline comment has ended.
-            # Don't accumulate any more content; just wait for the end fence.
         end
     end
 
+    # For manifest, reverse the content back to original order
+    if type === :manifest && !isempty(content_lines)
+        content_lines = reverse(content_lines)
+    end
+
     if state === :done
-        return strip(String(take!(buf)))
+        return strip(join(content_lines, '\n'))
     elseif state === :none
         return ""
     else
-        error("incomplete inline $type block in $path (missing #!$type end)")
+        error("incomplete inline $section_name block in $path (missing #!$section_name end)")
     end
 end
 

doc/src/manual/code-loading.md

@@ -410,31 +410,18 @@ Julia also understands *portable scripts*: scripts that embed their own `Project
 # Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 #!project end
 
+using Markdown
+println(md"# Hello, single-file world!")
+
 #!manifest begin
 # [[deps]]
 # name = "Markdown"
 # uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
 # version = "1.0.0"
 #!manifest end
-
-using Markdown
-println(md"# Hello, single-file world!")
-```
-
-Lines inside the fenced blocks may either start with `#` (as in the example), be plain TOML, or be wrapped in multi-line comment delimiters `#= ... =#`:
-
-```julia
-#!project begin
-#=
-name = "HelloApp"
-uuid = "9c5fa7d8-7220-48e8-b2f7-0042191c5f6d"
-version = "0.1.0"
-[deps]
-Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
-=#
-#!project end
 ```
 
+Lines inside the fenced blocks should be commented with `#` (as in the example) or be plain TOML lines. The `#!project` section must come first in the file (after an optional shebang and empty lines). If a `#!manifest` section is present, it must come after the `#!project` section, and no Julia code is allowed after the `#!manifest end` delimiter.
 
 Running `julia hello.jl` automatically activates the embedded project. The script path becomes the active project entry in `LOAD_PATH`, so package loading works exactly as if `Project.toml` and `Manifest.toml` lived next to the script. The `--project=@script` flag also expands to the script itself when no on-disk project exists but inline metadata is present.
 

test/loading.jl

@@ -1885,16 +1885,6 @@ module M58272_to end
     @test occursin("Portable Script Tests", output)
     @test occursin("Pass", output)
 
-    # Test with multiline comment syntax
-    portable_script_ml = joinpath(@__DIR__, "project", "portable_script_multiline.jl")
-    output_ml = read(`$(Base.julia_cmd()) --startup-file=no $portable_script_ml`, String)
-
-    @test occursin("Active project: $portable_script_ml", output_ml)
-    @test occursin("Active manifest: $portable_script_ml", output_ml)
-    @test occursin("✓ Portable script with multiline comment syntax works!", output_ml)
-    @test occursin("✓ Random.rand()", output_ml)
-    @test occursin("✓ All checks passed!", output_ml)
-
     # Test with custom manifest= entry in project section
     portable_script_cm = joinpath(@__DIR__, "project", "portable_script_custom_manifest.jl")
     output_cm = read(`$(Base.julia_cmd()) --startup-file=no $portable_script_cm`, String)
@@ -1912,4 +1902,47 @@ module M58272_to end
     @test occursin("Active project: $portable_script", output_script)
     @test occursin("Active manifest: $portable_script", output_script)
     @test occursin("✓ Random (stdlib) loaded successfully", output_script)
+
+    # Test that regular Julia files (without inline sections) work fine as projects
+    regular_script = joinpath(@__DIR__, "project", "regular_script.jl")
+
+    # Running the script with --project= should set it as active project
+    output = read(`$(Base.julia_cmd()) --startup-file=no --project=$regular_script $regular_script`, String)
+    @test occursin("ACTIVE_PROJECT: $regular_script", output)
+    @test occursin("Hello from regular script", output)
+    @test occursin("x = 42", output)
+
+    # Running the script without --project should NOT set it as active project
+    output = read(`$(Base.julia_cmd()) --startup-file=no $regular_script`, String)
+    @test !occursin("ACTIVE_PROJECT: $regular_script", output)
+    @test occursin("Hello from regular script", output)
+    @test occursin("x = 42", output)
+
+    # Test 1: Project section not first (has code before it)
+    invalid_project_not_first = joinpath(@__DIR__, "project", "invalid_project_not_first.jl")
+    err_output = IOBuffer()
+    result = run(pipeline(ignorestatus(`$(Base.julia_cmd()) --startup-file=no $invalid_project_not_first`), stderr=err_output))
+    @test !success(result)
+    @test occursin("#!project section must come first", String(take!(err_output)))
+
+    # Test 2: Manifest section not last (has code after it)
+    invalid_manifest_not_last = joinpath(@__DIR__, "project", "invalid_manifest_not_last.jl")
+    err_output = IOBuffer()
+    result = run(pipeline(ignorestatus(`$(Base.julia_cmd()) --startup-file=no $invalid_manifest_not_last`), stderr=err_output))
+    @test !success(result)
+    @test occursin("#!manifest section must come last", String(take!(err_output)))
+
+    # Test 3: Project not first, but manifest present
+    invalid_both = joinpath(@__DIR__, "project", "invalid_both.jl")
+    err_output = IOBuffer()
+    result = run(pipeline(ignorestatus(`$(Base.julia_cmd()) --startup-file=no --project=$invalid_both -e "using Test"`), stderr=err_output))
+    @test !success(result)
+    @test occursin("#!project section must come first", String(take!(err_output)))
+
+    # Test 4: Manifest with code in between sections
+    invalid_code_between = joinpath(@__DIR__, "project", "invalid_code_between.jl")
+    err_output = IOBuffer()
+    result = run(pipeline(ignorestatus(`$(Base.julia_cmd()) --startup-file=no --project=$invalid_code_between -e "using Test"`), stderr=err_output))
+    @test !success(result)
+    @test occursin("#!manifest section must come last", String(take!(err_output)))
 end

test/project/invalid_both.jl

@@ -0,0 +1,11 @@
+using Test
+
+function foo()
+    return 42
+end
+
+#!project begin
+#!project end
+
+#!manifest begin
+#!manifest end

test/project/invalid_code_between.jl

@@ -0,0 +1,14 @@
+#!project begin
+#!project end
+
+using Test
+
+# Some actual Julia code
+function bar()
+    println("hello")
+end
+
+#!manifest begin
+#!manifest end
+
+bar()

test/project/invalid_manifest_not_last.jl

@@ -0,0 +1,12 @@
+#!project begin
+# [deps]
+# Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+#!project end
+
+using Test
+
+#!manifest begin
+# julia_version = "1.11.0"
+#!manifest end
+
+println("Code after manifest")

test/project/invalid_project_not_first.jl

@@ -0,0 +1,10 @@
+# Some code before project section
+
+using Test
+x = 1
+
+#!project begin
+# name = "Test"
+#!project end
+
+println("test")

test/project/portable_script.jl

@@ -10,6 +10,35 @@
 # Rot13 = "43ef800a-eac4-47f4-949b-25107b932e8f"
 #!project end
 
+using Random
+using Test
+using Rot13
+
+# Verify the portable script environment is active
+println("Active project: ", Base.active_project())
+println("Active manifest: ", Base.active_manifest())
+println()
+
+# Test that stdlib packages work
+@testset "Portable Script Tests" begin
+    # Test Random (stdlib)
+    Random.seed!(42)
+    r = rand()
+    @test 0 <= r <= 1
+    println("✓ Random (stdlib) loaded successfully")
+
+    # Test Rot13 (path-based dependency)
+    @test Rot13.rot13("Hello") == "Uryyb"
+    @test Rot13.rot13("World") == "Jbeyq"
+    println("✓ Rot13 (path dependency) loaded successfully")
+
+    # Test that Rot13 module has expected functions
+    @test hasmethod(Rot13.rot13, (Char,))
+    @test hasmethod(Rot13.rot13, (AbstractString,))
+    println("✓ Rot13 methods available")
+end
+
+
 #!manifest begin
 # julia_version = "1.13.0"
 # manifest_format = "2.0"
@@ -59,32 +88,4 @@
 # path = "Rot13"
 # uuid = "43ef800a-eac4-47f4-949b-25107b932e8f"
 # version = "0.1.0"
-#!manifest end
-
-using Random
-using Test
-using Rot13
-
-# Verify the portable script environment is active
-println("Active project: ", Base.active_project())
-println("Active manifest: ", Base.active_manifest())
-println()
-
-# Test that stdlib packages work
-@testset "Portable Script Tests" begin
-    # Test Random (stdlib)
-    Random.seed!(42)
-    r = rand()
-    @test 0 <= r <= 1
-    println("✓ Random (stdlib) loaded successfully")
-
-    # Test Rot13 (path-based dependency)
-    @test Rot13.rot13("Hello") == "Uryyb"
-    @test Rot13.rot13("World") == "Jbeyq"
-    println("✓ Rot13 (path dependency) loaded successfully")
-
-    # Test that Rot13 module has expected functions
-    @test hasmethod(Rot13.rot13, (Char,))
-    @test hasmethod(Rot13.rot13, (AbstractString,))
-    println("✓ Rot13 methods available")
-end
+#!manifest end