https://github.com/itsallcode/openfasttrace-intellij-plugin
Editor support for writing and maintaining OpenFastTrace documents
https://github.com/itsallcode/openfasttrace-intellij-plugin
Last synced: about 2 months ago
JSON representation
Editor support for writing and maintaining OpenFastTrace documents
- Host: GitHub
- URL: https://github.com/itsallcode/openfasttrace-intellij-plugin
- Owner: itsallcode
- License: apache-2.0
- Created: 2022-09-12T05:41:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-24T12:56:31.000Z (about 2 months ago)
- Last Synced: 2026-04-24T13:35:57.635Z (about 2 months ago)
- Language: Java
- Size: 180 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenFastTrace IntelliJ Plugin
## What is OpenFastTrace IntelliJ Plugin?
The OpenFastTrace IntelliJ Plugin adds editor and navigation support for OpenFastTrace (OFT) artifacts directly in JetBrains IDEs based on the IntelliJ Platform.
It helps users work with OFT specification items and trace links in the same environment where they already edit code and documentation.
## Project Information
This repository contains the plugin implementation, tests, and OpenFastTrace-based product documentation.
[](https://github.com/itsallcode/openfasttrace-intellij-plugin/actions/workflows/build.yml)
SonarCloud status:
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
[](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-intellij-plugin)
**User Guides**
* [OpenFastTrace User Guide](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md)
* [OpenFastTrace in IDE Help Action](src/main/java/org/itsallcode/openfasttrace/intellijplugin/help/OpenFastTraceUserGuide.java)
**News and Discussions**
* [Changelog](doc/changes/changelog.md)
* [OpenFastTrace Project Discussions](https://github.com/itsallcode/openfasttrace/discussions)
**Information for Contributors**
* [System Requirements](doc/system_requirements.md)
* [Design Documentation](doc/design.md)
* [Architecture Decisions](doc/design/architecture_decisions.md)
* [Change Sets](doc/changesets/README.md)
## Using the Plugin
Use an IntelliJ Platform IDE and install/build this plugin to get OFT support while editing project files.
The plugin currently focuses on:
* syntax highlighting for OFT items in supported files
* navigation support (`Go To Declaration`, symbol search, and related navigation paths)
* project-wide or selected-resource OFT tracing from `Tools | OpenFastTrace | Trace Project`
* clickable specification item IDs directly from the trace output window, including generated IDs created from coverage tags
* quick access to the OpenFastTrace user guide from the IDE help menu
For expected behavior and scope details, see:
* [System Requirements](doc/system_requirements.md)
* [Runtime View](doc/design/runtime_view.md)
## Getting the Project
Clone this repository and build the plugin with Gradle:
```sh
./gradlew build
```
For manual IDE testing, launch a sandbox IDE with the plugin:
```sh
./gradlew manualTestIde
```
After the sandbox IDE opens a project, configure trace scope under `Settings | Tools | OpenFastTrace`. By default, `Trace Project` scans the whole opened project. If you switch to selected-resource tracing, the plugin includes IntelliJ source roots, IntelliJ test roots, and one default additional project-relative path entry, `doc/`, until you change it. Additional files or directories are entered one per line.
Run an OFT trace from `Tools | OpenFastTrace | Trace Project` or use the default shortcut `Ctrl+Alt+Shift+O`. The plugin traces the configured inputs in the background and shows the plain text result in an IDE output tab with ANSI colors preserved. You can click specification item IDs in the report to jump to their declarations, including source-side items generated from coverage tags.
## Installation
### Runtime Dependencies
You need a JetBrains IDE based on the IntelliJ Platform (for example, IntelliJ IDEA Community Edition) to run the plugin.
### Development Dependencies
To build and test from source, use the project’s configured Gradle wrapper and a compatible JDK.
## Development
To understand product intent and implementation scope, start with:
* [System Requirements](doc/system_requirements.md)
* [Design](doc/design.md)
* [Change Log](doc/changes/changelog.md)
To run the automated checks for the trace action and the project trace itself:
```sh
./gradlew check verifyPlugin
```
Example OFT files for manual testing are available under `examples\` in this project.
## License
This project is licensed under the [Apache 2.0 license](LICENSE).