JetBrains MPS

https://www.jetbrains.com/help/mps
Admin
JetBrains MPS is a powerful tool for language creation and manipulation, offering a projectional...
Tokens:198,930
Snippets:3,552
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Toolbox App on Linux

Source: https://www.jetbrains.com/help/mps/installation-guide.html

Execute the application binary from the installation directory.

```bash
./bin/jetbrains-toolbox
```

--------------------------------

### mps_mcp_initialize_project_for_agents

Source: https://www.jetbrains.com/help/mps/mps-projectional-agent-toolkit.html

Installs AI-agent skill catalogs and guide files into an MPS checkout.

```APIDOC
## mps_mcp_initialize_project_for_agents

### Description
Installs AI-agent skill catalogs and guide files into an MPS checkout.
```

--------------------------------

### Install plugin via command line on Windows

Source: https://www.jetbrains.com/help/mps/managing-plugins.html

Use the mps64.exe executable in the bin directory to install a plugin by its ID.

```bash
mps64.exe installPlugins <PluginID>
```

```bash
mps64.exe installPlugins org.jetbrains.plugins.github
```

--------------------------------

### Install plugin via command line on Linux

Source: https://www.jetbrains.com/help/mps/managing-plugins.html

Use the mps.sh script in the bin directory to install a plugin by its ID.

```bash
mps.sh installPlugins <PluginID>
```

```bash
mps.sh installPlugins org.jetbrains.plugins.github
```

--------------------------------

### Create a Queue

Source: https://www.jetbrains.com/help/mps/queue.html

Examples of initializing a new queue with initial values or from an existing sequence.

```MPS
queue<string> test = new linkedlist<string> {"A", "B", "C"};
```

```MPS
queue<Type> = new linkedlist<Type> (sequence);
```

--------------------------------

### Java foreach loop examples

Source: https://www.jetbrains.com/help/mps/typesystem.html

Examples of foreach loops demonstrating type relationships between iterables and variables.

```Java
for (String s : new ArrayList<String>(...)) {
...
}
```

```Java
for (Object o : new ArrayList<String>(...)) {
...
}
```

--------------------------------

### Managing module dependencies

Source: https://www.jetbrains.com/help/mps/using-model-module-dependencies-faq.html

Examples for accessing, adding, and modifying module dependencies and used languages.

```MPS
// Module dependencies

// accessing module dependencies
<SDependency> dependencies = module.getDeclaredDependencies()
```

```MPS
// adding used language to a module

AbstractModule internalModule = (AbstractModule) sModule;
internalModule.getModuleDescriptor().getUsedLanguages().add(
module reference
/jetbrains.mps.baseLanguage/);
```

```MPS
// modify module dependencies

<Dependency> internalDependencies = internalModule.getModuleDescriptor().getDependencies();
<SModuleReference> usedModuleReferences = internalDependencies.select({~it => it.getModuleRef(); });
internalModule.getModuleDescriptor().getDependencies().add(new Dependency(module reference/closures.runtime/, SDependencyScope.DEFAULT, false));
```

--------------------------------

### Unpack Toolbox App on Linux

Source: https://www.jetbrains.com/help/mps/installation-guide.html

Extract the downloaded tarball to the desired installation directory.

```bash
tar -xvf jetbrains-toolbox-<version>.tar.gz -C <installation-directory>
```

--------------------------------

### Example platform properties configuration

Source: https://www.jetbrains.com/help/mps/tuning-the-ide.html

A sample configuration file showing how to set custom values for file size limits and console buffer sizes.

```properties
idea.max.intellisense.filesize=5000
idea.cycle.buffer.size=1024
```

--------------------------------

### Example JVM options file configuration

Source: https://www.jetbrains.com/help/mps/tuning-the-ide.html

A sample configuration file showing how to specify memory heap limits and garbage collection ratios, with each option on a new line.

```text
-Xmx4G
-Xms2G
-XX:NewRatio=4
```

--------------------------------

### Retrieve a Tail Set

Source: https://www.jetbrains.com/help/mps/sorted-set.html

Get a subset of elements starting from the specified element to the end of the set.

```MPS
set.tailSet (from);
```

--------------------------------

### Retrieve a Sub Set

Source: https://www.jetbrains.com/help/mps/sorted-set.html

Get a subset of elements between two specified boundaries, inclusive of the start and exclusive of the end.

```MPS
set.tailSet (from,upTo);
```

--------------------------------

### Define a flag keyword example

Source: https://www.jetbrains.com/help/mps/editor-cookbook.html

Example of a class definition with a flag keyword.

```text
private abstract class MyCalculator { ... } 
```

--------------------------------

### Configure product-info.json for Windows

Source: https://www.jetbrains.com/help/mps/migration-guide.html

Copy the Windows-specific product-info JSON file to the root folder during the build process.

```text
zip Project13-${build.number}.zip
...
    file ./solutions/Project13.build/source_gen/Project13/build/product-info-windows-amd64.json (644)
        filename glob mapper "*" -> product-info.json
        replace regex "$version$" /g -> ${version}
        replace regex "$build$" /g -> ${build.number}
        replace regex "$path.selector$" /g -> project1.0
        fix eol: convert to the pair CRLF, remove eof (Ctrl-Z): true
...
```

