Created IntelliJ template project #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fixed formatting issues according to markdownlint - Added instructions for opening the source code in an IDE
|
This looks great, and is timely! I like the way the README shows multiple options for IDEs. I have on my to-do list to make things work "out of the box" for vscode as well. Let me finish the semester, and I'll take a closer look. Thank you for sharing. |
|
Made a few changes. CheckStyle should now just work if the CheckStyle-IDEA plugin is installed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi!
My name is Jonathan Colmenares, but I mostly go around online as Jonathing.
Why did I make this?
I've been using Think Java, 2nd Edition as the textbook for my computer science class this semester (props to you for such a good book, by the way) and I recently came across the source code for the textbook, since I needed it to be able to get the proper context for some of the information I needed. I wanted to open one of the chapter folders as a project since IntelliJ has a feature to allow importing Eclipse projects into IntelliJ, but since each of the chapter folders were part of a larger workspace, IntelliJ would throw a fit whenever I tried to open one of the folders to play with the source code on my own.
What did I do?
What I've done is created a template IntelliJ project for anyone to be able to open and play with the code on their own (granted, if they use IntelliJ. I'm sure Eclipse would work just fine with it). I've organized each of the chapter files into a module so that IntelliJ respects that each folder is its own workspace and doesn't try to shove the java files into packages. I've also been able to import the same code-formatting rules by importing the eclipse
Formatter.xmlfile. Here's an image of what this looks like below.In addition, I've modified the
README.mdfile in the root of the repository to include instructions on how to open the source-code in their preferred IDE, and I've fixed some minor formatting issues that may have been a slight annoyance. I also took the liberty to add the book's cover to the top of the file and have it act as a link to the publisher's page for it!I truly hope this small, yet meaningful PR proves meaningful to you! Cheers.
tl;dr
README.mdfile looks prettier.