intellij-sdk-code-samples/project_structure.md at ea51a857488f15b19036152c82118a116a4d94e6

mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00

Jakub Chrzanowski 4e802980f2

* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26

* [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles

* [webhelp] Fixes for Part #5 TXP00017

* [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin".

* [webhelp] Removed numbers from page section titles in rest of project *.md files.

* [new webhelp] Build #44 changes

* [new webhelp] Maintenance merge from master

* [new webhelp] Add placeholder file for webhelp import.

* [webhelp] Correct redirects for file name changes

* [webhelp] TOC not needed in webhelp

* [format] {:toc} not needed for webhelp

* add {:disable-links} to ensure demo links are not interpreted as real links.

* Put all badges on the same line to simplify composition.

* formatter.md: fix upsource link

* fix some links

* api_changes_list.md: remove note

* migrate to webhelp - initial

* fix GH edit URL

* remove sdkdocs-template setup in VCS config

* remove recently_updated.md

* restore COC/CONTRIBUTING.md

* api_changes_list.md: remove note

* useful_links.md: IPE

Co-authored-by: JohnHake <john.hake@jetbrains.com>
Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>

2021-01-14 16:07:39 +01:00

4.4 KiB

Raw Blame History

This topic considers the concept of projects based on the IntelliJ Platform and related subjects, such as modules, facets, libraries, and SDK. The project structure and Java classes available to manage projects and modules are discussed.

Internal changes related to a significant redesign of the representation of project models are included in 2020.3 release; please see blog post for details. This shouldn’t affect any plugins using the IntelliJ API properly and which don’t access internal classes.

{type="note"}

Project and Its Components

This section briefly discusses the IDEA project structure, project components, and related terms. For more information about projects and their components, refer to Project, Module, Library, Facet in the IntelliJ IDEA Web Help.

Project

In the IntelliJ Platform, a project encapsulates all of a project's source code, libraries, and build instructions into a single organizational unit. Everything done using 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, you can create a single-module or a multi-module project.

Module

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 SDK or inherit the SDK defined at the project level (see the SDK section below in this document). A module can depend on other modules of the project.

Library

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 Library: the library classes are visible only in this module, and the library information is recorded in the module's .iml file.
Project Library: the library classes are visible within the project, and the library information is recorded in the project's .ipr file or in .idea/libraries.
Global Library: the library information is recorded in the applicationLibraries.xml file in the ~/.IntelliJIdea/config/options directory. Global libraries are similar to project libraries but are visible for different projects.

For more information about libraries, refer to Library.

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. If a project is multi-module, the project SDK is common for all modules within the project by default. Optionally, a project can configure an individual SDK for each module.

For more information about SDKs, see Working with SDKs in the IntelliJ IDEA Web Help.

Facet

A facet represents a certain configuration, specific for a particular framework/technology associated with a module. A module can have multiple facets. E.g., Spring-specific configuration is stored in a Spring facet.

Facets are documented under Facet and Language and Framework Specific Guidelines in the IntelliJ IDEA Web Help.

Additional Information

For more information on each of these entities, see:

Project
Module
SDK
Library
External system integration (for projects imported from Gradle or similar build systems)

4.4 KiB Raw Blame History Unescape Escape