├── .editorconfig ├── .github └── workflows │ └── gradle.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── groovy └── com │ └── github │ └── mrsarm │ └── jshell │ └── plugin │ └── JShellPlugin.groovy └── resources └── META-INF └── gradle-plugins └── com.github.mrsarm.jshell.plugin.properties /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | # Unix-style newlines 6 | end_of_line = lf 7 | insert_final_newline = true 8 | charset = utf-8 9 | indent_style = space 10 | indent_size = 4 11 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle 3 | 4 | name: CI with Gradle 5 | 6 | on: 7 | push: 8 | branches: master 9 | pull_request: 10 | 11 | jobs: 12 | build: 13 | 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - uses: actions/checkout@v2 18 | - name: Set up JDK 11 19 | uses: actions/setup-java@v2 20 | with: 21 | java-version: '11' 22 | distribution: 'adopt' 23 | cache: gradle 24 | - name: Build 25 | run: ./gradlew build 26 | - name: Publish to Maven local with Gradle 27 | run: ./gradlew publishToMavenLocal 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle/ 2 | build/ 3 | .idea/ 4 | *.swp 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | JShell Plugin 2 | ============= 3 | 4 | **Gradle plugin** that helps you to explore your code and dependencies in your gradle project 5 | with in [jshell](https://docs.oracle.com/javase/9/jshell/introduction-jshell.htm), 6 | the official Java REPL tool (Java 9+). 7 | 8 | Hosted in the **Gradle plugins** site: https://plugins.gradle.org/plugin/com.github.mrsarm.jshell.plugin 9 | 10 | > ### :keyboard: Use `rlwrap` to make arrow keys work ([see](#tab-completion-and-arrow-keys-not-working)). 11 | 12 | 13 | - [Getting started](#getting-started) 14 | - [Startup options](#startup-options) 15 | - [Spring Boot applications](#spring-boot-applications) 16 | - [Troubleshooting](#troubleshooting) 17 | - [System Requirements](#system-requirements) 18 | - [Build and Publish](#build-and-publish) 19 | - [About](#about) 20 | 21 | 22 | Getting started 23 | --------------- 24 | 25 | To use this plugin, add the following to your `build.gradle`: 26 | 27 | ```groovy 28 | plugins { 29 | id "com.github.mrsarm.jshell.plugin" version "1.2.1" 30 | } 31 | ``` 32 | 33 | Task `jshell` is now enabled, which execute the jshell with your classes and 34 | dependencies after compiling your code. 35 | 36 | You need to run the task `jshell` with the option `--console plain`. 37 | Following is an example: 38 | 39 | $ gradle --console plain jshell 40 | 41 | ... (gradle tasks output) ... 42 | 43 | > Task :jshell 44 | | Welcome to JShell -- Version 11.0.6 45 | | For an introduction type: /help intro 46 | 47 | jshell> println("Hello world!") 48 | Hello world! 49 | 50 | jshell> _ 51 | 52 | 53 | Startup options 54 | --------------- 55 | 56 | The shell console starts with the options 57 | `--startup DEFAULT --startup PRINTING` so always 58 | the following imports and functions are available: 59 | 60 | - java.io 61 | - java.math 62 | - java.net 63 | - java.nio.file 64 | - java.util 65 | - java.util.concurrent 66 | - java.util.function 67 | - java.util.prefs 68 | - java.util.regex 69 | - java.util.stream 70 | - print (alias of `System.out.print`) 71 | - println (alias of `System.out.println`) 72 | 73 | ### JShell scripts 74 | 75 | If the plugin founds at the root of the project a 76 | [JShell Script](https://docs.oracle.com/javase/9/jshell/scripts.htm) 77 | named `startup.jsh`, it will append to the JShell session 78 | the argument `--startup startup.jsh`, executing 79 | at the beginning all the instructions in the script, 80 | so you can add there all the imports, object definitions 81 | or any Java instruction that you want to execute 82 | at the beginning of the session. 83 | 84 | You can override the startup script path with the project 85 | property `jshell.startup` in the `gradle.properties` file, 86 | or set the same property directly in the command line 87 | arguments: 88 | 89 | $ gradle --console plain jshell -Pjshell.startup=/path/to/run.jsh 90 | 91 | If you have a `startup.jsh` script at the root of the project 92 | but at some point you don't want to execute it nor any other 93 | startup script within the session, just pass the `jshell.startup` property 94 | with an empty value: `gradle --console plain jshell -Pjshell.startup=`. 95 | 96 | 97 | Spring Boot applications 98 | ------------------------ 99 | 100 | The JShell plugin allows to startup a Spring Boot application 101 | within the console and access to the business object from there, 102 | but you will need to do some extra configurations, and add 103 | a dependency to the project to make easier to access 104 | to the Spring beans. 105 | 106 | 1. Setup the plugin following the steps in the 107 | [Getting started](#getting-started) section. 108 | 109 | 2. Add the library [spring-ctx](https://github.com/mrsarm/spring-ctx) 110 | to your dependencies as follows: 111 | 112 | - Add the following dependency to your `dependencies` section: 113 | 114 | ```groovy 115 | implementation 'com.github.mrsarm:spring-ctx:1.0.0' 116 | ``` 117 | 118 | - At the end of the `repositories` section: 119 | 120 | ```groovy 121 | maven { url 'https://jitpack.io' } 122 | ``` 123 | 124 | 3. Any Spring Boot application has a class annotated with 125 | `@SpringBootApplication` that is the starting point of 126 | the application, with a `public static void main(String[] args)` 127 | method, you need to create a [startup.jsh](#startup-options) file 128 | at the root of your project calling that method, eg: 129 | 130 | ```java 131 | com.my.package.MyApplication.main(new String[]{}) 132 | ``` 133 | 134 | You can also add the imports of the business classes you are going 135 | to play with, as many as you have, otherwise you can import them 136 | once the JShell started: 137 | 138 | ```java 139 | import com.my.package.services.MyUserService 140 | ``` 141 | 142 | 4. Done. You can start playing with your Spring application, you can 143 | access to the bean objects once the JShell started as 144 | following: 145 | 146 | ``` 147 | $ ./gradlew --console plain jshell 148 | 149 | . ____ _ __ _ _ 150 | /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ 151 | ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ 152 | \\/ ___)| |_)| | | | | || (_| | ) ) ) ) 153 | ' |____| .__|_| |_|_| |_\__, | / / / / 154 | =========|_|==============|___/=/_/_/_/ 155 | :: Spring Boot :: (v2.2.4.RELEASE) 156 | 157 | 14:43:28.320 INFO com.my.package.MyApplication : Starting Application on kubu1910 with PID 5225 (/projects/... 158 | 14:43:28.323 DEBUG com.my.package.MyApplication : Running with Spring Boot v2.2.4.RELEASE, Spring v5.2.3.RELEASE 159 | 14:43:28.324 INFO com.my.package.MyApplication : The following profiles are active: ... 160 | 14:43:30.229 INFO boot.web.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8010 (http) 161 | 162 | ... 163 | ... 164 | 165 | 14:43:33.729 INFO tuate.endpoint.web.EndpointLinksResolver : Exposing 3 endpoint(s) beneath base path '' 166 | 14:43:33.811 INFO boot.web.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8010 (http) with context path '' 167 | 14:43:33.816 INFO com.my.package.MyApplication : Started Application in 6.995 seconds (JVM running for 10.524) 168 | 169 | > Task :jshell 170 | | Welcome to JShell -- Version 11.0.6 171 | | For an introduction type: /help intro 172 | 173 | jshell> var myUserService = ctx.App.getBean(MyUserService.class) 174 | 175 | jshell> ctx.App.ppjson(myUserService.getByUsername("admin")) 176 | { 177 | "name" : "Jhon", 178 | "lastName" : "Due", 179 | "username" : "admin", 180 | "age" : null 181 | } 182 | ``` 183 | 184 | You can add to the `startup.jsh` not just the call to the `main` method 185 | and useful imports, but also adds the bean declarations you are 186 | going to use most likely, eg. 187 | `var myUserService = ctx.App.getBean(MyUserService.class)`, or any other 188 | snippet of Java code that may save you time running each time the JShell. 189 | 190 | The class `ctx.App` comes from the `spring-ctx` dependency added, checkout the 191 | [documentation](https://github.com/mrsarm/spring-ctx/blob/master/README.md) 192 | of all the useful methods it has to help you to play with 193 | the Spring framework. 194 | 195 | 196 | Troubleshooting 197 | --------------- 198 | 199 | ### JShell warning at startup 200 | 201 | If you see this warning before the jshell console starts: 202 | 203 | > :jshell task :classes not found, be sure to compile the project first 204 | 205 | Means the `classes` task needed to compile your project before launch `jshell` 206 | does not exist, just append in the command line the task needed to compile 207 | the project. Some times is the same `classes` task but is not detected 208 | in multi-modules projects, so you need to add it explicitly in the 209 | Gradle command: 210 | 211 | $ gradle --console plain classes jshell 212 | 213 | Later if you need to run again the JShell but no change to the 214 | source code was performed, you don't need to append the `classes` task, 215 | although the warning will still appear, just ignore it. 216 | 217 | ### The console is exited once started 218 | 219 | Currently, there is an [issue#1](https://github.com/mrsarm/jshell-plugin/issues/1) 220 | (and [issue#4](https://github.com/mrsarm/jshell-plugin/issues/4)) that 221 | the plugin does not work properly with Java 12 and above, exiting 222 | the interactive console as following: 223 | 224 | $ ./gradlew --console plain jshell 225 | > Task :compileJava UP-TO-DATE 226 | > Task :processResources NO-SOURCE 227 | > Task :classes UP-TO-DATE 228 | 229 | > Task :jshellSetup 230 | 231 | > Task :jshell 232 | | Welcome to JShell -- Version 12.0.2 233 | | For an introduction type: /help intro 234 | 235 | BUILD SUCCESSFUL in 1s 236 | 3 actionable tasks: 2 executed, 1 up-to-date 237 | 238 | $ _ 239 | 240 | It's recommended to **use the latest LTS: version 11**, but it works 241 | with Java 9 and 10 as well. Previous versions (Java 8, 7...) are not 242 | supported because the JShell is not built-in on those versions, but 243 | if you want to run the JShell with an old project, pay special attention 244 | to the section bellow. 245 | 246 | Although if you cannot run with a version bellow to Java 12, you are 247 | still able to run [JShell scripts](#jshell-scripts) with the plugin, 248 | but once executed the _.jsh_ script the interactive console will exit. 249 | 250 | ### I have a JDK 9+ installation, but my default JDK is the JDK 8 or below 251 | 252 | In that case Gradle will try to use the default JDK, and `jshell` is 253 | not available in Java 8 and above. Moreover the steps to change the 254 | default JDK vary depending of your system, but Gradle use the default 255 | JDK except if it's defined the `$JAVA_HOME` environment variable, 256 | so when you enter in a new console where you need to use your Java 9+ 257 | installation with Gradle, just export the variable with the path to 258 | the JDK installation, eg: 259 | 260 | $ export JAVA_HOME="/usr/lib/jvm/java-11-openjdk-amd64" 261 | 262 | The export will live just whiting the session where is defined, 263 | it does not change your system configuration globally, and calling 264 | `unset JAVA_HOME` or opening a new session the export will 265 | not have effect anymore. 266 | 267 | You can even create an alias in your `~/.profile` / `~/.bashrc` 268 | file like: `alias usejava9='export JAVA_HOME=/System/Library/Java/...'` 269 | to later switch easily to the other distribution calling 270 | `usejava9`, or `usejava8` to switch back. 271 | 272 | Another good alternative to install and switch between different 273 | versions of Java is [SdkMan!](https://sdkman.io/), totally recommended, 274 | and it also allows to install multiple versions of Gradle, Maven, Kotlin... 275 | and many Java based tools. 276 | 277 | ### Gradle output is mixed with the jshell output in the console 278 | 279 | If content like `<-------------> 0% EXECUTING [16s]` is mixed 280 | in the console with the jshell output each time you try 281 | to execute something within the jshell console, remember to pass 282 | the option `--console plain` to the gradle command, but if 283 | the output continues mixed up with Gradle messages, try 284 | adding the option `--no-daemon` to start up the jshell: 285 | 286 | $ gradle --no-daemon --console plain jshell 287 | 288 | ### Tab completion and arrow keys not working 289 | 290 | Auto-completion does not work, and pressing arrow keys triggers 291 | weird characters in the console. Unfortunately, with the 292 | current console support from Gradle, there is no 293 | solution for this [bug](https://github.com/mrsarm/jshell-plugin/issues/2). 294 | 295 | However, the JShell task can be invoked with the command **rlwrap** from the 296 | console to overcome the arrow keys issues: 297 | 298 | $ rlwrap ./gradlew --console plain jshell 299 | 300 | `rlwrap` takes care of the arrow keys management and history. 301 | Just remember to check you have installed it before invoking the JShell with 302 | the command the first time. 303 | 304 | You can install [rlwrap](https://github.com/hanslub42/rlwrap) on Windows using 305 | Cygwin or MinGW, and on Linux and MacOS. For MacOS, consider installing with 306 | Homebrew: `brew install rlwrap`. 307 | 308 | System Requirements 309 | ------------------- 310 | 311 | * JDK 9+ 312 | * Gradle 313 | 314 | 315 | Build and Publish 316 | ----------------- 317 | 318 | > :information_source: Only for developers that want to make 319 | > changes to this source code. 320 | 321 | To compile this plugin and build the .jar locally, checkout the 322 | source code and execute: 323 | 324 | $ ./gradlew build 325 | 326 | The compilation must be done with the JDK 9 for general release. 327 | 328 | Publish to your local Maven repo (normally `~/.m2/repository/`): 329 | 330 | $ ./gradlew publishToMavenLocal 331 | 332 | Publish to [plugins.gradle.org](https://plugins.gradle.org/): 333 | 334 | $ ./gradlew publishPlugins 335 | 336 | NOTE: Because Java 9 is an old version, the command above might fail in 337 | the execution due SSL issues, in that case better to switch to Java 11 to 338 | execute only the `publishPlugins` command. With Java 17+ it also fails but 339 | because the plugin performs some validations before send the artifacts, but 340 | still the artifacts generated with Java 9 are valid for Java 17+. 341 | 342 | ### Using from the local repo 343 | 344 | To test local changes published to the local repo with the 345 | `publishToMavenLocal` task mentioned above, you need 346 | to add the plugin to the `build.gradle` in the project 347 | where the plugin is tested, in the following manner: 348 | 349 | ```groovy 350 | buildscript { 351 | repositories { 352 | mavenLocal() 353 | maven { 354 | url "https://plugins.gradle.org/m2/" 355 | } 356 | } 357 | dependencies { 358 | classpath "com.github.mrsarm:jshell-plugin:1.2.1" 359 | } 360 | } 361 | 362 | apply plugin: "com.github.mrsarm.jshell.plugin" 363 | ``` 364 | 365 | Also, when launching the plugin from another project, to see the ":jshell" logs 366 | add the `--info` argument in the command line, e.g.: `gradle --console plain jshell --info`. 367 | 368 | About 369 | ----- 370 | 371 | This is a fork of the project https://github.com/bitterfox/jshell-gradle-plugin , 372 | I forked it because the original project is not receiving patches 373 | and this version solves some issues and adds the following features: 374 | 375 | - It works with **multi-module projects**. 376 | - There is no need to set the env variable `JAVA_OPTS` with a bunch 377 | of arguments _"--add-exports jdk.jshell/jdk.intern..."_. 378 | - It allows to run at the beginning of the session a _.jsh_ startup script. 379 | - Special support to the **Spring Framework**. 380 | 381 | **Project**: https://github.com/mrsarm/jshell-plugin 382 | 383 | ### Authors 384 | 385 | - Mariano Ruiz 386 | - https://github.com/bitterfox 387 | (original [project](https://github.com/bitterfox/jshell-gradle-plugin)) 388 | 389 | ### License 390 | 391 | - (2020-2022) [Apache Software License 2.0](https://www.apache.org/licenses/LICENSE-2.0). 392 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.gradle.plugin-publish' version '0.21.0' 3 | id 'maven-publish' 4 | id 'groovy' 5 | id 'java-library' 6 | } 7 | 8 | group 'com.github.mrsarm' 9 | version '1.2.1' 10 | 11 | sourceCompatibility = 9 12 | targetCompatibility = 9 13 | 14 | repositories { 15 | mavenCentral() 16 | } 17 | 18 | dependencies { 19 | implementation gradleApi() 20 | implementation localGroovy() 21 | } 22 | 23 | tasks.withType(GroovyCompile) { 24 | options.fork = false 25 | groovyOptions.fork = false 26 | } 27 | 28 | pluginBundle { 29 | website = 'https://github.com/mrsarm/jshell-plugin' 30 | vcsUrl = 'https://github.com/mrsarm/jshell-plugin' 31 | description = "JShell supports to explore your code and dependencies in your gradle project with in jshell, " + 32 | "the official Java REPL tool (Java 9+)" 33 | tags = ['java9', 'jshell', 'repl'] 34 | 35 | plugins { 36 | jshellPlugin { 37 | id = 'com.github.mrsarm.jshell.plugin' 38 | displayName = 'JShell Plugin' 39 | } 40 | } 41 | } 42 | 43 | publishing { 44 | publications { 45 | maven(MavenPublication) { 46 | artifactId = 'jshell-plugin' 47 | artifact jar 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mrsarm/jshell-plugin/97a7c67f64937830ed83283088c927b0718cfac7/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.3-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'jshell-plugin' 2 | 3 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/mrsarm/jshell/plugin/JShellPlugin.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2020-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.mrsarm.jshell.plugin 17 | 18 | import org.gradle.api.Plugin 19 | import org.gradle.api.Project 20 | import org.gradle.api.Task 21 | import org.gradle.api.tasks.Exec 22 | import org.gradle.api.tasks.JavaExec 23 | 24 | class JShellPlugin implements Plugin { 25 | 26 | private shellArgs = [] 27 | 28 | // This task could be merged with the main task in just one, 29 | // the problem is that the main task is a JavaExec one, 30 | // and at least for now I couldn't find a way 31 | // to get the dependencies list with this type 32 | private Task createJshellSetupTask(Project project) { 33 | Task jshellTask = project.tasks.create('jshellSetup') 34 | def classesTask = project.tasks.find { it.name == "classes" } 35 | if (classesTask) { 36 | jshellTask.logger.info 'Task "classes" found.' 37 | jshellTask.dependsOn classesTask 38 | } else { 39 | jshellTask.logger.warn 'Task "classes" NOT found.' 40 | } 41 | jshellTask.doLast { 42 | if (!jshellTask.dependsOn) { 43 | // Some multi-module projects may not have the :classes task 44 | jshellTask.logger.warn ":jshell task :classes not found, be sure to compile the project first" 45 | } 46 | Set pathSet = [] 47 | project.tasks.withType(JavaExec) { 48 | pathSet.addAll(classpath.findAll { it.exists() }) 49 | } 50 | project.subprojects.each { 51 | it.tasks.withType(JavaExec) { 52 | pathSet.addAll(classpath.findAll { it.exists() }) 53 | } 54 | } 55 | if (pathSet.isEmpty()) { 56 | List classesPaths = project.sourceSets.main.output.getClassesDirs().collect { it.getPath() } 57 | jshellTask.logger.info(':jshell could not find the classpath, adding ' + 58 | 'the following paths from project sourceSets: {}', classesPaths) 59 | pathSet.addAll(classesPaths) 60 | List depsPaths = project.configurations.compileClasspath.collect { it.getPath() } 61 | depsPaths.addAll(project.configurations.runtimeClasspath.collect { it.getPath() }) 62 | jshellTask.logger.info(":jshell could not find the dependencies' classpath, adding " + 63 | 'the following paths from project configurations: {}', depsPaths) 64 | pathSet.addAll(depsPaths) 65 | } 66 | 67 | // Exclude non-directory / non-jar files that jshell doesn't deal with 68 | pathSet = pathSet.findAll{ new File(it.toString()).isDirectory() || it.toString().endsWith('.jar') } 69 | 70 | def path = pathSet.join(System.getProperty("path.separator")) 71 | jshellTask.logger.info(":jshell executing with --class-path {}", path) 72 | shellArgs += [ 73 | "--class-path", path, 74 | "--startup", "DEFAULT", 75 | "--startup", "PRINTING" 76 | ] 77 | if (project.findProperty("jshell.startup") == "") { 78 | jshellTask.logger.info ':jshell "jshell.startup" set to empty, skipping "startup.jsh" execution' 79 | } 80 | else if (project.findProperty("jshell.startup")) { 81 | def jshellStartup = project.findProperty("jshell.startup") 82 | jshellTask.logger.info(":jshell executing with --startup DEFAULT --startup PRINTING " + 83 | "--startup \"{}\"", jshellStartup) 84 | shellArgs += ["--startup", jshellStartup] 85 | } 86 | else { 87 | def startupJsh = new File("${project.projectDir}/startup.jsh") 88 | if (startupJsh.exists()) { 89 | def startupJshPath = startupJsh.absolutePath 90 | jshellTask.logger.info(":jshell executing with --startup DEFAULT --startup PRINTING" + 91 | " --startup \"{}\"", startupJshPath) 92 | shellArgs += ["--startup", startupJshPath] 93 | } else { 94 | jshellTask.logger.info(":jshell did not find a startup.jsh script at the project dir " + 95 | "nor a `jshell.startup` configuration") 96 | } 97 | } 98 | } 99 | return jshellTask 100 | } 101 | 102 | @Override 103 | void apply(Project project) { 104 | Task jshellSetupTask = createJshellSetupTask(project) 105 | project.tasks.register("jshell", Exec) { 106 | group = 'application' 107 | description = 'Runs a JShell session with all the code and dependencies.' 108 | dependsOn jshellSetupTask 109 | doFirst { 110 | standardInput = System.in 111 | executable = "jshell" 112 | args(shellArgs) 113 | } 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/gradle-plugins/com.github.mrsarm.jshell.plugin.properties: -------------------------------------------------------------------------------- 1 | implementation-class=com.github.mrsarm.jshell.plugin.JShellPlugin --------------------------------------------------------------------------------