Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mylyn-docs-dev] naming convention on "core" bundles
Thanks Sam.

The convention for WikiText "core" projects/bundles will be to use standard Maven layout, i.e. tests in the same project under src/test/java.

I've renamed org.eclipse.mylyn.wikitext.tests to org.eclipse.mylyn.wikitext.ui.tests, and org.eclipse.mylyn.wikitext.core.tests to org.eclipse.mylyn.wikitext.tests.

Cheers,

David

On Wed, Feb 1, 2017 at 4:32 PM Sam Davis <sam.davis@xxxxxxxxxxx> wrote:
You will need to watch out for name conflicts in the test bundles. In Mylyn we use "core" in the names of test bundles to distinguish integration tests (e.g. org.eclipse.mylyn.tasks.tests) from unit tests (e.g. org.eclipse.mylyn.tasks.core.tests) as described at https://wiki.eclipse.org/Mylyn/Contributor_Reference#JUnit_Tests. I'm not sure if Docs follows that convention but it does have at least these 2 bundles:
org.eclipse.mylyn.wikitext.tests
org.eclipse.mylyn.wikitext.core.tests

Sam


--
Sam Davis
Senior Software Engineer, Tasktop
Committer, Eclipse Mylyn
http://tasktop.com

On Wed, Feb 1, 2017 at 11:00 AM, David Green <david.green@xxxxxxxxxxx> wrote:
I've accidentally pushed 3 changesets implementing some of this proposal directly to master, bypassing Gerrit.  I've pushed revert commits - so history is going to look a little odd.  Apologies for any trouble I've caused.

David

On Wed, Feb 1, 2017 at 7:21 AM David Green <david.green@xxxxxxxxxxx> wrote:
This proposal, if we do it, would break any code using WikiText APIs.  Integrators would have to correct their imports to match Java package naming.  In Eclipse this might be a simple matter of "organize imports".

David

On Wed, Feb 1, 2017 at 12:59 AM Steffen Pingel <steffen.pingel@xxxxxxxxxxx> wrote:
+1 The names are shorter and the core suffix is redundant and potentially confusing.

Jeremie, I would expect each of those bundles to contain a package under the namespace that matches the bundle name, e.g. 

org.eclipse.mylyn.wikitext.asciidoc
|
+-- src/main/java/org/eclipse/mylyn/wikitext/[internal/]asciidoc

As long as the bundle namespaces are unique there shouldn't be any conflicts.

Steffen


On Wed, Feb 1, 2017 at 7:29 AM, Jeremie Bresson <dev@xxxxxxxx> wrote:

Hi,

What is your idea? Let the "core" artifacts in a core folder but remove the suffix from there name?

\---wikitext
    |
    +---core
    |   +---org.eclipse.mylyn.wikitext.asciidoc
    |   +---org.eclipse.mylyn.wikitext.commonmark
    |   +---org.eclipse.mylyn.wikitext
    |   \---....
    |
    \---ui
        +---org.eclipse.mylyn.wikitext.asciidoc.ui
        +---org.eclipse.mylyn.wikitext.commonmark.ui
        \---....

Or have you an other proposition for "core" folder.

Have you checked if this idea works with the Java 9 constraint on package names?
Someday I guess that our bundles will become Java 9 modules. Each package name needs to be unique across the modules.


Le 01.02.2017 01:19, David Green a écrit :

All,

We currently have a naming convention with a "core" suffix on all bundles and Maven artifacts that are not UI contributions to Eclipse.  For example:
 
org.eclipse.mylyn.wikitext.core
org.eclipse.mylyn.wikitext.ui
org.eclipse.mylyn.wikitext.textile.core
org.eclipse.mylyn.wikitext.textile.ui
 
This sticks out as like a sore thumb when looking at dependencies and other artifacts in a regular Maven build.
 
With the recent build changes, we've changed the major version number of WikiText from 2.x to 3.x.  This gives us a rare opportunity to make other breaking changes, such as renaming bundles.
 
I'd like to propose a naming change where we drop the "core" suffix, for example:
 
org.eclipse.mylyn.wikitext
org.eclipse.mylyn.wikitext.ui
org.eclipse.mylyn.wikitext.textile
org.eclipse.mylyn.wikitext.textile.ui
 
As part of this bundle renaming, we should also consider renaming java packages in those core bundles to drop the "core" suffix as well.
 
While the ".core" suffix naming naming convention could be seen as a cosmetic change, and therefore with little benefit or reason to change, I see it as being a potential source of confusion for consumers.  >From a consumer perspective, what does "core" mean anyways, unless you're familiar with the convention?
 
What do you think?  
 
David
--


David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev



_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev



--
Steffen Pingel
Staff Software Engineer
http://tasktop.com
_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev
--


David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx

--


David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev

_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev
--


David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx

Back to the top