https://github.com/imagej/imagej-command-archetype
Maven archetype for a SciJava/ImageJ2 Command
https://github.com/imagej/imagej-command-archetype
imagej maven-archetype scijava
Last synced: 3 months ago
JSON representation
Maven archetype for a SciJava/ImageJ2 Command
- Host: GitHub
- URL: https://github.com/imagej/imagej-command-archetype
- Owner: imagej
- License: other
- Created: 2017-06-19T11:40:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-14T20:52:56.000Z (over 3 years ago)
- Last Synced: 2025-07-27T07:36:31.809Z (6 months ago)
- Topics: imagej, maven-archetype, scijava
- Language: Java
- Homepage:
- Size: 50.8 KB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/imagej/imagej-command-archetype/actions/workflows/build-main.yml)
imagej-command-archetype
========================
Maven archetype based on [https://github.com/imagej/example-imagej-command](https://github.com/imagej/example-imagej-command).
Usage
-----
1. Start the interactive creation mode and select a coordinate (`groupId`, `artifactId`, `version`) for your project. This will create a new subdirectory (named after `artifactId`) with a minimal setup for a `Command`:
```
$ mvn archetype:generate \
-DarchetypeGroupId=net.imagej \
-DarchetypeArtifactId=imagej-command-archetype
```
**Interactive mode for GAV definition:**
```
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] >>> maven-archetype-plugin:3.0.1:generate (default-cli) > generate-sources @ standalone-pom >>>
[INFO]
[INFO] <<< maven-archetype-plugin:3.0.1:generate (default-cli) < generate-sources @ standalone-pom <<<
[INFO]
[INFO] --- maven-archetype-plugin:3.0.1:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Interactive mode
[INFO] Archetype repository not defined. Using the one from [net.imagej:imagej-command-archetype:0.0.1-SNAPSHOT] found in catalog local
Define value for property 'groupId': com.mycompany
Define value for property 'artifactId': MyCommand
Define value for property 'version' 1.0-SNAPSHOT: : 0.1.0-SNAPSHOT
Define value for property 'package' com.mycompany: :
Define value for property 'description': My awesome description
Define value for property 'developerId' stefan: : stelfrich
Define value for property 'developerName': Stefan
Define value for property 'developerUrl' https://imagej.net/User:stelfrich: :
Define value for property 'inceptionYear' 2017: :
Define value for property 'main-class' com.mycompany.MyCommand: :
Define value for property 'name': My awesome command
Define value for property 'organizationId': imagej
Define value for property 'organizationName': ImageJ
Define value for property 'organizationUrl' https://github.com/imagej: :
Define value for property 'scmConnection' scm:git:git://github.com/imagej/MyCommand: :
Define value for property 'scmDeveloperConnection' scm:git:git@github.com:imagej/MyCommand: :
Define value for property 'scmUrl' https://github.com/imagej/MyCommand: :
Define value for property 'url' https://imagej.net/MyCommand: :
Define value for property 'urlIssueManagement' https://github.com/imagej/MyCommand/issues: :
Confirm properties configuration:
groupId: com.mycompany
artifactId: MyCommand
version: 0.1.0-SNAPSHOT
package: com.mycompany
description: My awesome description
developerId: stelfrich
developerName: Stefan
developerUrl: https://imagej.net/User:stelfrich
inceptionYear: 2017
main-class: com.mycompany.MyCommand
name: My awesome command
organizationId: imagej
organizationName: ImageJ
organizationUrl: https://github.com/imagej
scmConnection: scm:git:git://github.com/imagej/MyCommand
scmDeveloperConnection: scm:git:git@github.com:imagej/MyCommand
scmUrl: https://github.com/imagej/MyCommand
url: https://imagej.net/MyCommand
urlIssueManagement: https://github.com/imagej/MyCommand/issues
Y: :
```
Known issues
---
If you get the following error message when trying to create a new command in interactive mode
```
...
Define value for property 'description': : Something
Mar 28, 2018 9:23:33 AM org.apache.velocity.runtime.log.JdkLogChute log
INFO: FileResourceLoader : adding path '.'
Mar 28, 2018 9:23:33 AM org.apache.velocity.runtime.log.JdkLogChute log
INFO: Null reference [template 'developerId', line 1, column 1] : ${package.getClass().forName("java.lang.System").getProperty("user.name")} cannot be resolved.
Define value for property 'developerId': ${package.getClass().forName("java.lang.System").getProperty("user.name")}: :
```
confirm that one of the first lines in the output says
```
[INFO] >>> maven-archetype-plugin:2.4:generate (default-cli) > generate-sources @ standalone-pom >>>
```
This means, that Maven is using version 2.4 of `maven-archetype-plugin` instead of the latest version, which enables us to generate even more meaningful default settings.
If the above applies to you, delete `~/.m2/repositories/org/apache/maven/plugins` to force Maven to re-download the latest version of plugins.