Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
005468e
feat(backend): a cache command states its scope and its level
Sunrisepeak Nov 21, 2026
e971088
feat(backend): an inline table is read as the table of its name
Sunrisepeak Nov 21, 2026
44d8629
feat(backend): the features of a path or workspace dependency
Sunrisepeak Nov 21, 2026
5b00824
fix(vscode): mcpp.toml closes its brackets and quotes and comments wi…
Sunrisepeak Nov 21, 2026
a118800
fix(clion): the thread that reads the backend runs no listener
Sunrisepeak Nov 21, 2026
385ae1b
fix(clion): no class of the core names JCEF's
Sunrisepeak Nov 21, 2026
262c54c
fix(clion): the cache tab in the sections of VS Code's page; texts re…
Sunrisepeak Nov 21, 2026
c881cd0
test(clion): the IDE runs that would have caught #13
Sunrisepeak Nov 21, 2026
0faa4bf
fix(nvim): the cache text in the sections of VS Code's page
Sunrisepeak Nov 21, 2026
c119196
1.6.0: the six version statements, mcppls 0.23.0 for CLion, the chang…
Sunrisepeak Nov 21, 2026
3fc4e89
docs: the editor surfaces and the feature matrix, a design record
Sunrisepeak Nov 21, 2026
1e9b021
fix(backend): a dependency's features as mcpp registers them; the rev…
Sunrisepeak Nov 21, 2026
a02ca17
fix(clion): an answer and the notifications after it, in the backend'…
Sunrisepeak Nov 21, 2026
0dc269b
docs: the design record states the review's corrections to stream F
Sunrisepeak Nov 21, 2026
19c0eb0
test(clion): the JCEF plugin is disabled where CLion has one
Sunrisepeak Nov 21, 2026
952de0d
test(clion): the graph run builds once the session has the root, on t…
Sunrisepeak Nov 21, 2026
70159ab
test(clion): every action of the graph run is invoked on the project'…
Sunrisepeak Nov 21, 2026
297cb88
fix(backend): a build database is used only while the manifest is the…
Sunrisepeak Nov 21, 2026
7c28eb3
test(clion): a graph run starts its IDE once the driver's ports are free
Sunrisepeak Nov 21, 2026
695f26f
docs: the design record states what the IDE runs settled
Sunrisepeak Nov 21, 2026
b936dd3
ci: the macOS graph runs each start one IDE on a runner of its own
Sunrisepeak Nov 21, 2026
bbcf16e
test(clion): every IDE run keeps the fingerprint of an error the IDE …
Sunrisepeak Nov 21, 2026
87a0269
test(clion): a graph run whose IDE never connected starts a new IDE once
Sunrisepeak Nov 21, 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
874 changes: 874 additions & 0 deletions .agents/docs/2026-11-21-editor-surfaces-and-feature-matrix.md

Large diffs are not rendered by default.

114 changes: 109 additions & 5 deletions .github/workflows/clion-stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ on:
workflow_dispatch:
inputs:
release_tag:
description: Published plugin release to install without rebuilding the backend
description: Published plugin release to install without rebuilding the backend (empty, the latest)
type: string
default: v0.2.0
default: ''
# A new CLion is met by CI before a user meets it: the latest published plugin on the stable
# releases named below, every week.
schedule:
- cron: '17 4 * * 1'

