vanutp/cu-kotlin-refactoring

Introduction to IDE Code Refactoring in Kotlin

This course will introduce you to refactorings and the IDE features that will help you to perform them in an effective way. You will learn to recognize refactoring opportunities in code and to deal with them. Using automatic IDE refactorings, you will transform code to improve its structure, readability, and maintainability.

The course consists of 8 sections. Each section focuses on one group of refactorings and provides brief theory and several small tasks for practice. We will move on from small local refactoring changes to more complex ones, which affect the entire project architecture.

Topics covered:

• refactoring definition;
• code quality and code smells;
• kinds of refactoring techniques;
• IDE refactoring features;
• code style and formatting;
• code style schema and EditorConfig;
• automatic formatting using IDE;
• naming rules;
• rename refactoring;
• move refactoring;
• pull up and push down refactoring;
• extract refactoring;
• inline refactoring;
• design patterns and their relationships with refactoring.

Technical requirements

Before starting this course, check the following requirements.

1. Your computer needs to have a stable internet connection.
2. Git version control system needs to be installed on your computer (link to the git site: https://git-scm.com/).
3. Make sure that the path to the root folder of the course does not contain spaces, special characters, or non-Latin characters.
4. Make sure that you use the IntelliJ IDEA with version at least 2023.1.1.
5. Make sure that you use the JetBrains Academy plugin with version at least 2023.1.

The course is integrated into the IntelliJ IDEA IDE, which has a free Community license. You can use this license to complete the course. If you have some troubles with the course installation, feel free to contact us by email at [email protected].

Getting started

This course is available on JetBrains Marketplace and can be installed from the IntelliJ IDEA IDE directly, but you can also use it in the Course Creator mode or create a course archive from the source code.

Getting started: create a course preview from the source code

You can create a course preview from the source code:

1. Clone the repository:

   git clone https://github.com/jetbrains-academy/refactoring-course.git
   

2. Build the project:

   ./gradlew build
   

3. Install the JetBrains Academy plugin from JetBrains Marketplace.

4. Create a new course preview.

Getting started: create a course archive

You can create a course archive from the source code:

1. Clone the repository:

   git clone https://github.com/jetbrains-academy/refactoring-course.git
   

2. Build the project:

   ./gradlew build
   

3. Install the JetBrains Academy plugin from JetBrains Marketplace.

4. Create a new course archive.

Run tests

To run tests locally, you just need to build the project and run the following command:

./gradlew test

The tests use the Java Reflection API under the hood to check the user's tasks.

Want to know more?

If you have questions about the course or the tasks or if you find some errors, you can ask questions and participate in discussions in repository issues.

Contribution

Please be sure to review the project's contributing guidelines to learn how to help the project.