[[TranslatedPages]]
= Plugin -> Scripting =

[[Image(https://josm.openstreetmap.de/pluginicon/scripting.jar/images/script-engine.png,link=,48)]]
[[PageOutline(2-4,,inline)]]


== Purpose ==
Use it to automate small tasks for which no any existing plugin can do i.e.

* additional quality tests for which no validator test cases are available
* automatically entering data in very specific situations (i.e. sequences of house numbers)
* importing from a custom file format not supported by JOSM
* exporting to a custom file format not supported by JOSM 


== How to execute scripts ==
The [https://gubaer.github.io/josm-scripting-plugin scripting plugin] allows you to run scripts within JOSM.

You can run scripts from console or from files. If you pick files, then latest scripts will appear in "scripting" menu. See also 


== How to write your own scripts ==
Please carefully inspect both resources:
* https://gubaer.github.io/josm-scripting-plugin/doc/documentation.html - follow all links here
* https://gubaer.github.io/josm-scripting-plugin/apidoc/modules/josm.html - scan what all classes, modules, mixins and namespaces can do.

To write functional scripts than "josm.alert(josm.menu.length);" you should combine examples from multiple pages, for example: 
* [https://gubaer.github.io/josm-scripting-plugin/apidoc/classes/JSAction.html Create an action using "JSAction" class], then [https://gubaer.github.io/josm-scripting-plugin/doc/menu.html attach it to menu as was shown at "Extending the JOSM menu and the JOSM toolbar" page]


== Implementations details ==
The plugin includes a embedded scripting engine for Javascript based on Mozilla Rhino and a
[https://gubaer.github.io/josm-scripting-plugin/apidoc/modules/josm.html Javascript API] for the JOSM application objects.\\
Alternatively, you can use any scripting language which provides a JSR-223 compatible scripting engine, in particular
[https://groovy-lang.org/index.html Groovy], [https://www.jython.org/ Python], or [https://www.jruby.org/ Ruby].\\

[https://github.com/gubaer/josm-scripting-plugin Source code at GitHub].


== Scripts ==
=== Scripts in JavaScript ===
* https://gist.github.com/Rub21/feb83f57a727ac0d8a34 - Expand abbreviations (US)
* https://gist.github.com/Rub21/47838797856566a8b6ba - Capitalize names and eliminate "name=S/N"
* https://gist.github.com/Rub21/cc055320c925c855926e - expand abbreviations (Peru); [https://www.youtube.com/watch?v=Cpi_5dB1NLQ video demonstration]

=== Scripts in Python ===
* [wikitr:/Help/Plugin/Scripting/Python] - various small scripts that are meant to illustrate how to do one thing.
* [wikitr:/Help/Plugin/Scripting/Python/SurfaceTypesOfRoutes] - (Interesting for cycle routes, both loops and linear ones). Short piece of code, but illustrates some interesting concepts and reports on OSM data. Doesn't make changes to the data
* [wikitr:/Help/Plugin/Scripting/Python/RCN_Route_Validator] - This is not a trivial script anymore. It does a lot in a complicated field (networks of cycle node routes with numbered nodes), makes changes to relations, writes to a file that can be pasted to the wiki. Analyzes routes, but also networks of routes or collections of networks of routes, depending on the selection in JOSM when the script was run.
* [attachment:ticket:7991:AutoAddIntersections.py AutoAddIntersections] (needs [wikitr:/Help/Plugin/UtilsPlugin2 UtilsPlugin2]) - Adds command queue listener that will perform utilsplugin2's AddNodesAtIntersections command after encountering Extrude command. (See #7991)\\
 Run once per JOSM session.


== Advanced settings ==
Search for {{{scripting.}}} substring.

{{{#!comment
== See also ==
}}}

----
Back to [wikitr:/Plugins Plugin Help] \\
Back to [wikitr:/Help Main Help]