This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 256190 - markup validation should be performed as part of the Eclipse build
Summary: markup validation should be performed as part of the Eclipse build
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 1.0.0   Edit
Assignee: David Green CLA
QA Contact:
URL:
Whiteboard:
Keywords: noteworthy
Depends on: 256510
Blocks:
  Show dependency tree
 
Reported: 2008-11-21 21:23 EST by David Green CLA
Modified: 2011-01-06 10:01 EST (History)
1 user (show)

See Also:


Attachments
initial implementation of WST validation (9.58 KB, patch)
2008-11-24 11:55 EST, David Green CLA
no flags Details | Diff
mylyn/context/zip (44.26 KB, application/octet-stream)
2008-11-24 11:55 EST, David Green CLA
no flags Details
mylyn/context/zip (131.03 KB, application/octet-stream)
2008-12-09 12:08 EST, David Green CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description David Green CLA 2008-11-21 21:23:44 EST
preferably the validation would be managed the same as other validators, such as XML and HTML
Comment 1 David Green CLA 2008-11-24 11:52:58 EST
Steffen, it would be nice to leverage the WST validation API for this purpose.  In doing so we get automatic integration into the configuration UI for validators.

The downside of such integration includes:
# a new build dependency
# validation would only run if the user had WST installed

I'm okay with the 2nd issue, however the new plug-in dependency may be problematic.  
Not only is WST a heavyweight, @org.eclipse.wst.validation.AbstractValidator@ is javadoc'd as provisional API.  What are your thoughts?
Comment 2 David Green CLA 2008-11-24 11:55:20 EST
Created attachment 118607 [details]
initial implementation of WST validation
Comment 3 David Green CLA 2008-11-24 11:55:24 EST
Created attachment 118608 [details]
mylyn/context/zip
Comment 4 Steffen Pingel CLA 2008-11-24 20:13:32 EST
That seems like a great idea. I wouldn't worry about the provisional APIs, I think it's hard to implement anything based on webtools that doesn't use internals. The build dependency might be okay but we should discuss that on a conference call. How much harder would it be to implement a custom builder for the markup validation to avoid a dependency on webtools? 
Comment 5 David Green CLA 2008-11-24 20:51:43 EST
(In reply to comment #4)
> The build dependency might be okay but we should discuss that on a
> conference call. 

Sounds good

> How much harder would it be to implement a custom builder for
> the markup validation to avoid a dependency on webtools?

It's not hard at all.  The downside is that we won't get the GUI for enabling/disabling validators.
Comment 6 David Green CLA 2008-11-30 22:42:34 EST
I've put some thought into this one.  Perhaps it would be good to have both builders.  That way everyone would get validation, and those that have Web Tools installed would get the UI.  Of course, only one builder would be enabled at any given point in time.

In the short term until we get the build dependencies issue sorted (in part, bug 256510) a simple non-WST builder would do.
Comment 7 David Green CLA 2008-12-01 23:18:00 EST
Turns out that the UI is pretty important.  Without the UI there is no way for a user to associate the validation builder with the project.  Adding the builder can be done by editing the  .project file, but that's a non-starter.

The WST plug-ins add settings for Validation under the project properties.  For WikiText to do the same is senseless.

Perhaps it makes sense to have a @org.eclipse.mylyn.wikitext.ui.wst@ plug-in to separate the dependencies as proposed in bug 256510.
Comment 8 David Green CLA 2008-12-04 13:50:48 EST
Use non-WST builder

Create a new WikiText project nature that automatically adds the builder.

* prompt to add nature if it doesn't exist if a wikitext file is created, with don't ask me again option
* always add the nature with builder disabled if a wikitext file exists in the project?
Comment 9 David Green CLA 2008-12-09 12:08:55 EST
An incremental project builder has been implemented.  See the Mylyn WikiText User Guide for details.
Comment 10 David Green CLA 2008-12-09 12:08:59 EST
Created attachment 119926 [details]
mylyn/context/zip