You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Brett Porter <br...@apache.org> on 2007/09/04 18:15:09 UTC

Fwd: Standards for Plugin Parameters

Hey,

Blast from the past :) I had this flagged in my design issues folder  
(Thanks, mailtags!) and noticed we don't have it in the proposals.

Full thread: http://mail-archives.apache.org/mod_mbox/maven-dev/ 
200608.mbox/%3CEFE0CEB8-8432-43B8-8F30-DB18033966DF@maven.org%3E

Jason - is this another one to write up, or did this already get  
addressed in another way? I don't recall seeing it implemented, but I  
could be wrong.

Cheers,
Brett

Begin forwarded message:

> From: Jason van Zyl <ja...@maven.org>
> Date: 22 August 2006 9:40:53 AM
> To: Maven Developers List <de...@maven.apache.org>
> Subject: Standards for Plugin Parameters
> Reply-To: "Maven Developers List" <de...@maven.apache.org>
> List-Id: "Maven Developers List" <dev.maven.apache.org>
> Message-Id: <EF...@maven.org>
>
> Hi,
>
> While working on MJAR-7, John and I discussed a possible standard  
> for plugin parameters naming conventions. Which basically boil down  
> to:
>
> field/property = noun|verbNoun
> expression    = prefix.noun|verbNoun
>
> So for MJAR-7 we have
>
> field             = forceCreation
> expression = jar.forceCreation
>
> So we are using camel case to avoid any potential interpolation  
> problems, the noun|verbNoun form to use used within the plugin  
> configuration, and the prefix.noun|verbNoun on the command line to  
> prevent name collisions with other plugins.
>
> So that would be:
>
> <plugin>
>   <artifact-id>maven-jar-plugin</artifact-id>
>   <configuration>
>     <forceCreation>false</forceCreation>
>   </configuration>
> </plugin>
>
> And on the command line it would be
>
> mvn -Djar.forceCreation=false
>
> I've seen all sorts of format for parameters as with everything the  
> format is arbitrary but it would be good to have a standard  
> guideline to follow.
>
> Anyone else have any thoughts?
>
> Jason van Zyl
> jason@maven.org
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org

--
Brett Porter - brett@apache.org
Blog: http://www.devzuz.org/blogs/bporter/


Re: Standards for Plugin Parameters

Posted by Brett Porter <br...@apache.org>.
On 05/09/2007, at 5:30 AM, Jason van Zyl wrote:

>
> On 4 Sep 07, at 9:15 AM 4 Sep 07, Brett Porter wrote:
>
>> Hey,
>>
>> Blast from the past :) I had this flagged in my design issues  
>> folder (Thanks, mailtags!) and noticed we don't have it in the  
>> proposals.
>>
>> Full thread: http://mail-archives.apache.org/mod_mbox/maven-dev/ 
>> 200608.mbox/%3CEFE0CEB8-8432-43B8-8F30-DB18033966DF@maven.org%3E
>>
>> Jason - is this another one to write up, or did this already get  
>> addressed in another way? I don't recall seeing it implemented,  
>> but I could be wrong.
>>
>
> As Brian pointed out let's get everyone to push in everything, the  
> cut off date the Friday after next.

Yep... that's why I brought it up. Did you want to write it up?

- Brett