--------------------------------

### Configure product-info.json for Linux

Source: https://www.jetbrains.com/help/mps/migration-guide.html

Copy the Linux-specific product-info JSON file to the root folder during the build process.

```text
tar Project13-${build.number}.tar.gz (compression gzip)
...
    file ./solutions/Project13.build/source_gen/Project13/build/product-info-linux-amd64.json (644)
        filename glob mapper "*" -> product-info.json
        replace regex "$version$" /g -> ${version}
        replace regex "$build$" /g -> ${build.number}
        replace regex "$path.selector$" /g -> project1.0
        fix eol: convert to a single LF, remove eof (Ctrl-Z): true
...
```

--------------------------------

### Install GPG on macOS

Source: https://www.jetbrains.com/help/mps/set-up-GPG-commit-signing.html

Command to install GPG and pinentry-mac using Homebrew.

```bash
brew install gnupg pinentry-mac
```

--------------------------------

### Configure Linux and Windows Startup Binaries

Source: https://www.jetbrains.com/help/mps/building-standalone-ides-for-your-languages.html

Defines the file mapping and naming conventions for IDE startup executables on Linux and Windows.

```text
file $mps_home/bin/linux/mps (755)
filename glob mapper "*" -> projectname
...

# Startup .exe file
file $mps_home/bin/win/mps64.exe (755)
filename glob mapper "*" -> projectname64.exe
```

--------------------------------

### Install GPG on Linux

Source: https://www.jetbrains.com/help/mps/set-up-GPG-commit-signing.html

Command to install necessary GPG packages on Ubuntu or Debian distributions.

```bash
sudo apt -y install gnupg2 gnupg-agent pinentry-gnome3
```

--------------------------------

### Configure product-info.json for Windows

Source: https://www.jetbrains.com/help/mps/building-standalone-ides-for-your-languages.html

Specifies the build configuration for the product-info.json file, including regex replacements for versioning and build numbers.

```text
file ./solutions/Project9.build/source_gen/Project9/build/product-info-windows-amd64.json (644)
filename glob mapper "*" -> product-info.json
replace regex "\$version\$" /g -> ${version}
replace regex "\$build\$" /g -> ${build.number}
replace regex "\$path\.selector\$" /g -> 1.0
fix eol: convert to the pair CRLF, remove eof (Ctrl-Z): true
```

--------------------------------

### page(start, end)

Source: https://www.jetbrains.com/help/mps/sequence.html

Returns a sub-sequence containing elements from index start up to (but not including) index end.

```APIDOC
## page(start, end)

### Description
Results in a sequence that is a sub-sequence of the original one, containing all elements starting with the element at index start and up to (but not including) the element at index end.

### Parameters
- **start** (int) - Required
- **end** (int) - Required
```

--------------------------------

### Configure JVM Options

Source: https://www.jetbrains.com/help/mps/run-debug-configuration-java-application.html

Example of specifying JVM options including memory settings, system properties with spaces, and environment variable injection.

```text
-Xmx1024m -Dspaces="some arg" -Dmy.prop="quoted_value" -Dfoo=${MY_ENV_VAR}
```

--------------------------------

### Trigger feature usage for productivity guide

Source: https://www.jetbrains.com/help/mps/contributing-to-mps-project.html

Use this call within an action to track feature usage for the productivity guide.

```java
FeatureUsageTracker.getInstance().triggerFeatureUsed("my.key");
```

--------------------------------

### Swing Component Initialization

Source: https://www.jetbrains.com/help/mps/generator-user-guide-demo3.html

Example of the basic Java statement used in Demo 2 to instantiate and add a Swing component.

```java
container.add(new JButton());
```

--------------------------------

### Configure product-info.json for MacOS

Source: https://www.jetbrains.com/help/mps/migration-guide.html

Copy the MacOS-specific product-info JSON file to the Resources folder during the build process.

```text
zip Project13-${build.number}.macos.zip
...
  folder Resources
    file ./solutions/Project13.build/source_gen/Project13/build/product-info-macos-amd64.json (644)
      filename glob mapper "*" -> product-info.json
      replace regex "$version$" /g -> ${version}
      replace regex "$build$" /g -> ${build.number}
      replace regex "$path.selector$" /g -> project1.0
      fix eol: convert to a single LF, remove eof (Ctrl-Z): true
...
```

--------------------------------

### Get key from mapping

Source: https://www.jetbrains.com/help/mps/mapping.html

Retrieves the key from the mapping.

```MPS
mapping.key;
```

--------------------------------

### Implement Action Execution Logic

Source: https://www.jetbrains.com/help/mps/howto-adding-additional-tools-aka-views.html

Retrieves the tool instance and opens it with the current editor context.

```MPS
execute(event)->void {
  tool<Outline> outline = this.project.tool<Outline>;
  outline.setEditor(this.editor);
  outline.openTool(true);
}
```

--------------------------------

### Get value from mapping

