You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Garret Wilson (Jira)" <ji...@apache.org> on 2022/10/29 00:06:00 UTC

[jira] [Updated] (MPH-193) Document charset for evaluate goal file output.

     [ https://issues.apache.org/jira/browse/MPH-193?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Garret Wilson updated MPH-193:
------------------------------
    Description: 
I'm using Java 17 on Windows with `org.apache.maven.plugins:maven-help-plugin:3.3.0`. The [{{<output>}}|https://maven.apache.org/plugins/maven-help-plugin/evaluate-mojo.html#output] option allows the evaluated information to be sent to a file. But the documentation does not say which charset will be used!

I was afraid that you might be using the system default charset (which would be very bad). But I did a test:

{code:xml}
<properties>
  <foo><![CDATA[<bar>touché 😃</bar>]]></foo>
</properties>
…
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-help-plugin</artifactId>
  <executions>
    <execution>
      <id>foobar</id>
      <phase>generate-resources</phase>
      <goals>
        <goal>evaluate</goal>
      </goals>
      <configuration>
        <expression>foo</expression>
        <output>${project.build.directory}/foo.xml</output>
      </configuration>
    </execution>
  </executions>
</plugin>
{code}

It was a huge relief to find that the output file {{foo.xml}} contained the word "touché" followed by a smiley face emoticon, encoded in UTF-8! This is good!

It is a huge relief to see that you're encoding the output in UTF-8 and not some arbitrary, per-system encoding. But this needs to be documented so we'll know that we can depend on that. Thank you.

  was:
I'm using Java 17 on Windows with `org.apache.maven.plugins:maven-help-plugin:3.3.0`. The [{{<output>}}|https://maven.apache.org/plugins/maven-help-plugin/evaluate-mojo.html#output] option allows the evaluated information to be sent to a file. But the documentation does not say which charset will be used!

I was afraid that you might be using the system default charset (which would be very bad). But I did a test:

{code:xml}
<properties>
  <foo><![CDATA[<bar>touché 😃</bar>]]></foo>
</properties>
…
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-help-plugin</artifactId>
  <executions>
    <execution>
      <id>foobar</id>
      <phase>generate-resources</phase>
      <goals>
        <goal>evaluate</goal>
      </goals>
      <configuration>
        <expression>foo</expression>
        <output>${project.build.directory}/foo.xml</output>
      </configuration>
    </execution>
  </executions>
</plugin>
{xml}

It was a huge relief to find that the output file {{foo.xml}} contained the word "touché" followed by a smiley face emoticon, encoded in UTF-8! This is good!

It is a huge relief to see that you're encoding the output in UTF-8 and not some arbitrary, per-system encoding. But this needs to be documented so we'll know that we can depend on that. Thank you.


> Document charset for evaluate goal file output.
> -----------------------------------------------
>
>                 Key: MPH-193
>                 URL: https://issues.apache.org/jira/browse/MPH-193
>             Project: Maven Help Plugin
>          Issue Type: Improvement
>          Components: evaluate
>    Affects Versions: 3.3.0
>            Reporter: Garret Wilson
>            Priority: Major
>
> I'm using Java 17 on Windows with `org.apache.maven.plugins:maven-help-plugin:3.3.0`. The [{{<output>}}|https://maven.apache.org/plugins/maven-help-plugin/evaluate-mojo.html#output] option allows the evaluated information to be sent to a file. But the documentation does not say which charset will be used!
> I was afraid that you might be using the system default charset (which would be very bad). But I did a test:
> {code:xml}
> <properties>
>   <foo><![CDATA[<bar>touché 😃</bar>]]></foo>
> </properties>
> …
> <plugin>
>   <groupId>org.apache.maven.plugins</groupId>
>   <artifactId>maven-help-plugin</artifactId>
>   <executions>
>     <execution>
>       <id>foobar</id>
>       <phase>generate-resources</phase>
>       <goals>
>         <goal>evaluate</goal>
>       </goals>
>       <configuration>
>         <expression>foo</expression>
>         <output>${project.build.directory}/foo.xml</output>
>       </configuration>
>     </execution>
>   </executions>
> </plugin>
> {code}
> It was a huge relief to find that the output file {{foo.xml}} contained the word "touché" followed by a smiley face emoticon, encoded in UTF-8! This is good!
> It is a huge relief to see that you're encoding the output in UTF-8 and not some arbitrary, per-system encoding. But this needs to be documented so we'll know that we can depend on that. Thank you.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)