Document sanitizing of text in Append task

[jawira]

I'm trying to add a final new line at the end of a file. I tried to do so with AppendTask.

<append destFile="my-file.txt" text="${line.separator}"/>

The problem is this doesn't work because text is "sanitized" after:

phing/src/Phing/Task/System/AppendTask.php

Lines 350 to 355 in 0824c14

	private function sanitizeText(): void
	{
	if (null !== $this->text && '' === trim($this->text)) {
	$this->text = null;
	}
	}

I don't understand the rationale behind sanitizeText. But IMHO this method can be deleted, or maybe there's another way to simply append a new line ?

Thanks

[siad007]

Hi @jawira did you try with fixLastLine Attribute set to true?

[jawira]

Hi @siad007 ! Thanks for replying :) I just tried to use fixLastLine but my build keeps failing:

BUILD FAILED
/home/jawira/PhpstormProjects/xxxxxx/build.xml:236:59 You must specify a file, use a filelist/fileset, or specify a text value.

Total time: 0.0444 seconds

I'm more curious about why sanitizeText is required? what if I just want to append white spaces?

I can make a PR if required. Since this is not very important, you can also close this issue if you want :)

[siad007]

Hi @jawira - sry for that long delay.

Looking here a little bit closer, we have a bug here.

I'm more curious about why sanitizeText is required?

AFAIK This is needed against empty text arguments like <append destFile="my-file.txt" text=""/> (related also to xml parsing)

Things that should work are at least:

<?xml version="1.0" encoding="UTF-8" ?>
<project name="test" default="one">
    <target name="one">
        <append destFile="my-file.txt" text="${line.separator}"/>
    </target>
    <target name="two">
        <append destFile="my-file.txt" text="
"/>
    </target>
    <target name="three">
        <append destFile="my-file.txt" text="&#10;"/>
    </target>
</project>

[mrook]

Actually, this is by design and matches the way the Concat task works in Ant. This is because adding a nested text element may introduce additional (ignorable) whitespace. Hence the sanitizeText call at the start of validate. This is not well documented, and maybe we need to introduce a switch that can disable that behavior.

[mrook]

phingofficial/guide@bad7358

[jawira]

@mrook thanks