README.md

Gradle plugin for developing JOSM plugins

This Gradle plugin is designed to make development of JOSM plugins easier.

Things like test driving your JOSM plugins before releasing them becomes as easy as typing ./gradlew runJosm into the command line and the gradle-josm-plugin automatically takes care of compiling the current state of your JOSM plugin, starting a clean (!) instance of JOSM with only your plugin loaded (and all required plugins, even transitive ones). You'll no longer need to keep a local copy of the JOSM source code in a compatible version and the other JOSM plugins!

See the docs below for many more things you can do. And you don't even need to abandon the Ant build, which is used for most of the JOSM plugins. Option 2 in the guide for setting up the gradle-josm-plugin explains how a JOSM plugin can support building with either build system (many configuration options can be shared between both).

If you miss something here, found something that's broken, or need more info about this project:

• Feel free to open issues on this project!
• Or you can reach out via email: contact-project+josm-gradle-josm-plugin-5042462-issue- (at) incoming.gitlab.com

Getting started

The plugin is available in the default Gradle plugin repository.

See docs/Setup.md for detailed setup instructions.

See docs/Tasks.md for information, from which tasks you can choose.

And if you need external dependencies for your plugin, maybe docs/Dependencies.md can help.

If you want to know how i18n works, have a look at docs/I18n.md.

In docs/Versioning.md it is described, how the version number of your plugin is determined and how you can increment it.

Also, the KDoc (similar to Javadoc, but for Kotlin) for this Gradle plugin is available online.

Projects using this Gradle plugin

• JOSM/areaselector
• Jamalek/josm-batch-downloader
• Gubaer/josm-contourmerge-plugin
• fieldpapers/josm-fieldpapers
• JOSM/geojson
• gokaart/JOSM_highwayNameModification
• osmlab/josm-atlas
• gokaart/JOSM_lane-connectivity
• qeef/mapathoner
• JOSM/Mapillary
• gokaart/JOSM_MapWithAI
• matsim-org/josm-matsim-plugin
• iandees/josm-mbtiles
• microsoft/MicrosoftStreetsidePlugin
• gokaart/JOSM_OpenQA
• DavidKarlas/JosmRelationValidation (Relation Validation Plugin)
• DavidKarlas/JosmReviewPlugin (Review Changes)
• Gubaer/josm-scripting-plugin
• JOSM/pt_assistant
• JOSM/wikipedia

Deprecated links

Alternatively to the default Gradle plugin repository, you can download this plugin from a Maven repository at https://josm.gitlab.io/gradle-josm-plugin/maven. That link gives a 404 HTTP status, but the repository is still there. The contents can be viewed at https://gitlab.com/JOSM/gradle-josm-plugin/tree/pages/maven .

Under https://plugins.gradle.org/plugin/org.openstreetmap.josm.gradle.plugin you can find the versions < v0.2.0 of the plugin. Later versions have the shorter plugin ID org.openstreetmap.josm.