Update to aglint 4.0.0-alpha.8

- Add adblock.enableAglintDebug configuration option (default: false)
- Add adblock.enableAglintCache configuration option (default: true)
- Implement LRU cache for linting results with cache key based on URI, AGLint version, document version, and config hash
- Extract AGLint-related state into AglintContext class
- Add ESLint rule to restrict direct imports from @adguard/aglint in server code
- Update AGLint to v4.0.0-alpha.8
- Remove

Author: totadavid95

README.md

@@ -103,6 +103,8 @@ This extension provides the following configuration options:
 | Option | Description | Default value | Possible values |
 | ------ | ----------- | ------------- | --------------- |
 | `adblock.enableAglint` | Enable or disable AGLint integration. If disabled, only syntax highlighting and other language features will be available. | `true` | `true`, `false` |
+| `adblock.enableAglintDebug` | Enable or disable AGLint debug logging. | `false` | `true`, `false` |
+| `adblock.enableAglintCache` | Enable or disable caching of linting results for better performance. | `true` | `true`, `false` |
 <!--markdownlint-enable MD013-->
 
 ### GitHub Linguist support

package.json

@@ -65,6 +65,18 @@
                     "type": "boolean",
                     "default": true,
                     "description": "Enable or disable AGLint integration. If disabled, only syntax highlighting and other language features will be available."
+                },
+                "adblock.enableAglintDebug": {
+                    "scope": "resource",
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Enable or disable AGLint debug logging."
+                },
+                "adblock.enableAglintCache": {
+                    "scope": "resource",
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Enable or disable caching of linting results for better performance."
                 }
             }
         }
@@ -139,7 +151,6 @@
         "yaml": "^2.2.2"
     },
     "pnpm": {
-        "neverBuiltDependencies": [],
-        "overrides": {}
+        "neverBuiltDependencies": []
     }
 }

pnpm-lock.yaml

@@ -4,4 +4,4 @@ packages:
   - test/static/aglint
 
 catalog:
-  '@adguard/aglint': ^4.0.0-alpha.7
+  '@adguard/aglint': ^4.0.0-alpha.8

pnpm-workspace.yaml

@@ -0,0 +1,17 @@
+module.exports = {
+    extends: '../.eslintrc.cjs',
+    rules: {
+        'no-restricted-imports': 'off',
+        '@typescript-eslint/no-restricted-imports': [
+            'error',
+            {
+                patterns: [
+                    {
+                        group: ['@adguard/aglint', '@adguard/aglint/*'],
+                        allowTypeImports: true,
+                    },
+                ],
+            },
+        ],
+    },
+};

server/.eslintrc.cjs

@@ -0,0 +1,130 @@
+import type {
+    Debug,
+    FileSystemAdapter,
+    LinterTree,
+    PathAdapter,
+} from '@adguard/aglint/cli';
+import type { Connection, TextDocuments } from 'vscode-languageserver/node';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+
+import { LSPFileSystemAdapter } from '../adapters/fs';
+import type { LoadedAglint } from '../utils/aglint-loader';
+import { loadAglintModule } from '../utils/aglint-loader';
+
+/**
+ * Encapsulates all AGLint-related state and dependencies.
+ */
+export class AglintContext {
+    /**
+     * Loaded AGLint module.
+     */
+    public aglint: LoadedAglint;
+
+    /**
+     * Debug instance.
+     */
+    public debuggerInstance: Debug;
+
+    /**
+     * File system adapter.
+     */
+    public fsAdapter: FileSystemAdapter;
+
+    /**
+     * Path adapter.
+     */
+    public pathAdapter: PathAdapter;
+
+    /**
+     * Linter tree.
+     */
+    public linterTree: LinterTree;
+
+    /**
+     * Creates a new AGLint context.
+     *
+     * @param aglint Loaded AGLint module.
+     * @param debuggerInstance Debug instance.
+     * @param fsAdapter File system adapter.
+     * @param pathAdapter Path adapter.
+     * @param linterTree Linter tree.
+     */
+    constructor(
+        aglint: LoadedAglint,
+        debuggerInstance: Debug,
+        fsAdapter: FileSystemAdapter,
+        pathAdapter: PathAdapter,
+        linterTree: LinterTree,
+    ) {
+        this.aglint = aglint;
+        this.debuggerInstance = debuggerInstance;
+        this.fsAdapter = fsAdapter;
+        this.pathAdapter = pathAdapter;
+        this.linterTree = linterTree;
+    }
+
+    /**
+     * Create and initialize a new AGLint context.
+     *
+     * @param connection Language server connection.
+     * @param documents Text document manager.
+     * @param root Workspace root path.
+     * @param enableDebug Whether to enable debug logging.
+     *
+     * @returns Initialized AGLint context or undefined if initialization failed.
+     */
+    public static async create(
+        connection: Connection,
+        documents: TextDocuments<TextDocument>,
+        root: string,
+        enableDebug: boolean,
+    ): Promise<AglintContext | undefined> {
+        const aglint = await loadAglintModule(connection, root);
+
+        if (!aglint) {
+            connection.console.error('AGLint module could not be loaded');
+            return undefined;
+        }
+
+        connection.console.info(`AGLint module loaded (version: ${aglint.version})`);
+
+        const pathAdapter = new aglint.cli.NodePathAdapter();
+        const fsAdapter = new LSPFileSystemAdapter(documents);
+
+        const debuggerInstance = new aglint.cli.Debug({
+            enabled: enableDebug,
+            printTimestamps: false,
+            printElapsed: false,
+            colors: false,
+            logger: (message) => connection.console.info(`[AGLint debug] ${message}`),
+        });
+
+        const configResolver = new aglint.cli.ConfigResolver(
+            fsAdapter,
+            pathAdapter,
+            {
+                presetsRoot: aglint.presetsRoot,
+                baseConfig: {},
+            },
+            debuggerInstance.module('config-resolver'),
+        );
+
+        const linterTree = new aglint.cli.LinterTree(
+            fsAdapter,
+            pathAdapter,
+            {
+                configFileNames: aglint.cli.CONFIG_FILE_NAMES,
+                ignoreFileName: aglint.cli.IGNORE_FILE_NAME,
+                root,
+            },
+            {
+                resolve: (p) => configResolver.resolve(p),
+                isRoot: (p) => configResolver.isRoot(p),
+                invalidate: (p) => configResolver.invalidate(p),
+            },
+            debuggerInstance.module('linter-tree'),
+        );
+
+        return new AglintContext(aglint, debuggerInstance, fsAdapter, pathAdapter, linterTree);
+    }
+}