#378: RST importer

.github/workflows/build.yml

@@ -14,11 +14,9 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        java: [11]
+        java: [17]
         os: [ubuntu-latest, macos-latest, windows-latest]
         include:
-          - os: ubuntu-latest
-            java: 17
           - os: ubuntu-latest
             java: 21
 
@@ -32,7 +30,7 @@ jobs:
         shell: "bash"
     name: "Build on ${{ matrix.os }} with Java ${{ matrix.java }}"
     env:
-      DEFAULT_JAVA: 11
+      DEFAULT_JAVA: 17
       DEFAULT_OS: ubuntu-latest
 
     steps:
@@ -45,7 +43,6 @@ jobs:
       with:
         distribution: 'temurin'
         java-version: |
-          11
           17
           21
         cache: 'maven'

.github/workflows/codeql-analysis.yml

@@ -27,7 +27,7 @@ jobs:
     - uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
-        java-version: 11
+        java-version: 17
         cache: 'maven'
 
     - name: Initialize CodeQL

.gitignore

@@ -16,3 +16,4 @@ doc/**/*.html
 .idea/
 *.iml
 pom.xml.versionsBackup
+.DS_Store

.vscode/settings.json

@@ -15,6 +15,11 @@
             "-Djava.util.logging.config.file=src/test/resources/logging.properties"
         ]
     },