permissions:
contents: read
Expand Down Expand Up @@ -57,10 +61,14 @@ jobs:
if: inputs.plugin_artifact == ''
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ inputs.release_tag || 'v0.2.0' }}
RELEASE_TAG: ${{ inputs.release_tag }}
run: |
set -euo pipefail
[[ "$RELEASE_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]
# Unnamed (the weekly run): the newest release that carries the CLion plugin.
if [ -z "$RELEASE_TAG" ]; then
RELEASE_TAG="$(gh api "repos/$GITHUB_REPOSITORY/releases?per_page=100" --jq '[.[] | select((.draft | not) and (.tag_name | test("^(clion-)?v[0-9]+\\.[0-9]+\\.[0-9]+$")))][0].tag_name')"
fi
[[ "$RELEASE_TAG" =~ ^(clion-)?v[0-9]+\.[0-9]+\.[0-9]+$ ]]
mkdir -p stable-plugin
gh release download "$RELEASE_TAG" --repo "$GITHUB_REPOSITORY" \
--pattern 'mcpp-clion-*.zip' --dir stable-plugin
Expand Down Expand Up @@ -125,12 +133,108 @@ jobs:
path: |
${{ runner.temp }}/clion-stable-result/result.json
${{ runner.temp }}/clion-stable-result/checks.json
${{ runner.temp }}/clion-stable-result/ide-errors.ndjson
${{ runner.temp }}/clion-stable-result/ide-errors*.ndjson
${{ runner.temp }}/clion-stable-result/settings/result.json
${{ runner.temp }}/clion-stable-result/settings/observations.json
${{ runner.temp }}/clion-stable-result/graphs/result.json
${{ runner.temp }}/clion-stable-result/graphs/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/result.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/no-jcef-window.txt
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/result.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/no-jcef-window.txt
if-no-files-found: warn

# The report of #13 came from macOS on Apple silicon, where the JCEF plugin is a build of its own:
# the startup chain and the graphs (JCEF on, switched off, its plugin disabled) on the newest stable
# CLion there.
# One IDE per runner: on macOS a second IDE started on the same runner could stop at its start, before
# any plugin loads (its log ends at "CPU cores"), and its driver never connected.
runtime-macos:
name: packaged plugin on CLion ${{ matrix.version }} (macOS aarch64, ${{ matrix.scenario }})
runs-on: macos-15
timeout-minutes: 45
strategy:
fail-fast: false
matrix:
version: ['2026.2.4.1']
scenario: [graphRendersNavigatesAndRecoversInJcef, graphExplainsAbsentJcefPlugin, graphExplainsUnavailableJcef]
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/setup-mcpp
with:
llvm: 'true'
- uses: actions/setup-java@v5
with:
distribution: temurin
java-version: '25'
- uses: gradle/actions/setup-gradle@v5
with:
gradle-version: '9.7.1'
- name: The candidate ZIP built once by CI
if: inputs.plugin_artifact != ''
uses: actions/download-artifact@v5
with:
name: ${{ inputs.plugin_artifact }}
path: stable-plugin
- name: The published ZIP for an isolated release check
if: inputs.plugin_artifact == ''
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ inputs.release_tag }}
run: |
set -euo pipefail
if [ -z "$RELEASE_TAG" ]; then
RELEASE_TAG="$(gh api "repos/$GITHUB_REPOSITORY/releases?per_page=100" --jq '[.[] | select((.draft | not) and (.tag_name | test("^(clion-)?v[0-9]+\\.[0-9]+\\.[0-9]+$")))][0].tag_name')"
fi
[[ "$RELEASE_TAG" =~ ^(clion-)?v[0-9]+\.[0-9]+\.[0-9]+$ ]]
mkdir -p stable-plugin
gh release download "$RELEASE_TAG" --repo "$GITHUB_REPOSITORY" \
--pattern 'mcpp-clion-*.zip' --dir stable-plugin
- name: The pinned language-service plugin
env:
GH_TOKEN: ${{ github.token }}
run: |
set -euo pipefail
version="$(sed -n 's/^mcpplsPluginVersion *= *//p' mide-plugins/clion/gradle.properties)"
gh release download "v$version" --repo Sunrisepeak/mcpp-language-server \
--pattern "mcppls-clion-$version.zip" --dir stable-plugin
- name: Start the real IDE, complete the startup chain and open the graphs
env:
IDE_VERSION: ${{ matrix.version }}
run: |
set -euo pipefail
plugin="$(find stable-plugin -maxdepth 1 -name 'mcpp-clion-*.zip' -print)"
language="$(find stable-plugin -maxdepth 1 -name 'mcppls-clion-*.zip' -print)"
test -n "$plugin" && test -n "$language"
gradle --no-daemon --max-workers=4 \
-p mide-plugins/clion/integration-tests test --tests "GraphInteractionTest.${{ matrix.scenario }}" \
-PpluginZip="$GITHUB_WORKSPACE/$plugin" \
-PmcpplsZip="$GITHUB_WORKSPACE/$language" \
-PideVersion="$IDE_VERSION" \
-Poutput="$RUNNER_TEMP/clion-stable-result"
- uses: actions/upload-artifact@v5
if: always()
with:
name: clion-stable-macos-${{ matrix.version }}-${{ matrix.scenario }}
# The JUnit results name an assertion's message; the IDE's own log, of a runner's IDE on a
# generated project, names why an IDE did not start.
path: |
${{ runner.temp }}/clion-stable-result/ide-errors*.ndjson
mide-plugins/clion/integration-tests/build/test-results/test/*.xml
out/ide-tests/tests/*/*/log/idea.log
out/ide-tests/tests/*/*/log/monitoring-thread-dumps-ide/*.txt
${{ runner.temp }}/clion-stable-result/*/ide-start-retried
${{ runner.temp }}/clion-stable-result/graphs/result.json
${{ runner.temp }}/clion-stable-result/graphs/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/result.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef/no-jcef-window.txt
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/result.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/checks.json
${{ runner.temp }}/clion-stable-result/graphs-no-jcef-plugin/no-jcef-window.txt
if-no-files-found: warn
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ compile_commands.json
dist-upload/
.xlings/
out/ide-tests

