Releasing 0.6.0

CHANGES.md

@@ -1,7 +1,23 @@
 Changes
 =======
 
-0.5.5 (unreleased)
+0.6.0 (2022-09-12)
+
+- Drop UnaryOperator, replaced by the proper method calls
+- Minor refactoring of CLI options
+- Improve MagikIndexer to determine whether a method really returns something and setting the resulting type of the method accordingly (undefined result when no new-method-doc is available, or an empty result)
+- Don't overwrite already known methods in JsonTypeKeeperReader
+- Add JsonTypeKeeperWriter
+- Support methods returning a parameter with the `_parameter(..)` type/ParameterReferenceType
+- Fix MagikGrammer better support EOLs in certain cases
+- Fix showing procedure doc on hover
+- Extend hover provider, now supports packages, conditions
+- Support conditions
+- Changes to MagikGrammar
+- Rewrite parts of references to types in TypeKeeper/types. Fixes mem leaks, references to invalid/old types. MagikPreIndexer can now also be removed and methods without a type definition can be indexed
+- Methods support recording used globals, called methods, used slots, used conditions. This allows for finding references and possibly method renaming in the future
+- Various bug fixes
+- Various new features
 
 
 0.5.4 (2022-11-07)

magik-checks/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>nl.ramsolutions</groupId>
     <artifactId>magik-tools</artifactId>
-    <version>0.5.5-SNAPSHOT</version>
+    <version>0.6.0</version>
   </parent>
 
   <artifactId>magik-checks</artifactId>

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/CheckList.java

