hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-27 16:57:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

new_project_wizard.md: Add information about generators being limited to Java-IDEs

Browse Source
This commit is contained in:
Karol Lewandowski 2025-04-24 12:51:38 +02:00 committed by Karol Lewandowski
parent a6652fb36a
commit 5a170d3019
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
topics/reference_guide/new_project_wizard.md
View File

@ -1,6 +1,7 @@
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# New Project Wizard # New Project Wizard
<primary-label ref="2024.2"/>
<link-summary>Implementing a custom project and module creation wizard.</link-summary> <link-summary>Implementing a custom project and module creation wizard.</link-summary>
@ -11,6 +12,11 @@ The [New Project](https://www.jetbrains.com/help/idea/new-project-wizard.html) w
- [](#language-project-generators) - [](#language-project-generators)
- [](#framework-project-generators) - [](#framework-project-generators)
> [Language](#language-project-generators) and [framework](#framework-project-generators) project generators described on this page work only in IDEs supporting Java.
> See [](#how-to-implement-a-project-wizard-for-non-java-ides) in the FAQ section.
>
{style="warning"}
## Language Project Generators ## Language Project Generators
Language project generators allow for creating general-purpose projects without specific frameworks (they can be added to the project by users later). Language project generators allow for creating general-purpose projects without specific frameworks (they can be added to the project by users later).
@ -397,6 +403,12 @@ To add a simple comment, use [`CommentNewProjectWizardStep`](%gh-ic%/platform/pl
To additionally render a clickable link to another wizard, use [`LinkNewProjectWizardStep`](%gh-ic%/platform/platform-impl/src/com/intellij/ide/wizard/comment/LinkNewProjectWizardStep.kt), for example, [`MavenArchetypeNewProjectWizard.CommentStep`](%gh-ic%/plugins/maven/src/main/java/org/jetbrains/idea/maven/wizards/archetype/MavenArchetypeNewProjectWizard.kt). To additionally render a clickable link to another wizard, use [`LinkNewProjectWizardStep`](%gh-ic%/platform/platform-impl/src/com/intellij/ide/wizard/comment/LinkNewProjectWizardStep.kt), for example, [`MavenArchetypeNewProjectWizard.CommentStep`](%gh-ic%/plugins/maven/src/main/java/org/jetbrains/idea/maven/wizards/archetype/MavenArchetypeNewProjectWizard.kt).
### How to implement a project wizard for non-Java IDEs?
To create project wizards for non-Java IDEs (for example, [PyCharm](https://www.jetbrains.com/pycharm/)), implement
[`DirectoryProjectGenerator`](%gh-ic%/platform/platform-impl/src/com/intellij/platform/DirectoryProjectGenerator.java)
and register it in the <include from="snippets.topic" element-id="ep"><var name="ep" value="com.intellij.directoryProjectGenerator"/></include>.
### What is the status of `com.intellij.moduleBuilder`? ### What is the status of `com.intellij.moduleBuilder`?
The [`ModuleBuilder`](%gh-ic%/platform/lang-core/src/com/intellij/ide/util/projectWizard/ModuleBuilder.java) API is still supported but is not recommended to use in new projects. The [`ModuleBuilder`](%gh-ic%/platform/lang-core/src/com/intellij/ide/util/projectWizard/ModuleBuilder.java) API is still supported but is not recommended to use in new projects.