>
>> Cheers,
>> Brett
>>
>> Begin forwarded message:
>>
>>> From: Jason van Zyl <ja...@maven.org>
>>> Date: 22 August 2006 9:40:53 AM
>>> To: Maven Developers List <de...@maven.apache.org>
>>> Subject: Standards for Plugin Parameters
>>> Reply-To: "Maven Developers List" <de...@maven.apache.org>
>>> List-Id: "Maven Developers List" <dev.maven.apache.org>
>>> Message-Id: <EF...@maven.org>
>>>
>>> Hi,
>>>
>>> While working on MJAR-7, John and I discussed a possible standard  
>>> for plugin parameters naming conventions. Which basically boil  
>>> down to:
>>>
>>> field/property = noun|verbNoun
>>> expression    = prefix.noun|verbNoun
>>>
>>> So for MJAR-7 we have
>>>
>>> field             = forceCreation
>>> expression = jar.forceCreation
>>>
>>> So we are using camel case to avoid any potential interpolation  
>>> problems, the noun|verbNoun form to use used within the plugin  
>>> configuration, and the prefix.noun|verbNoun on the command line  
>>> to prevent name collisions with other plugins.
>>>
>>> So that would be:
>>>
>>> <plugin>
>>>   <artifact-id>maven-jar-plugin</artifact-id>
>>>   <configuration>
>>>     <forceCreation>false</forceCreation>
>>>   </configuration>
>>> </plugin>
>>>
>>> And on the command line it would be
>>>
>>> mvn -Djar.forceCreation=false
>>>
>>> I've seen all sorts of format for parameters as with everything  
>>> the format is arbitrary but it would be good to have a standard  
>>> guideline to follow.
>>>
>>> Anyone else have any thoughts?
>>>
>>> Jason van Zyl
>>> jason@maven.org
>>>
>>>
>>>
>>>
>>> -------------------------------------------------------------------- 
>>> -
>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>> --
>> Brett Porter - brett@apache.org
>> Blog: http://www.devzuz.org/blogs/bporter/
>>
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder and PMC Chair, Apache Maven
> jason at sonatype dot com
> ----------------------------------------------------------
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org

--
Brett Porter - brett@apache.org
Blog: http://www.devzuz.org/blogs/bporter/

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: Standards for Plugin Parameters

Posted by Jason van Zyl <ja...@maven.org>.
On 4 Sep 07, at 9:15 AM 4 Sep 07, Brett Porter wrote:

> Hey,
>
> Blast from the past :) I had this flagged in my design issues  
> folder (Thanks, mailtags!) and noticed we don't have it in the  
> proposals.
>
> Full thread: http://mail-archives.apache.org/mod_mbox/maven-dev/ 
> 200608.mbox/%3CEFE0CEB8-8432-43B8-8F30-DB18033966DF@maven.org%3E
>
> Jason - is this another one to write up, or did this already get  
> addressed in another way? I don't recall seeing it implemented, but  
> I could be wrong.
>

As Brian pointed out let's get everyone to push in everything, the  
cut off date the Friday after next.

> Cheers,
> Brett
>
> Begin forwarded message:
>
>> From: Jason van Zyl <ja...@maven.org>
>> Date: 22 August 2006 9:40:53 AM
>> To: Maven Developers List <de...@maven.apache.org>
>> Subject: Standards for Plugin Parameters
>> Reply-To: "Maven Developers List" <de...@maven.apache.org>
>> List-Id: "Maven Developers List" <dev.maven.apache.org>
>> Message-Id: <EF...@maven.org>
>>
>> Hi,
>>
>> While working on MJAR-7, John and I discussed a possible standard  
>> for plugin parameters naming conventions. Which basically boil  
>> down to:
>>
>> field/property = noun|verbNoun
>> expression    = prefix.noun|verbNoun
>>
>> So for MJAR-7 we have
>>
>> field             = forceCreation
>> expression = jar.forceCreation
>>
>> So we are using camel case to avoid any potential interpolation  
>> problems, the noun|verbNoun form to use used within the plugin  
>> configuration, and the prefix.noun|verbNoun on the command line to  
>> prevent name collisions with other plugins.
>>
>> So that would be:
>>
>> <plugin>
>>   <artifact-id>maven-jar-plugin</artifact-id>
>>   <configuration>
>>     <forceCreation>false</forceCreation>
>>   </configuration>
>> </plugin>
>>
>> And on the command line it would be
>>
>> mvn -Djar.forceCreation=false
>>
>> I've seen all sorts of format for parameters as with everything  
>> the format is arbitrary but it would be good to have a standard  
>> guideline to follow.
>>
>> Anyone else have any thoughts?
>>
>> Jason van Zyl
>> jason@maven.org
>>
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>
> --
> Brett Porter - brett@apache.org
> Blog: http://www.devzuz.org/blogs/bporter/
>

Thanks,

Jason

----------------------------------------------------------
Jason van Zyl
Founder and PMC Chair, Apache Maven
jason at sonatype dot com
----------------------------------------------------------




---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org