+    "[java]": {
+        "editor.detectIndentation": false,
+        "editor.tabSize": 4,
+        "editor.indentSize": "tabSize"
+    },
     "sonarlint.connectedMode.project": {
         "connectionId": "itsallcode",
         "projectKey": "org.itsallcode.openfasttrace:openfasttrace-root"

README.md

@@ -2,11 +2,11 @@
 
 ## What is OpenFastTrace?
 
-OpenFastTrace (short OFT) is a requirement tracing suite. Requirement tracing helps you keeping track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you getting rid of them.
+OpenFastTrace (short OFT) is a requirement tracing suite. Requirement tracing keeps track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.
 
 You can learn more about requirement tracing and how to use OpenFastTrace in the [user guide](doc/user_guide.md).
 
-Below you see a screenshot of of a HTML tracing report where OFT traces itself. You see a summary followed by a detail view of the traced requirements. 
+Below you see a screenshot of an HTML tracing report where OFT traces itself. You see a summary followed by a detail view of the traced requirements. 
 
 <img src="doc/images/oft_screenshot_tracing_report.png" style="box-shadow: 5px 10px 18px #888888;" alt="OFT HTML tracing report">
 
@@ -31,7 +31,6 @@ Sonarcloud status:
 
 **User Guides**
 
-* [📖 About us](doc/about_us.md)
 * [📖 User Guide](doc/user_guide.md)
 * [💲 Command Line Usage](core/src/main/resources/usage.txt)
 
@@ -42,6 +41,7 @@ Sonarcloud status:
 * [📅 Upcoming Milestones](https://github.com/orgs/itsallcode/projects/3/views/3)
 * [🗨️ Discussion Board](https://github.com/itsallcode/openfasttrace/discussions)
 * [✨ OpenFastTrace Stories](https://github.com/itsallcode/openfasttrace/wiki/OFT-Stories)
+* [ℹ️ About us](doc/about_us.md)
 
 **Information for Contributors**
 
@@ -70,33 +70,34 @@ OpenFastTrace at it's core is a Java Archive (short "[JAR](https://docs.oracle.c
 
 ### Getting Pre-Built Packages
 
-Pre-Built JAR files (called `openfasttrace-3.8.0.jar`) are available from the following places:
+Pre-Built JAR files (called `openfasttrace-4.0.0.jar`) are available from the following places:
 
-* [Maven Central](https://repo1.maven.org/maven2/org/itsallcode/openfasttrace/openfasttrace/3.8.0/openfasttrace-3.8.0.jar)
-* [GitHub](https://github.com/itsallcode/openfasttrace/releases/download/3.8.0/openfasttrace-3.8.0.jar)
+* [Maven Central](https://repo1.maven.org/maven2/org/itsallcode/openfasttrace/openfasttrace/4.0.0/openfasttrace-4.0.0.jar)
+* [GitHub](https://github.com/itsallcode/openfasttrace/releases/download/4.0.0/openfasttrace-4.0.0.jar)
 
 Check our [developer guide](doc/developer_guide.md#getting-the-openfasttrace-library) to learn how to use the OFT JAR as dependency in your own code with popular build tools.
 
 ## Installation
 
 ### Runtime Dependencies
 
-OpenFastTrace 3.0.0 and above only needs a Java 11 (or later) runtime environment to run. Older versions of OpenFastTrace can run with Java 8.
+OpenFastTrace 4.0.0 and above only needs a Java 17 (or later) runtime environment to run. OpenFastTrace until version 3.x.x supported Java 11. Versions prior to that ran with Java 8.
+Note that only the latest version of OFT is actively supported.
 
 #### Installation of Runtime Dependencies on Linux
 
 ##### Ubuntu or Debian
 
 If you just want to run OFT:
 
-    apt-get install openjdk-11-jre
+    apt-get install openjdk-17-jre
 
 ## Running OpenFastTrace
 
 The most basic variant to run OpenFastTrace is directly from the JAR file via the command line:
 
 ```bash
-java -jar product/target/openfasttrace-3.8.0.jar trace /path/to/directory/being/traced
+java -jar product/target/openfasttrace-4.0.0.jar trace /path/to/directory/being/traced
 ```
 
 If you want to run OFT automatically as part of a continuous build, we recommend using our plugins for [Gradle](https://github.com/itsallcode/openfasttrace-gradle) and [Maven](https://github.com/itsallcode/openfasttrace-maven-plugin).

api/.settings/org.eclipse.jdt.core.prefs

@@ -10,9 +10,9 @@ org.eclipse.jdt.core.compiler.annotation.nullable.secondary=
 org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled
 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
 org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate
-org.eclipse.jdt.core.compiler.codegen.targetPlatform=11
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=17
 org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
-org.eclipse.jdt.core.compiler.compliance=11
+org.eclipse.jdt.core.compiler.compliance=17
 org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 org.eclipse.jdt.core.compiler.debug.localVariable=generate
 org.eclipse.jdt.core.compiler.debug.sourceFile=generate
@@ -129,7 +129,7 @@ org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning
 org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
 org.eclipse.jdt.core.compiler.processAnnotations=disabled
 org.eclipse.jdt.core.compiler.release=disabled
-org.eclipse.jdt.core.compiler.source=11
+org.eclipse.jdt.core.compiler.source=17
 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false
 org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647
 org.eclipse.jdt.core.formatter.align_type_members_on_columns=false

api/src/main/java/module-info.java

@@ -12,7 +12,7 @@
     exports org.itsallcode.openfasttrace.api.importer.tag.config;
     exports org.itsallcode.openfasttrace.api.exporter;
     exports org.itsallcode.openfasttrace.api.report;
-    // Required to run the EqualsVerifier:
+    // Workaround: Required for the EqualsVerifier
     opens org.itsallcode.openfasttrace.api.core;
 
     requires java.logging;

api/src/main/java/org/itsallcode/openfasttrace/api/core/SpecificationItemId.java

@@ -36,7 +36,6 @@ public class SpecificationItemId implements Comparable<SpecificationItemId>
             + ITEM_NAME_PATTERN //
             + REVISION_SEPARATOR //
             + ITEM_REVISION_PATTERN;
-    // [impl->dsn~md.eb-markdown-id~1]
     private static final String LEGACY_ID = LEGACY_ID_NAME + ", *v" //
             + ITEM_REVISION_PATTERN;
     private static final int ARTIFACT_TYPE_MATCHING_GROUP = 1;
@@ -370,8 +369,8 @@ private void parseId()
                 }
                 else
                 {
-                    throw new IllegalStateException(
-                            "String '" + this.id + "' cannot be parsed to a specification item ID");
+                    throw new IllegalArgumentException("Invalid specification item ID format: \"" + this.id
+                            + "\". Format must be <arifact-type>~<requirement-name-or-number>~<revision>.");
                 }
             }
         }