Skip to content

Add JetBrains IDE debug configs #2875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Harjun751 merged 2 commits into from
Mar 28, 2026
Merged

Add JetBrains IDE debug configs #2875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74961fc
Add basic JetBrains debug configs
Harjun751 Mar 27, 2026
0ca0466
Add comment on debug configs in docs
Harjun751 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ packages/cli/test/functional/test_site_templates/test_project/expected/diagrams/

# JetBrains configurations
.idea/
.run/

# Compiled files from TypeScript
*.js.map
Expand Down
15 changes: 15 additions & 0 deletions .run/cli _ test.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="cli &gt; test" type="js.build_tools.npm">
<package-json value="$PROJECT_DIR$/packages/cli/package.json" />
<command value="run" />
<scripts>
<script value="test" />
</scripts>
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
12 changes: 12 additions & 0 deletions .run/core _ test.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="core &gt; test" type="js.build_tools.npm" nameIsGenerated="true">
<package-json value="$PROJECT_DIR$/packages/core/package.json" />
<command value="test" />
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
15 changes: 15 additions & 0 deletions .run/root _ build_backend.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="root &gt; build:backend" type="js.build_tools.npm">
<package-json value="$PROJECT_DIR$/package.json" />
<command value="run" />
<scripts>
<script value="build:backend" />
</scripts>
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
15 changes: 15 additions & 0 deletions .run/root _ build_docs.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="root &gt; build:docs" type="js.build_tools.npm">
<package-json value="$PROJECT_DIR$/package.json" />
<command value="run" />
<scripts>
<script value="build:docs" />
</scripts>
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
15 changes: 15 additions & 0 deletions .run/root _ dev.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="root &gt; dev" type="js.build_tools.npm">
<package-json value="$PROJECT_DIR$/package.json" />
<command value="run" />
<scripts>
<script value="dev" />
</scripts>
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
12 changes: 12 additions & 0 deletions .run/root _ test.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="root &gt; test" type="js.build_tools.npm">
<package-json value="$PROJECT_DIR$/package.json" />
<command value="test" />
<node-interpreter value="project" />
<envs />
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
8 changes: 8 additions & 0 deletions .run/serve -d.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="serve -d" type="NodeJSConfigurationType" application-parameters="serve -d" path-to-js-file="$PROJECT_DIR$/packages/cli/dist/index.js" working-dir="$PROJECT_DIR$/docs">
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
8 changes: 8 additions & 0 deletions .run/serve.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="serve" type="NodeJSConfigurationType" application-parameters="serve" path-to-js-file="$PROJECT_DIR$/packages/cli/dist/index.js" working-dir="$PROJECT_DIR$/docs">
<EXTENSION ID="com.intellij.javascript.debugger.execution.StartBrowserRunConfigurationExtension">
<browser with-js-debugger="true" />
</EXTENSION>
<method v="2" />
</configuration>
</component>
6 changes: 6 additions & 0 deletions docs/devGuide/development/settingUp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ This page explains how to set up your development environment to start contribut
<box type="tip" seamless>

We recommend the **WebStorm IDE** or **VS Code** for working with MarkBind code.

**JetBrains users:** Run configurations are included in the repository under `.run/`. After cloning, WebStorm (and other JetBrains IDEs) will pick these up automatically. The configurations cover:
- `root | test`, `cli | test`, `core | test` — run the test suites
- `root | build_backend`, `root | build_docs` — build targets
- `root | dev` — starts the dev watcher
- `serve`, `serve -d` — serves the docs site, with and without debug mode
</box>

## Setting up the dev environment
Expand Down
Loading