1fc7957ab0
* 251: update GH links in topics * code_samples: Gradle 2.x (WIP) * code_samples: Gradle 2.x (WIP) * code_samples: Gradle 2.x (WIP) * code_samples: Gradle 2.x (WIP) * code_samples: Gradle 2.x (WIP) * code_samples: Gradle 2.x (WIP) * GH: theme_basics is not a Gradle project * GH: remove deleted kotlin_demo project * README: remove deleted kotlin_demo project * code_samples: remove product_specific * 2025.1 Beta3 * code_samples: remove obsolete kotlin_demo dir * code_samples: add .intellijPlatform to .gitignore * stub_indexes.md: fix gh link * api_notable_list_2020.md: fix gh link * code_samples: add .gitignore for standalone repo * code_samples: build against latest 2024.2.x, set since-build explicitly * code_samples: fix framework_basics * Update EP and Listener lists * Convert %gh-ic-master% links to %gh-ic% * additional_minor_features.md: Update link to FileIncludeProvider * api_notable_list_2020.md: Add note about internal API * status_bar_widgets.md: Update StatusBarWidget.TextPresentation example The previous example doesn't implement TextPresentation any more. --------- Co-authored-by: Karol Lewandowski <karol.lewandowski@jetbrains.com>
3.6 KiB
Project Model
Introduction to project structure and components.
This topic considers the concept of projects based on the IntelliJ Platform and related subjects, such as modules, libraries, facets, and SDKs.
The API is available since 2024.2 for use by third-party plugins and should be preferred over using the Project Model API. See and .
Since the 2020.3 release, related internal changes are included; see this blog post for details. This shouldn't affect any plugins using the Project Model API properly and which don't access internal classes.
{style="note" title="Workspace Model API (2024.2+)"}
Project
Product Help: Projects
A project encapsulates all of a project's source code, libraries, and build instructions into a single organizational unit.
Everything in the IntelliJ Platform SDK is done within the context of a project.
A project defines collections referred to as Modules and Libraries. Depending on the project's logical and functional requirements, a single-module or a multi-module project can be created.
Module
Product Help: Modules
A module is a discrete unit of functionality that can be run, tested, and debugged independently. Modules include such things as source code, build scripts, unit tests, deployment descriptors, etc.
In a project, each module can use a specific Software Development Kit (SDK) or inherit the SDK defined at the project level. A module can depend on other modules of the project.
Library
Product Help: Libraries
A library is an archive of compiled code (such as JAR files) on which modules depend. The IntelliJ Platform supports three types of libraries: Module, Project, and Global Libraries.
SDK
Product Help: SDK
Every project uses a Software Development Kit (SDK). For Java projects, SDK is referred to as JDK (Java Development Kit).
The SDK determines which API library is used to build the project. For a multi-module project, the project SDK is common for all modules within the project by default. Optionally, a project can configure an individual SDK for each module.
Facet
Product Help: Facets
A facet represents a certain configuration, specific for a particular framework or technology associated with a module. A module can have multiple facets.
Configuration
Product Help: Project Structure
The user can configure all entities listed above in the Project Structure dialog.
Use ProjectSettingsService to open related entries programmatically.