I've created a new Linter but i don't see the results on the code

[tonichornet-dev]

Hi, I'm trying to create a custom Linter for variable naming conventions.

My VisitLocalVariableDeclaration method correctly identifies variables missing the ZE_ prefix, but the editor doesn't show any underline or warning indicator. I suspect I might be missing something regarding how the Squiggle indicators are registered or rendered.

Here is my current Linter code:

using System;
using System.Collections.Generic;
using PeopleCodeParser.SelfHosted;
using PeopleCodeParser.SelfHosted.Nodes;
using PeopleCodeParser.SelfHosted.Visitors;
// Ya no necesitamos System.Windows.Forms porque quitamos el mensaje

namespace AppRefiner.Linters
{
    public class ZeVariableNamingLinter : BaseLintRule
    {
        public override string LINTER_ID => "ZE_VAR_NAMING";
        private const string ERROR_MESSAGE = "Esta variable debe empezar por ZE_";

        public ZeVariableNamingLinter()
        {
            Description = "Valida que variables LOCALES comiencen por 'ZE_'";

            // CAMBIO: Usamos 'Error' (Rojo) en vez de 'Warning' para asegurarnos de que se ve.
            // Si esto funciona, luego podemos volver a Warning.
            Type = ReportType.Error;

            Active = true;
        }

        public override void VisitLocalVariableDeclaration(LocalVariableDeclarationNode node)
        {
            for (int i = 0; i < node.VariableNames.Count && i < node.VariableNameInfos.Count; i++)
            {
                var name = node.VariableNames[i];
                var info = node.VariableNameInfos[i];
                CheckVariableName(name, info.SourceSpan);
            }
            base.VisitLocalVariableDeclaration(node);
        }

        private void CheckVariableName(string variableName, SourceSpan span)
        {
            if (string.IsNullOrEmpty(variableName)) return;

            string cleanName = variableName.StartsWith("&") ? variableName.Substring(1) : variableName;

            if (!cleanName.StartsWith("ZE_", StringComparison.OrdinalIgnoreCase))
            {
                AddReport(
                    1,
                    ERROR_MESSAGE,
                    Type,
                    span.Start.Line,
                    span
                );
            }
        }
    }
}

[tim-slater-gt]

Linters are a different thing that shows information underneath the offending lines and can be triggered by "Lint Current Code" command or the Ctrl+Alt+L shortcut. They produce annotations that look like this:

Note: based on my testing it seems that v1.1.0 has some issues with linters, I'll be looking into this before the next release.

If you are wanting red squiggles or highlighting of the name, you should make a Styler instead.

You can use the SyntaxErrors styler as a minimal template (shows the base class to use, the property to override and a call to AddIndicator that produces a red squiggle (color format is 0xBBGGRRAA).

AddIndicator(error.Location, IndicatorType.SQUIGGLE, 0x0000FFA0, error.Message);

You also will need to visit all 3 of these to catch every variable declaration:

VisitLocalVariableDeclaration /* Local integer &x, &y; */
VisitLocalVariableDeclarationWithAssignment /* Local integer &x = 3; */
VisitProgramVariable /* Component/globals and I think locals at the top of non-class peoplecode */

Once you have a styler, you can also offer a "quick fix". This is done by creating a Refactor (you can check out the classes in Refactors/QuickFixes to see how to configure refactors for quick fixes) and then back in your Styler you can provide List<(Type RefactorClass, string Description)>? quickFixes as one of the parameters to AddIndicator().

What this will allow is for a user to press Ctrl+. on the squiggle and see a drop down of quick fix options, select one, and have it apply the associated refactor. Refactors/QuickFixes/CorrectClassName.cs is probably a good one to look at for how to make a refactor to rename something.

Hope this helps! Glad to see someone hacking on AppRefiner :)