jSparrow
FAQ
Your comprehensive list of frequently asked questions and troubleshooting
Installation
Where do I install jSparrow?
Please drag and drop this button into your Eclipse IDE:
Installation Troubleshooting
Installation Video
I could not install jSparrow
Please open your Eclipse IDE and try downloading jSparrow directly from the built-in Eclipse marketplace
I tried installing via the Eclipse IDE marketplace, still doesn’t work
Please try the manual installation guide for jSparrow
I tried the manual installation, it still doesn’t work
Please use the Report an Issue form and we’ll do our best to help you as soon as possible
Support
I need help
Please feel free to use our contact form to contact us. You can also send your message here: office@jsparrow.io
Subscription
How to unsubscribe from Newsletter?
To unsubscribe from the jSparrow newsletter please open the latest newsletter and scroll down to the footer of the e-mail, there you will find the unsubscribe link.
Plugin Q/A
Does the plugin store my code or files?
No
Does the plugin store my activities?
No
Does the plugin use AI?
No. AI tools can suggest refactorings in amazing speeds, but the computed suggestion has not been tested and might be insecure. Instead of AI, our developers implements and tests all our rules extensively in-house.
A plus is that jSparrow can suggest a multitude of quick-fixes across Java files AND it allows you to review everything in the diff-view.
Does the plugin send code snippets to an external server?
No. Both the analysis and refactoring happen completely offline.
The plugin is based on Eclipse JDT which is provided within the IDE. The plugin does not transfer the code to any external server or third party.
Can I use the plugin locally, without internet access?
Yes, everyone can compute all refactorings completely offline.
Intellectual Property? Who owns the refactored code?
You. jSparrow doesn’t claim any rights over your code — before or after refactoring. Everything it analyzes, transforms, or generates remains 100% your property.
If code breaks when I use jSparrow, who is responsible?
We do not recommend using any tools or plugins without having a reliable backup process for all your projects. jSparrow can not take responsibility for code breaks although we extensively test all rules with a multitude of test cases before releasing a refactoring.
We recommend working closely with the plugin as it allows you to review the original and the refactored code in its diff view. You can easily deselect changes you don’t want before committing there.
To avoid potential programming disasters, we also recommend having a backup process as a crucial part of your pipeline.
Do you still make new rules?
No. But we are open for collaborations and requests! Contact us and we can discuss your ideas.
I found a bug in jSparrow
We’re sorry to hear that. Please use the Report an issue form so we can fix it immediately.
What is jSparrow?
Non-technical version
This tool is all about precision and keeping your code in top shape. jSparrow can help you maintain the high code standard you aim for. It’s like having a personal assistant for “refactoring” – that’s the fancy term for cleaning your code without changing the necessary features.
jSparrow’s Pipeline (Quite technical)
For each selected Java source file, a new state is created. Each state consists of the original file and a working copy that is subsequently analyzed with the refactoring rules. jSparrow then iterates over all the states, parses each working copy, and applies all the selected rules to it.
The working copies are then parsed and adjusted after each rule execution. Important: on this step, the original sources remain intact.
As a final step, the developer can (un)select changes and when the developer is ready, they can click on “finish”. Then the selected refactorings will be persisted on the original sources.
Some refactoring rules have requirements e.g. minimum Java version. Therefore, jSparrow’s pipeline contains functionalities to dump or recompute refactorings of certain rules on certain files to adhere to the requirements.
Is jSparrow Safe?
Yes, jSparrow is safe. Over 6000+ people use jSparrow in their projects. We’re also an established IT-consulting company since 2004.
Eclipse IDE Plugin In-Depth
jSparrow Rule Profiles
We thought, developers don’t want all the rules at once, so we created profiles where they can group rules together to ease the workflow.
To create a new profile please see how to add profiles.
Markers / Quick-fixes
The jSparrow Markers make use of the JDT support for so-called Quick Fixes. Markers give you the ability to click on and choose an automatic fix to various problems.
The jSparrow Markers work like the Quick Fixes of Sonarlint and JDTSpelling.
Quick link to how to de-activate markers.
Logging (Interactive UI Included)
The ‘System out to logging’ rule is an interactive Rule and it introduces the replacement of System.out statements (println, error, e.printstacktrace) with a logging statement. This rule requires the configuration of a logging environment (log4j, slf4j).
Quick link to how to configure Logging.
Rename Fields (Interactive UI Included)
The ‘Rename Fields ‘ rule is an interactive Rule. This rule finds fields that do not comply with the Java Naming Conventions and renames them according to your choices.
Quick link to how to configure Rename Fields.
Remove Unused Code (Interactive UI Included)
This wizard makes it easy to remove Unused Methods, Unused Fields, and Unused Types.
Other Environments and IDEs
jSparrow Maven and Cloud App
jSparrow is a plugin for Eclipse IDE, Maven, and GitHub. However, jSparrow for Maven and GitHub is currently only available through contacting us.
Licensing and Plans Q/A
Where do I buy a license?
jSparrow is open-source, no license required since 4.20.0!