-
Notifications
You must be signed in to change notification settings - Fork 1k
Migrate project to use IntelliJ instead of Eclipse #83 #84
Conversation
As we are moving to IntelliJ, the Eclipse project files are no longer needed. Let's remove them.
@yamgent, thanks for your PR! By analyzing the history of the files in this pull request, we identified @damithc, @louietyj and @weikangchia to be potential reviewers. |
v1@yamgent submitted v1 for review.
Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/1/head:BRANCHNAME where |
0c5723b
to
1ae10bd
Compare
v2@yamgent submitted v2 for review.
(📚 Archive) (📈 Interdiff between v1 and v2) Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/2/head:BRANCHNAME where |
doc/DeveloperGuide.md
Outdated
2. Press <kbd>ALT</kbd>+<kbd>ENTER</kbd> and select `Add 'JUnit4' to classpath` | ||
3. Select `Use 'JUnit4' from IntelliJ IDEA distribution` and click `OK` | ||
10. Set the working directory of tests to the project directory | ||
1. Ensure that you have run all the tests cases (if not, right-click the `test` folder, and click `Run 'All Tests'`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had to indent one more space, because GitHub doesn't render this inner list properly otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a separate section for testing later in this doc, which is still written for Eclipse BTW. Do a project-wide search for Eclipse
to be safe.
doc/DeveloperGuide.md
Outdated
2. Press <kbd>ALT</kbd>+<kbd>ENTER</kbd> and select `Add 'JUnit4' to classpath` | ||
3. Select `Use 'JUnit4' from IntelliJ IDEA distribution` and click `OK` | ||
10. Set the working directory of tests to the project directory | ||
1. Ensure that you have run all the tests cases (if not, right-click the `test` folder, and click `Run 'All Tests'`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a separate section for testing later in this doc, which is still written for Eclipse BTW. Do a project-wide search for Eclipse
to be safe.
99ec3c1
to
aa1379d
Compare
v3@yamgent submitted v3 for review.
(📚 Archive) (📈 Interdiff between v2 and v3) Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/3/head:BRANCHNAME where |
doc/UserGuide.md
Outdated
> When running the program inside Eclipse, you can | ||
[set command line parameters before running the program](http://stackoverflow.com/questions/7574543/how-to-pass-console-arguments-to-application-in-eclipse). | ||
> When running the program inside IntelliJ, you can | ||
[set command line parameters before running the program](https://stackoverflow.com/a/2066465). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On a side note, I don't think we have this feature in addressbook-level3
. I looked around the code and there is nowhere that reads in the command line parameter and pass that into StorageFile(String filePath)
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can remove in that case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I also created issue #85 about this.
Also should we update LearningOutcomes.md to point to the tutorial's intelliJ version? |
Yup. |
v4@yamgent submitted v4 for review.
(📚 Archive) (📈 Interdiff between v3 and v4) Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/4/head:BRANCHNAME where |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just a couple of cosmetic suggestions.
doc/DeveloperGuide.md
Outdated
2. Press <kbd>ALT</kbd>+<kbd>ENTER</kbd> and select `Add 'JUnit4' to classpath` | ||
3. Select `Use 'JUnit4' from IntelliJ IDEA distribution` and click `OK` | ||
10. Set the working directory of tests to the project directory | ||
1. Ensure that you have run all the tests cases (if not, right-click the `test` folder, and click `Run 'All Tests'`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence comes as a surprise. Is running test cases part of the set up process. I don't see any instructions to that effect prior to this sentence.
doc/LearningOutcomes.md
Outdated
@@ -84,11 +84,11 @@ Covered by `[LO-Polymorphism]` | |||
|
|||
**Resources** | |||
|
|||
* [JavaFX 8 Tutorial](http://code.makery.ch/library/javafx-8-tutorial/) by Marco Jakob | |||
* [JavaFX 8 Tutorial](https://se-edu.github.io/se-book/javaTools/javaFXBasic/) adapted with permission from Marco Jakob |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to mention adapted with permission from Marco Jakob
here as it is already mentioned in the tutorial itself.
c8e8965
to
85c44c2
Compare
v5@yamgent submitted v5 for review.
(📚 Archive) (📈 Interdiff between v4 and v5) Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/5/head:BRANCHNAME where |
doc/DeveloperGuide.md
Outdated
2. Go to `Run` -> `Edit Configurations...` | ||
3. On the list at the left, ensure that `All in test` is selected | ||
4. Under `Configuration`, change the `Working directory` to the `addressbook-level3` folder | ||
5. Click `OK` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this?
10. Run all the tests (right-click the `test` folder, and click `Run 'All Tests'`)
11. Observe how some tests fail. That is because they try to access the test data from the wrong directory (the working directory is expected to be the root directory, but IntelliJ runs the test with `test\` as the working directory by default). To fix this issue:
1. Go to `Run` -> `Edit Configurations...`
2. On the list at the left, ensure that `All in test` is selected
3. Under `Configuration`, change the `Working directory` to the `addressbook-level3` folder
4. Click `OK`
12. Run the tests again to ensure they all pass now.
85c44c2
to
1df7fce
Compare
We are no longer using Eclipse as our development environment. The instructions in the developer guide are outdated. Let's migrate the setup instructions to IntelliJ.
We are no longer using Eclipse as our development environment. The instructions in the user guide are outdated. Let's migrate the instructions to IntelliJ.
The UserGuide claims that the save location of the addressbook data can be changed via command line parameters. That feature is not fully implemented. As such, addressbook data is always saved in addressbook.txt and cannot be changed. Let's remove the section "Changing Save Location". We can restore this section after the feature is fully implemented.
1df7fce
to
f52126c
Compare
v6@yamgent submitted v6 for review.
(📚 Archive) (📈 Interdiff between v5 and v6) Checkout this PR version locallygit fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/6/head:BRANCHNAME where |
Fixes #83.