maven-plugin-tools/maven-plugin-plugin/src/site/apt/multiple-language-support.apt

53 lines
2.1 KiB
Plaintext

---
Multiple Language Support for the Plugin Plugin: Redesign Notes
---
John Casey
---
2005-02-09
---
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License. You may obtain a copy of the License at
~~
~~ http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
<<THIS NEEDS REVISION AND CLEANING UP>>
*Abstract
The Plugin Plugin needs to be refactored in order to support multiple mojo
implementation languages. This document will detail the steps needed to
add this functionality.
*Current Status
The Plugin Plugin currently calls out to a set of generators in the
maven-plugin-tools library, which in turn uses QDox to generate various things
based on annotations in the java source code.
*Refactored Design
The new design will have a generator-manager which is a component that the
plugin mojos will lookup. This component will have access to a mapping of all
generators and the language they're registered for. It'll iterate through the
mappings, and extract mojo descriptors from all relevant scripts/sources using
each language's registered generator. Results from each generator will be
centrally aggregated by the generator-manager. After all generators have run,
the generator-manager will call another class (depending on what it's meant to
produce) to take all the aggregated mojo descriptors and produce a result
(such as <<<plugin.xml>>> file for the project).