Source: https://www.jetbrains.com/help/mps/mapping.html

Retrieves the value associated with the mapping.

```MPS
mapping.value
```

--------------------------------

### Null-Safe Navigation

Source: https://www.jetbrains.com/help/mps/smodel-language-queries.html

Example of chaining casts with the null-safe dot operator.

```SModel
node.parent as BinaryOperation.leftExpression as BinaryOperation.leftExpression.isLValue()
```

--------------------------------

### headSet

Source: https://www.jetbrains.com/help/mps/sorted-set.html

Returns a subset of elements from the start up to, but not including, the specified element.

```APIDOC
## headSet

### Description
Results in a sorted_set that is a subset of all elements from the original set in the original sorting order, starting with the first element and up to but not including the specified element.

### Syntax
`set.headSet(upTo)`
```

--------------------------------

### skip(count)

Source: https://www.jetbrains.com/help/mps/sequence.html

Produces a sub-sequence containing all elements starting from the specified index.

```APIDOC
## skip(count)

### Description
Produces a sequence that is a sub-sequence of the original one, containing all elements starting with the element at index count.

### Parameters
- **count** (int) - Required
```

--------------------------------

### Install plugin via command line on macOS

Source: https://www.jetbrains.com/help/mps/managing-plugins.html

Use the open command to pass the installPlugins argument to the MPS application.

```bash
open -na "MPS.app" --args installPlugins <PluginID>
```

```bash
open -na "MPS.app" --args installPlugins org.jetbrains.plugins.github
```

--------------------------------

### take(count)

Source: https://www.jetbrains.com/help/mps/sequence.html

Produces a sub-sequence starting from the first element with a specified size.

```APIDOC
## take(count)

### Description
Produces a sequence that is a sub-sequence of the original one, starting from the first element and of size count.

### Parameters
- **count** (int) - Required
```

--------------------------------

### Configure Mac platform executables

Source: https://www.jetbrains.com/help/mps/migration-guide.html

Specify the correct launcher and restarter executables for x64 and ARM architectures.

```text
for x64:

folder MacOS
  file $mps_home/bin/mac/Contents/MacOS/mps-x64 (755)
    filename glob mapper "*" -> rcpname
folder bin
  ...
  file $mps_home/bin/mac/amd64/restarter (755)
...
```

```text
for ARM:

folder MacOS
  file $mps_home/bin/mac/Contents/MacOS/mps-aarch64 (755)
    filename glob mapper "*" -> rcpname

folder bin
  ...
  file $mps_home/bin/mac/aarch64/restarter (755)
...
```

--------------------------------

### Skip elements

Source: https://www.jetbrains.com/help/mps/sequence.html

Produces a sub-sequence containing all elements starting from the specified index.

```text
seq.skip (count)
```

--------------------------------

### Implement a Read-Only Tool

Source: https://www.jetbrains.com/help/mps/writing-mps-mcp-tools-plugin.html

Example of a tool implementation using the project wrapper and read-only model access.

```kotlin
suspend fun my_mcp_describe(nodeReference: String): String =
    withMpsProject("Describing node") { mpsProject ->
        executeShortReadOnEdt(mpsProject) {
            val ref = resolveNodeReference(mpsProject, nodeReference)
                ?: return@executeShortReadOnEdt invalidReference("Bad reference: $nodeReference")
            val node = ref.resolve(mpsProject.repository)
                ?: return@executeShortReadOnEdt errJson("Not found", McpErrorCode.NOT_FOUND)
            okJson(describe(node))
        }
    }
```

--------------------------------

### Take sub-sequence

Source: https://www.jetbrains.com/help/mps/sequence.html

Produces a sub-sequence starting from the first element with a specified size.

```text
seq.take (count)
```

--------------------------------

### Add Platform-Specific Binaries to Build Scripts

Source: https://www.jetbrains.com/help/mps/building-standalone-ides-for-your-languages.html

Structure for adding binary launchers to the bin folder in legacy build scripts.

```text
folder bin
...
```

--------------------------------

### Create a List

Source: https://www.jetbrains.com/help/mps/list.html

Initialize a new list using either arraylist or linkedlist, optionally providing initial values or a source sequence.

```MPS
list<Type> l = new arraylist<Type> { /* initial values */ };
```

```MPS
list<Type> = new arraylist<Type> (sequence);
```

--------------------------------

### tailSet

Source: https://www.jetbrains.com/help/mps/sorted-set.html

Returns a subset of elements starting from the specified element to the end of the set.

```APIDOC
## tailSet

### Description
Results in a sorted_set that is a subset of all elements from the original set in the original sorting order, starting with the specified element.

### Syntax
`set.tailSet(from)`
```

--------------------------------

### Stack Creation

Source: https://www.jetbrains.com/help/mps/stack.html

Methods for initializing a new stack instance.

```APIDOC
## new linkedlist

### Description
Creates an empty stack. Optionally, initial values or a sequence can be provided to populate the stack.

### Syntax
`stack<Type> = new linkedlist<Type> {values...};`
`stack<Type> = new linkedlist<Type> (sequence);`
```
Tokens:
Raw