@@ -52,8 +52,8 @@ private CheckList() {
     }
 
     /**
-     * Get the list of {{MagikCheck}}s.
-     * @return List of with {{MagikCheck}}s
+     * Get the list of {@link MagikCheck}s.
+     * @return List of {@link MagikCheck}s.
      */
     public static List<Class<?>> getChecks() {
         return List.of(
@@ -91,8 +91,8 @@ public static List<Class<?>> getChecks() {
     }
 
     /**
-     * Get {{MagikCheck}}s which are disabled by default.
-     * @return List of {{MagikCheck}}s.
+     * Get {@link MagikCheck}s which are disabled by default.
+     * @return List of {@link MagikCheck}s.
      */
     public static List<Class<?>> getDisabledByDefaultChecks() {
         return getChecks().stream()
@@ -101,8 +101,8 @@ public static List<Class<?>> getDisabledByDefaultChecks() {
     }
 
     /**
-     * Get {{MagikCheck}}s which are templated.
-     * @return List of {{MagikCheck}}s.
+     * Get {@link MagikCheck}s which are templated.
+     * @return List of {@link MagikCheck}s.
      */
     public static List<Class<?>> getTemplatedChecks() {
         return getChecks().stream()

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/MagikIssue.java

@@ -25,8 +25,8 @@ public MagikIssue(final Location location, final String message, final MagikChec
     }
 
     /**
-     * Get the {{Location}} of the issue.
-     * @return {{Location}}.
+     * Get the {@link Location} of the issue.
+     * @return {@link Location}.
      */
     public Location location() {
         return this.location;
@@ -77,8 +77,8 @@ public String message() {
     }
 
     /**
-     * Get the {{MagikCheck}} giving the issue.
-     * @return {{MagikCheck}} giving the issue.
+     * Get the {@link MagikCheck} giving the issue.
+     * @return {@link MagikCheck} giving the issue.
      */
     public MagikCheck check() {
         return this.check;

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/CommentedCodeCheck.java

@@ -78,8 +78,9 @@ private Map<Token, List<Token>> extractCommentBlocks(final AstNode node) {
 
             if (startToken == null) {
                 startToken = token;
-            } else if (lastToken.getLine() != token.getLine() - 1
-                    || lastToken.getColumn() != token.getColumn()) {
+            } else if (lastToken != null
+                      && (lastToken.getLine() != token.getLine() - 1
+                          || lastToken.getColumn() != token.getColumn())) {
                 // Block broken, either due to line not connecting or indent changed.
 
                 // Save current block.

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/FormattingCheck.java

@@ -5,7 +5,6 @@
 import com.sonar.sslr.api.Token;
 import java.util.Set;
 import nl.ramsolutions.sw.magik.MagikFile;
-import nl.ramsolutions.sw.magik.api.ExtendedTokenType;
 import nl.ramsolutions.sw.magik.checks.MagikCheck;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
@@ -112,10 +111,6 @@ protected void walkPostMagik(final AstNode node) {
 
     @Override
     public void walkToken(final Token token) {
-        if (token.getType() == ExtendedTokenType.SYNTAX_ERROR) {
-            return;
-        }
-
         this.previousToken = this.currentToken;
         this.currentToken = this.nextToken;
         this.nextToken = token;

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/MethodComplexityCheck.java

@@ -49,4 +49,5 @@ private void checkDefinition(final AstNode node) {
             this.addIssue(node, message);
         }
     }
+
 }

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/SwMethodDocCheck.java

@@ -8,7 +8,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
-import javax.annotation.CheckForNull;
 import nl.ramsolutions.sw.magik.api.MagikGrammar;
 import nl.ramsolutions.sw.magik.checks.DisabledByDefault;
 import nl.ramsolutions.sw.magik.checks.MagikCheck;
@@ -18,7 +17,7 @@
 /**
  * Check if method docs are valid, according to SW style.
  */
-@DisabledByDefault // This conflicts with {{MethodDocCheck}}!
+@DisabledByDefault
 @Rule(key = SwMethodDocCheck.CHECK_KEY)
 public class SwMethodDocCheck extends MagikCheck {
 
@@ -31,7 +30,7 @@ public class SwMethodDocCheck extends MagikCheck {
     @Override
     protected void walkPreMethodDefinition(final AstNode node) {
         final String methodDoc = this.extractDoc(node);
-        if (methodDoc == null) {
+        if (methodDoc.isBlank()) {
             final String message = String.format(MESSAGE, "all");
             this.addIssue(node, message);
             return;
@@ -73,7 +72,6 @@ private Set<String> getMethodParameters(final AstNode node) {
         return parameters;
     }
 
-    @CheckForNull
     private String extractDoc(final AstNode node) {
         return MagikCommentExtractor.extractDocComments(node)
             .map(Token::getValue)

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/UndefinedVariableCheck.java

@@ -19,7 +19,8 @@ public class UndefinedVariableCheck extends MagikCheck {
     @Override
     protected void walkPostMagik(final AstNode node) {
         final GlobalScope globalScope = this.getMagikFile().getGlobalScope();
-        globalScope.getScopeEntriesInScope().stream()
+        globalScope.getSelfAndDescendantScopes().stream()
+            .flatMap(scope -> scope.getScopeEntriesInScope().stream())
             .filter(scopeEntry -> scopeEntry.isType(ScopeEntry.Type.GLOBAL))
             .filter(scopeEntry -> this.isPrefixed(scopeEntry.getIdentifier()))
             .forEach(scopeEntry -> {

magik-checks/src/test/java/nl/ramsolutions/sw/magik/checks/checks/MagikCheckTestBase.java

@@ -20,7 +20,7 @@ class MagikCheckTestBase {
     /**
      * VSCode runs from module directory, mvn runs from project directory.
      *
-     * @return Proper {{Path}} to file.
+     * @return Proper {@link Path} to file.
      */
     protected Path getPath(final Path relativePath) {
         final Path path = Path.of(".").toAbsolutePath().getParent();

magik-checks/src/test/java/nl/ramsolutions/sw/magik/checks/checks/MethodComplexityCheckTest.java

@@ -45,8 +45,8 @@ void testNotTooComplex() {
         final MagikCheck check = new MethodComplexityCheck();
         final String code = ""
             + "_method a.b\n"
-            + "    _if a"
-            + "    _then"
+            + "    _if a\n"
+            + "    _then\n"
             + "    _endif\n"
             + "_endmethod\n";
         final List<MagikIssue> issues = this.runCheck(code, check);

magik-debug-adapter/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>nl.ramsolutions</groupId>
     <artifactId>magik-tools</artifactId>
-    <version>0.5.5-SNAPSHOT</version>
+    <version>0.6.0</version>
   </parent>
 
   <artifactId>magik-debug-adapter</artifactId>

magik-debug-adapter/src/main/java/nl/ramsolutions/sw/magik/debugadapter/BreakpointManager.java

@@ -215,7 +215,7 @@ MagikBreakpoint addBreakpoint(final Source source, final SourceBreakpoint source
         if (methodNode == null) {
             method = "<not_in_method>";
         } else {
-            method = helper.getPakkageExemplarMethodName();
+            method = helper.getFullExemplarMethodName();
             methodLine = methodNode.getTokenLine();
             if (methodLine == line) {
                 line = 0;
@@ -259,7 +259,7 @@ void clearFunctionBreakpoints() throws IOException, InterruptedException, Execut
      * Add multiple function breakpoints.
      *
      * @param functionBreakpoints Breakpoints to be set.
-     * @return List of {{MagikBreakpoint}}s.
+     * @return List of {@link MagikBreakpoint}s.
      * @throws ExecutionException -
      * @throws InterruptedException -
      * @throws IOException -
@@ -277,8 +277,8 @@ List<MagikBreakpoint> addFunctionBreakpoints(final FunctionBreakpoint[] function
     /**
      * Add a function breakpoint.
      *
-     * @param functionBreakpoint {{FunctionBreakpoint}} to add.
-     * @return Created {{MagikBreakpoint}}.
+     * @param functionBreakpoint {@link FunctionBreakpoint} to add.
+     * @return Created {@link MagikBreakpoint}.
      * @throws IOException -
      * @throws ExecutionException -
      * @throws InterruptedException -
@@ -366,7 +366,7 @@ MagikBreakpoint getBreakpoint(final long breakpointId) {
 
     // region: Event handling
     /**
-     * Handle a {{BreakpointEvent}}.
+     * Handle a {@link BreakpointEvent}.
      * @param breakpointEvent event.
      */
     void handleBreakpointEvent(final BreakpointEvent breakpointEvent) {

magik-debug-adapter/src/main/java/nl/ramsolutions/sw/magik/debugadapter/Lsp4jConversion.java

@@ -24,10 +24,10 @@ private Lsp4jConversion() {
     }
 
     /**
-     * Convert a slap {{ThreadInfoResponse}} to a lsp4j {{Thread}}.
+     * Convert a slap {@link ThreadInfoResponse} to a lsp4j {@link Thread}.
      * @param threadId ID of the thread.
      * @param threadInfo Slap thread info.
-     * @return lsp4j {{Thread}}.
+     * @return lsp4j {@link Thread}.
      */
     public static Thread toLsp4j(final long threadId, final ThreadInfoResponse threadInfo) {
         final Thread thread = new Thread();
@@ -37,9 +37,9 @@ public static Thread toLsp4j(final long threadId, final ThreadInfoResponse threa
     }
 
     /**
-     * Convert a slap {{BreakpointSetResponse}} to a lsp4j {{Breakpoint}}.
+     * Convert a slap {@link BreakpointSetResponse} to a lsp4j {@link Breakpoint}.
      * @param breakpointSet Slap breakpoint set.
-     * @return lsp4j {{Breakpoint}}.
+     * @return lsp4j {@link Breakpoint}.
      */
     public static Breakpoint toLsp4j(final BreakpointSetResponse breakpointSet, final Source source) {
         final Breakpoint breakpoint = new Breakpoint();
@@ -50,11 +50,11 @@ public static Breakpoint toLsp4j(final BreakpointSetResponse breakpointSet, fina
     }
 
     /**
-     * Convert a slap {{ThreadStackResponse.StackElement}} to lsp4j {{StackFrame}}.
+     * Convert a slap {@link ThreadStackResponse.StackElement} to lsp4j {@link StackFrame}.
      * @param threadId Thread ID.
      * @param stackElement Stack element.
      * @param path Path.
-     * @return lsp4j {{StackFrame}}.
+     * @return lsp4j {@link StackFrame}.
      */
     public static StackFrame toLsp4j(
             final long threadId, final ThreadStackResponse.StackElement stackElement, final @Nullable Path path) {
@@ -73,10 +73,10 @@ public static StackFrame toLsp4j(
     }
 
     /**
-     * Convert {{MagikBreakpoint}}s to LSP4j {{Breakpoint}}s.
+     * Convert {@link MagikBreakpoint}s to LSP4j {@link Breakpoint}s.
      * @param source Source of file.
      * @param magikBreakpoints MagikBreakpoints.
-     * @return Array of converted LSP4j {{Breakpoint}}s.
+     * @return Array of converted LSP4j {@link Breakpoint}s.
      */
     public static Breakpoint[] toLsp4j(final Source source, final List<MagikBreakpoint> magikBreakpoints) {
         return magikBreakpoints.stream()
@@ -92,9 +92,9 @@ public static Breakpoint[] toLsp4j(final Source source, final List<MagikBreakpoi
     }
 
     /**
-     * Convert {{MagikVariable}}s to LSP4j {{Variable}}s.
+     * Convert {@link MagikVariable}s to LSP4j {@link Variable}s.
      * @param magikVariables MagikVariables.
-     * @return List of converted LSP4j {{Variable}}s.
+     * @return List of converted LSP4j {@link Variable}s.
      */
     public static Variable[] toLsp4j(final List<MagikVariable> magikVariables) {
         return magikVariables.stream()