# Local reviews and analyses, not design records.
.agents/reviews/
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,47 @@

The changelog is kept by series (`X.Y`); each section lists its components' releases.

## 1.6

### 1.6.0

Every component is 1.6.0: the backend, mcpp-vscode, mcpp-clion and mcpp-nvim (from 1.5.0). These
are the fixes of the issue review of 2026-11-21
([design record](.agents/docs/2026-11-21-editor-surfaces-and-feature-matrix.md), stream F).

- **CLion: no listener on the reading thread** (#13). "Read access is allowed from inside read-action
only" was logged at startup and each time a backend started. The thread that reads the backend's
output now only decodes frames; notifications reach their listeners in order on a pooled thread,
answers complete on the pool, and the open documents are read in a read action.
- **CLion without JCEF** (#13). Opening a graph without the JCEF plugin failed with
`NoClassDefFoundError: JBCefApp`. The core of the plugin names no JCEF class; JCEF's page host is
registered only when the JCEF plugin is loaded, and without it the tab says why.
- **CLion: the cache tab in the sections of VS Code's page** (#13). Project cache (`target/`) and
Global build cache, each with its cleanups as links on its row and in its context menu; an
ellipsis marks one that asks first. The toolbar keeps Refresh. Neovim's cache text has the same
two sections.
- **CLion: texts read when shown** (#13). Toolbar texts and the Libraries button no longer stay in
English beside Chinese rows.
- **CLion: the runs that would have caught these.** The real-IDE run restarts the backend with
`mcpp.toml` open and checks the cache tab's sections; the graphs run with the JCEF plugin
disabled; the startup chain and the graphs run on macOS aarch64; a weekly run checks the latest
published plugin. The pinned mcppls CLion plugin is 0.23.0.
- **VS Code: pairs and comments in `mcpp.toml`** (#15, #18). Brackets and quotes close as they are
typed, and `#` comments a line. The parity gate keeps every field of each language 0.9.0
contributed and admits an added one.
- **Inline tables** (#15). Inside `app = { ... }` under `[targets]` the keys of `[targets.app]` are
offered, less those written, and an enum key's values. A dependency's inline table gets nothing:
the snapshot does not list a dependency's keys.
- **A dependency's features** (#16, #17). Inside `features = [...]` of a `path` or workspace
dependency: its features, read from its own `mcpp.toml`; their hover; and
`mcpp.manifest.unknownFeature` for a name it does not declare. An index package's features are not
answered: mcpp states none, and `capabilities/explain` names
[mcpp#992](https://github.com/mcpp-community/mcpp/issues/992) (`manifest.packageFeatures`).
- **A graph right after the manifest changed is the new manifest's.** The kept build database was
dropped by the watcher's next poll (every 500 ms), so a graph asked before it was the old manifest's,
and the page kept it. An entry is now used only while the manifest is the one it was read from.
- **Protocol.** A cache command of `commands/list` states `scope` (`project`, `shared`) and `level`.

## 1.5

### 1.5.0
Expand Down
25 changes: 24 additions & 1 deletion docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ the order the messages arrive, so an answer sees the document the notifications
| On a key of a table with a closed vocabulary | its keys, less those already written in the table's group; a key's detail names its type, values and default |
| On a key of a dependency table | the five dependency forms |
| On a key of `[features]`, `[generated_files]`, `[capabilities]`, `[xlings.workspace]`, `[tools.overrides]` | that table's forms |
| On an enum key's value | its values (inside a string only the content is replaced) |
| Inside an inline table, after `{` or `,` (1.6.0) | the keys of the table of its name, less those the inline table has on either side of the cursor: `app = { ... }` under `[targets]` lists what `[targets.app]` does, and is not an unknown key of `[targets]`. A dependency's inline table is its specification, whose keys the snapshot does not list, and gets nothing |
| On an enum key's value | its values (inside a string only the content is replaced); a key of an inline table or a dotted key has its own table's |
| Inside `features = [...]` of a dependency given by `path` or `workspace = true` (1.6.0) | the features its own manifest declares and the edge does not name yet, each with whether it is a default and what it implies |
| On a dependency's version, with `mcpp.toml.indexCompletion` on and the workspace trusted | the versions mcpp's catalogue (`mcpp search --format json`) lists for that package, newest first; the catalogue is read once in the background (the answer is incomplete until then) and kept for ten minutes |

A table is read as the snapshot's section its name denotes: the whole name when the snapshot has
Expand All @@ -46,11 +48,29 @@ it, its note) and an enum value. Definition jumps from `workspace = true` to the
`[workspace.dependencies]`, from an element of `features = [...]` to `[features.<name>]`, and from
`path = "../x"` to that manifest's `[package]`.

### A dependency's features

A dependency's features are read from the text of its own manifest, the rules layer's ground: the
directory its `path` names, or for `workspace = true` the one the nearest enclosing workspace's
`[workspace.dependencies]` entry names. Its features are the names mcpp registers: the keys of
`[features]` (`default` among them) and `[features.<name>]`, and the names of `[feature-deps.<name>]`
and, under a target selector, of `feature-deps`, `feature-requires-abi` and `feature-xlings`. Its
`default` names the ones on without being named, an array or `implies` what each turns on. A
dependency whose manifest declares none accepts any name, as mcpp does. Between two elements a
suggestion brings its commas; an array left open is read on its own line only.

An index package's features are not answered: mcpp states none
([mcpp#992](https://github.com/mcpp-community/mcpp/issues/992) asks for them), and an index's
descriptors are mcpp's to read. `capabilities/explain` reports this as `manifest.packageFeatures`.
Hover on an element of the edge's `features = [...]` names the dependency, the default and what the
feature implies.

| Code | Default severity | Setting | What it reports |
|---|---|---|---|
| `mcpp.manifest.syntax` | error | `mcpp.toml.diagnostics.syntax` | a line that is neither a table header nor `key = value`; an invalid key; a key without a value |
| `mcpp.manifest.unknownSection` | warning | `mcpp.toml.diagnostics.unknownSection` | a table no section of the snapshot names, nor a prefix of it |
| `mcpp.manifest.unknownKey` | warning | `mcpp.toml.diagnostics.unknownKey` | a key a table with a closed vocabulary does not have |
| `mcpp.manifest.unknownFeature` | warning | `mcpp.toml.diagnostics.unknownKey` | a name in a `path` or workspace dependency's `features = [...]` that its manifest's `[features]` does not declare (1.6.0) |
| `mcpp.manifest.planeSeparation` | warning | `mcpp.toml.diagnostics.planeSeparation` | a tool payload (`xim:`, `xpm:`, `xlings:`, `xvm:`) as a dependency; an mcpp package with a version under `[xlings]` |
| `mcpp.manifest.legacyKey` | info | `mcpp.toml.diagnostics.legacyKeys` | a deprecated table or key, with its replacement |
| `mcpp.manifest.mcppFloor` | error | -- | `[package] mcpp` that is not a release floor (`">=2026.9.28.3"`) |
Expand Down Expand Up @@ -95,3 +115,6 @@ implementation's answers over `tests/cts/rules/corpus` -- the scanner's structur
at every position of every line, completion, hover, the jumps, the version contexts and the
diagnostics under two sets of severities -- and over the documents of its parser tests
(`golden/snippets.json`); the conformance case `rules` (tests/cts/rules.cpp) compares the backend's answers with them.
The answers inside inline tables that 1.6.0 added are where 0.9 answered nothing; they are kept apart,
in `golden/inline-tables.json` (`MCPP_IDE_WRITE_GOLDEN=1 mcpp test cts` writes it again for review),
and every other position still equals 0.9's.
2 changes: 1 addition & 1 deletion mcpp.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# M2/M3), where the system it runs upon is answered when the image is loaded.
[package]
name = "mcpp-ide"
version = "1.5.0"
version = "1.6.0"
description = "The IDE backend for mcpp: sessions, jobs, records and view models over mcpp's control contract"
license = "Apache-2.0"
authors = ["mcpp-community"]
Expand Down
14 changes: 9 additions & 5 deletions mide-plugins/clion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,21 @@ backend.
The stable IDE tests also use the actual settings dialog: keyboard input, visible validation
errors, refusal of partial saves, the persisted XML, reopening the form and restoring defaults.
Graph tests inspect the real JCEF document, click a rendered module to open its source,
check visible query errors and recovery, and check the explanation when JCEF is disabled.
check visible query errors and recovery, and check the explanation when JCEF is switched off and
when the JCEF plugin is disabled.

The packaged ZIP is also run in the real stable CLion 2026.1.5.2 and 2026.2.4.1 IDEs by
`clion-stable.yml`. Both versions load the same ZIP and the pinned mcppls plugin. The test opens
an mcpp project, completes protocol 2 initialization, loads runtime translations and commands,
and verifies the visible mcpp tool window and cache inventory. It executes build, run and test
and verifies the visible mcpp tool window and the cache tab's two sections with their cleanups. It
restarts the backend with mcpp.toml open and checks that the document is sent again. It executes build, run and test
actions in a project whose path contains Unicode and spaces, launches the native debugger,
checks its visible view, source breakpoint, variable values before and after stepping, resume
and stop, checks the native test tree,
compiler-error output, build/test failure and recovery, and exact manifest completion insertion
during project analysis. It supplements Plugin Verifier's static compatibility checks.
during project analysis. It supplements Plugin Verifier's static compatibility checks. The startup chain and the graphs also
run on macOS aarch64 with CLion 2026.2.4.1, and a weekly run checks the latest published plugin on
the stable releases.
CLion 2026.2.4.1 can emit a GDB variable-read cancellation after stopping a
debug session; the same exception occurs in a stock CMake project without the
plugins. The stable test records the exception class and method symbols, and
Expand All @@ -99,8 +103,8 @@ An individual packaged plugin can be checked without rebuilding the backend:

```bash
xvfb-run -a gradle --no-daemon -p integration-tests test \
-PpluginZip=/absolute/path/mcpp-clion-1.5.0.zip \
-PmcpplsZip=/absolute/path/mcppls-clion-0.21.0.zip \
-PpluginZip=/absolute/path/mcpp-clion-1.6.0.zip \
-PmcpplsZip=/absolute/path/mcppls-clion-0.23.0.zip \
-PideVersion=2026.1.5.2
```

Expand Down
4 changes: 2 additions & 2 deletions mide-plugins/clion/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# where it installs (2026.1 and later); the verifier checks both ends.
platformType = CL
platformVersion = 2026.2.3
pluginVersion = 1.5.0
pluginVersion = 1.6.0
# The mcppls CLion plugin this one depends on (<depends>io.github.sunrisepeak.mcppls</depends>):
# its release's one package for every system, fetched for the sandbox, the tests and the verifier.
mcpplsPluginVersion = 0.21.0
mcpplsPluginVersion = 0.23.0
org.gradle.jvmargs = -Xmx2g
# The IDE ships the Kotlin standard library; a plugin bundles no second copy.
kotlin.stdlib.default.dependency = false
Loading
Loading