Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project cleanup #62

Merged
merged 1 commit into from
Sep 29, 2022
Merged

Project cleanup #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 26 additions & 89 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
under the License.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
Expand All @@ -38,12 +38,12 @@
Tidy Plugin for Maven. The Tidy plugin provides goals for tidying up
your source code.
</description>
<url>http://www.mojohaus.org/tidy-maven-plugin/</url>
<url>https://www.mojohaus.org/tidy-maven-plugin/</url>
<inceptionYear>2011</inceptionYear>
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
Expand All @@ -66,19 +66,9 @@
<scm>
<connection>scm:git:https://github.com/mojohaus/tidy-maven-plugin.git</connection>
<developerConnection>scm:git:ssh://git@github.com/mojohaus/tidy-maven-plugin.git</developerConnection>
<url>https://github.com/mojohaus/tidy-maven-plugin</url>
<url>https://github.com/mojohaus/tidy-maven-plugin/tree/master</url>
<tag>HEAD</tag>
</scm>
<issueManagement>
<system>GitHub</system>
<url>https://github.com/mojohaus/tidy-maven-plugin/issues</url>
</issueManagement>
<distributionManagement>
<site>
<id>github</id>
<url>scm:git:git@github.com:mojohaus/tidy-maven-plugin.git</url>
</site>
</distributionManagement>

<properties>
<mavenVersion>3.2.5</mavenVersion>
Expand All @@ -96,10 +86,30 @@
</dependencies>
</dependencyManagement>
<dependencies>
<!-- Maven -->
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-core</artifactId>
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>

<dependency>
<groupId>com.fasterxml.woodstox</groupId>
<artifactId>woodstox-core</artifactId>
Expand All @@ -116,25 +126,8 @@
<artifactId>stax2-api</artifactId>
<version>3.1.4</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<!-- Overriding version in mojo-parent for Maven 2.2.1 compatibility -->
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-compat</artifactId>
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.4</version>
<scope>provided</scope>
</dependency>

<!-- tests -->
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
Expand All @@ -149,62 +142,6 @@
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-site-plugin</artifactId>
<configuration>
<topSiteURL>${project.distributionManagement.site.url}</topSiteURL>
</configuration>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-markdown</artifactId>
<version>1.11.1</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<configuration>
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
</configuration>
<executions>
<execution>
<id>mojo-descriptor</id>
<goals>
<goal>descriptor</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- to publish site on branch gh-pages -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<configuration>
<!-- mono-module doesn't require site:stage -->
<content>${project.build.directory}/site</content>
</configuration>
</plugin>
</plugins>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<configuration>
<requirements>
<memory>256m</memory>
</requirements>
</configuration>
</plugin>
</plugins>
</reporting>

<profiles>
<profile>
<id>run-its</id>
Expand Down
40 changes: 23 additions & 17 deletions src/site/markdown/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
[//]: # (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.)
## Tidy Maven Plugin
<!--
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.
-->

Tidy Maven Plugin
=================

The Tidy Plugin tidies up a project's `pom.xml` and optionally verifies
that it is tidy.

### Goals Overview
Goals Overview
--------------

The Tidy Plugin has two goals.

* [tidy:pom](./pom-mojo.html) tidies up the project's `pom.xml`.
* [tidy:check](./check-mojo.html) checks that the project's `pom.xml` is tidy.

### Usage
Usage
-----

General instructions on how to use the different goals of the Tidy Plugin can
be found on the [usage page](./usage.html).
Expand Down
40 changes: 23 additions & 17 deletions src/site/markdown/usage.md.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
[//]: # (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.)
## Usage
<!--
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.
-->

Usage
=====

The following examples describe the basic usage of the Tidy Plugin.

### Format the POM
Format the POM
--------------

To format the `pom.xml` execute the `pom` goal manually.

Expand Down Expand Up @@ -50,7 +55,8 @@ Note: The following sections potentially can affect the build process if the chi
* `/project/dependencies`
* `/project/build/plugins`

### Checking for Tidy POM as Part of the Build
Checking for Tidy POM as Part of the Build
------------------------------------------

If you want to fail the build for a POM that is not formatted according to the
`pom` goal, you must add an execution of `tidy:check` to the `build` element.
Expand Down
17 changes: 9 additions & 8 deletions src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<custom>
<fluidoSkin>
<gitHub>
<projectId>mojohaus/${project.artifactId}</projectId>
</gitHub>
</fluidoSkin>
</custom>
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">

<body>

<breadcrumbs>
<item name="MojoHaus" href="https://www.mojohaus.org/"/>
<item name="${this.name}" href="${this.url}" />
</breadcrumbs>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
Expand Down