Skip to content
This repository has been archived by the owner on Jul 26, 2019. It is now read-only.

Migrate project to use IntelliJ instead of Eclipse #83 #84

Merged
merged 5 commits into from
Aug 19, 2017

Conversation

yamgent
Copy link
Member

@yamgent yamgent commented Aug 16, 2017

Fixes #83.

As we are moving to IntelliJ, the Eclipse project files are no longer
needed.

Let's remove them.
@mention-bot
Copy link

@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.

@CanIHasReview-bot
Copy link

v1

@yamgent submitted v1 for review.

(📚 Archive)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/1/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

@CanIHasReview-bot
Copy link

v2

@yamgent submitted v2 for review.

(📚 Archive) (📈 Interdiff between v1 and v2)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/2/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

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'`)
Copy link
Member Author

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.

Copy link
Contributor

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.

@yamgent yamgent requested a review from damithc August 16, 2017 01:34
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'`)
Copy link
Contributor

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.

@yamgent yamgent force-pushed the 83-migrate-intellij branch 2 times, most recently from 99ec3c1 to aa1379d Compare August 16, 2017 14:10
@CanIHasReview-bot
Copy link

v3

@yamgent submitted v3 for review.

(📚 Archive) (📈 Interdiff between v2 and v3)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/3/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

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).
Copy link
Member Author

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).

Copy link
Contributor

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.

Copy link
Member Author

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.

@yamgent
Copy link
Member Author

yamgent commented Aug 16, 2017

Also should we update LearningOutcomes.md to point to the tutorial's intelliJ version?

@damithc
Copy link
Contributor

damithc commented Aug 16, 2017

Also should we update LearningOutcomes.md to point to the tutorial's intelliJ version?

Yup.

@CanIHasReview-bot
Copy link

v4

@yamgent submitted v4 for review.

(📚 Archive) (📈 Interdiff between v3 and v4)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/4/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

@yamgent yamgent requested review from damithc and removed request for damithc August 17, 2017 08:22
Copy link
Contributor

@damithc damithc left a 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.

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'`)
Copy link
Contributor

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.

@@ -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
Copy link
Contributor

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.

@yamgent yamgent force-pushed the 83-migrate-intellij branch 2 times, most recently from c8e8965 to 85c44c2 Compare August 19, 2017 03:43
@CanIHasReview-bot
Copy link

v5

@yamgent submitted v5 for review.

(📚 Archive) (📈 Interdiff between v4 and v5)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/5/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

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`
Copy link
Contributor

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.

@yamgent yamgent force-pushed the 83-migrate-intellij branch from 85c44c2 to 1df7fce Compare August 19, 2017 05:08
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.
@yamgent yamgent force-pushed the 83-migrate-intellij branch from 1df7fce to f52126c Compare August 19, 2017 05:11
@CanIHasReview-bot
Copy link

v6

@yamgent submitted v6 for review.

(📚 Archive) (📈 Interdiff between v5 and v6)

Checkout this PR version locally
git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/84/6/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

@yamgent yamgent merged commit 0c99fd0 into se-edu:master Aug 19, 2017
@yamgent yamgent deleted the 83-migrate-intellij branch August 19, 2017 16:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants