GLSP-1634: Switch to eslint 9.x (#126)

tortmayr · web-flow · commit 978a9cd079d5 · 2026-02-19T19:05:08.000+01:00
Part of eclipse-glsp/glsp/issues/1634
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.gitignore b/.gitignore
@@ -18,4 +18,9 @@ report.xml
 wf-glsp-server-node.js
 wf-glsp-server-node.js.map
 wf-glsp-server-webworker.js
-wf-glsp-server-webworker.js.map
+wf-glsp-server-webworker.js.map
+
+.claude/settings.local.json
+CLAUDE.local.md
+.claude/plans/
+.reviews/
diff --git a/AGENTS.md b/AGENTS.md
@@ -0,0 +1,47 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+
+This repository is a Yarn workspace monorepo for the GLSP Node server stack.
+
+-   `packages/server`: core framework (`src/common`, `src/node`, `src/browser`).
+-   `packages/graph`: TypeScript GModel types and utilities.
+-   `packages/layout-elk`: ELK-based layout integration.
+-   `examples/workflow-server` and `examples/workflow-server-bundled`: runnable example server and bundling setup.
+-   Root config files (`tsconfig.json`, `eslint.config.mjs`, `.mocharc`, `.nycrc`) define shared standards across packages.
+
+## Build, Test, and Development Commands
+
+Run from repository root unless noted.
+
+-   `yarn`: install dependencies and trigger prepare build.
+-   `yarn build`: compile TypeScript and bundle the workflow example.
+-   `yarn lint`: run ESLint across the repo.
+-   `yarn test`: run package tests via Lerna (`--no-bail`).
+-   `yarn test:coverage`: run coverage per package (nyc).
+-   `yarn format` / `yarn format:check`: apply/check Prettier formatting.
+-   `yarn check:all`: full CI-style validation (lint, test, format, header checks).
+-   `yarn start` or `yarn start:websocket`: launch bundled workflow example server.
+
+## Coding Style & Naming Conventions
+
+-   Language: TypeScript (`Node >= 20`, Yarn 1.x).
+-   Formatting and linting are enforced by `@eclipse-glsp/prettier-config` and `@eclipse-glsp/eslint-config`.
+-   Use 4-space indentation and existing import ordering patterns.
+-   Prefer descriptive kebab-case filenames; tests use `*.spec.ts`.
+-   Keep public API barrel exports current (use `yarn generate:index` when needed).
+
+## Testing Guidelines
+
+-   Framework: Mocha with shared config from `.mocharc`.
+-   Place tests next to source files using `*.spec.ts` naming.
+-   Run all tests: `yarn test`; package-only tests: `yarn --cwd packages/server test`.
+-   Validate coverage with `yarn test:coverage` before opening larger changes.
+
+## Commit & Pull Request Guidelines
+
+-   Open or reference an umbrella issue in `https://github.com/eclipse-glsp/glsp` before implementation.
+-   Branch naming convention: `issues/<issue_number>` (for example, `issues/241`).
+-   Commit messages should be imperative and include issue linkage with an absolute URL, e.g. `closes https://github.com/eclipse-glsp/glsp/issues/241`.
+-   PRs should include: problem statement, scope, test evidence (`yarn test`, `yarn lint`), and screenshots/logs for behavior changes.
+-   Ensure ECA requirements are met before requesting merge.
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -0,0 +1 @@
+@AGENTS.md
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # GLSP Server [![Build Status](https://img.shields.io/github/actions/workflow/status/eclipse-glsp/glsp-server-node/ci.yml?branch=main&label=build)](https://github.com/eclipse-glsp/glsp-server-node/actions/workflows/ci.yml)
+
 Contains the code for the Typescript-based framework to create [GLSP](https://github.com/eclipse-glsp/glsp) server components.
 The implementation of this server is aligned with the default Java based [GLSP Server](https://github.com/eclipse-glsp/glsp-server-node).
 
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,46 @@
+import glspConfig from '@eclipse-glsp/eslint-config';
+
+export default [
+    ...glspConfig,
+    // Ignore JS config/build files that are not part of the TS project
+    {
+        ignores: ['**/*.js', '**/*.mjs', '**/*.cjs']
+    },
+    // Apply parserOptions.project only to TypeScript files
+    {
+        files: ['**/*.{ts,tsx}'],
+        languageOptions: {
+            parserOptions: {
+                project: './tsconfig.eslint.json',
+                tsconfigRootDir: import.meta.dirname
+            }
+        }
+    },
+    // Repository-specific rule overrides
+    {
+        files: ['**/*.{ts,tsx}'],
+        rules: {
+            '@typescript-eslint/no-shadow': 'off',
+            '@typescript-eslint/padding-line-between-statements': 'off',
+            'no-restricted-imports': [
+                'warn',
+                {
+                    name: 'sprotty-protocol',
+                    message:
+                        "The sprotty-protocol default exports are customized and reexported by GLSP. Please import from '@eclipse-glsp/protocol' instead"
+                },
+                '.',
+                '..',
+                '../..'
+            ]
+        }
+    },
+    // Test file overrides
+    {
+        files: ['**/*.spec.{ts,tsx}'],
+        rules: {
+            '@typescript-eslint/no-unused-expressions': 'off',
+            'import-x/namespace': 'off'
+        }
+    }
+];
diff --git a/examples/workflow-server/package.json b/examples/workflow-server/package.json
@@ -51,7 +51,7 @@
     "bundle:browser": "webpack --env target=webworker ",
     "clean": "rimraf lib *.tsbuildinfo",
     "generate:index": "glsp generateIndex src/browser src/common src/node -s -f",
-    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint": "eslint ./src",
     "watch": "tsc -w",
     "watch:bundle": "webpack -w"
   },
diff --git a/examples/workflow-server/src/common/util/model-types.ts b/examples/workflow-server/src/common/util/model-types.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,7 +13,6 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-/* eslint-disable @typescript-eslint/padding-line-between-statements */
 export namespace ModelTypes {
     export const LABEL_HEADING = 'label:heading';
     export const LABEL_TEXT = 'label:text';
diff --git a/package.json b/package.json
@@ -10,14 +10,16 @@
     "all": "yarn install && yarn lint && yarn test",
     "build": "yarn compile && yarn bundle",
     "bundle": "yarn --cwd examples/workflow-server bundle",
-    "check:headers": "glsp checkHeaders . -t lastCommit",
-    "check:pr": "yarn all && yarn format:check && yarn check:headers",
+    "check:all": "yarn install && yarn lint && yarn test && yarn format:check && yarn headers:check",
     "clean": "lerna run clean && rimraf coverage .nyc_output",
     "compile": "tsc -b",
+    "fix:all": "yarn lint:fix && yarn format && yarn headers:fix",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "generate:index": "lerna run generate:index && yarn lint:fix",
-    "lint": "eslint --ext .ts,.tsx .",
+    "headers:check": "glsp checkHeaders .",
+    "headers:fix": "glsp checkHeaders . --autoFix",
+    "lint": "eslint .",
     "lint:ci": "yarn lint --output-file eslint_report.json --format json",
     "lint:fix": "yarn lint --fix",
     "prepare": " yarn compile && yarn bundle",
diff --git a/packages/graph/package.json b/packages/graph/package.json
@@ -42,7 +42,7 @@
     "build": "tsc -b",
     "clean": "rimraf lib *.tsbuildinfo coverage .nyc_output",
     "generate:index": "glsp generateIndex src -f -s",
-    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint": "eslint ./src",
     "test": "mocha --config ../../.mocharc \"./src/**/*.spec.?(ts|tsx)\"",
     "test:ci": "yarn test --reporter mocha-ctrf-json-reporter",
     "test:coverage": "nyc yarn test",
diff --git a/packages/layout-elk/package.json b/packages/layout-elk/package.json
@@ -42,7 +42,7 @@
     "build": "tsc -b",
     "clean": "rimraf lib *.tsbuildinfo coverage .nyc_output",
     "generate:index": "glsp generateIndex src -f -s",
-    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint": "eslint ./src",
     "test": "mocha --config ../../.mocharc \"./src/**/*.spec.?(ts|tsx)\"",
     "test:ci": "yarn test --reporter mocha-ctrf-json-reporter",
     "test:coverage": "nyc yarn test",
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -51,7 +51,7 @@
     "build": "tsc -b",
     "clean": "rimraf lib *.tsbuildinfo coverage .nyc_output",
     "generate:index": "glsp generateIndex src/browser src/common src/node -s -f",
-    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint": "eslint ./src",
     "test": "mocha --config ../../.mocharc \"./src/**/*.spec.?(ts|tsx)\"",
     "test:ci": "yarn test --reporter mocha-ctrf-json-reporter",
     "test:coverage": "nyc yarn test:ci",
diff --git a/packages/server/src/common/actions/global-action-provider.ts b/packages/server/src/common/actions/global-action-provider.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -51,7 +51,7 @@ export class DefaultGlobalActionProvider implements GlobalActionProvider {
         const container = serverContainer.createChild();
         const clientSessionModule = createClientSessionModule({
             clientId: 'tempId',
-            // eslint-disable-next-line @typescript-eslint/no-empty-function
+
             glspClient: { process: () => {} },
             clientActionKinds: []
         });
diff --git a/packages/server/src/common/command/recording-command.spec.ts b/packages/server/src/common/command/recording-command.spec.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2023-2024 EclipseSource and others.
+ * Copyright (c) 2023-2026 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -53,7 +53,6 @@ describe('RecordingCommand', () => {
     });
 
     it('should be undoable after execution', async () => {
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
         const command = new TestRecordingCommand(jsonObject, () => {});
         expect(command.canUndo()).to.be.false;
         await command.execute();
diff --git a/packages/server/src/common/features/clipboard/request-clipboard-data-action-handler.ts b/packages/server/src/common/features/clipboard/request-clipboard-data-action-handler.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -44,7 +44,7 @@ export class RequestClipboardDataActionHandler implements ActionHandler {
         selectedElements.forEach(element => {
             schemas.push(this.modelSerializer.createSchema(element));
         });
-        // eslint-disable-next-line no-null/no-null
+
         clipboardData['application/json'] = JSON.stringify(schemas, undefined, 2);
         return [SetClipboardDataAction.create(clipboardData)];
     }
diff --git a/packages/server/src/common/features/contextactions/context-actions-provider-registry.spec.ts b/packages/server/src/common/features/contextactions/context-actions-provider-registry.spec.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -15,11 +15,11 @@
  ********************************************************************************/
 import { GModelElement } from '@eclipse-glsp/graph';
 import { Args, LabeledAction, Point } from '@eclipse-glsp/protocol';
+import { expect } from 'chai';
 import { CommandPaletteActionProvider } from './command-palette-action-provider';
 import { ContextActionsProvider } from './context-actions-provider';
 import { ContextActionsProviderRegistry } from './context-actions-provider-registry';
 import { DefaultToolPaletteItemProvider } from './tool-palette-item-provider';
-import { expect } from 'chai';
 
 describe('Test DefaultContextActionsProviderRegistry', () => {
     it('check if default registry is empty', () => {
diff --git a/packages/server/src/common/features/layout/computed-bounds-action-handler.ts b/packages/server/src/common/features/layout/computed-bounds-action-handler.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/server/src/common/features/model/model-submission-handler.ts b/packages/server/src/common/features/model/model-submission-handler.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2024 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/server/src/common/protocol/glsp-server.ts b/packages/server/src/common/protocol/glsp-server.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -68,7 +68,6 @@ export class DefaultGLSPServer implements GLSPServer {
     protected validateProtocolVersion(params: InitializeParameters): void {
         if (params.protocolVersion !== DefaultGLSPServer.PROTOCOL_VERSION) {
             throw new Error(
-                // eslint-disable-next-line max-len
                 `Protocol version mismatch! The client protocol version ${params.protocolVersion} is not compatible with the server protocol version ${DefaultGLSPServer.PROTOCOL_VERSION}!`
             );
         }
diff --git a/packages/server/src/common/test/mock-util.ts b/packages/server/src/common/test/mock-util.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2024 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-/* eslint-disable @typescript-eslint/no-empty-function */
+
 // Stub-implementation classes used for unit testing
 
 import { GEdge, GModelElement, GModelElementConstructor, GNode } from '@eclipse-glsp/graph';
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# GLSP Server [![Build Status](https://img.shields.io/github/actions/workflow/status/eclipse-glsp/glsp-server-node/ci.yml?branch=main&label=build)](https://github.com/eclipse-glsp/glsp-server-node/actions/workflows/ci.yml)`
	`2`	`+`
`2`	`3`	`Contains the code for the Typescript-based framework to create [GLSP](https://github.com/eclipse-glsp/glsp) server components.`
`3`	`4`	`The implementation of this server is aligned with the default Java based [GLSP Server](https://github.com/eclipse-glsp/glsp-server-node).`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/********************************************************************************`
`2`		`- * Copyright (c) 2022-2023 STMicroelectronics and others.`
	`2`	`+ * Copyright (c) 2022-2026 STMicroelectronics and others.`
`3`	`3`	`*`
`4`	`4`	`* This program and the accompanying materials are made available under the`
`5`	`5`	`* terms of the Eclipse Public License v. 2.0 which is available at`
`@@ -13,7 +13,6 @@`
`13`	`13`	`*`
`14`	`14`	`* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0`
`15`	`15`	`********************************************************************************/`
`16`		`-/* eslint-disable @typescript-eslint/padding-line-between-statements */`
`17`	`16`	`export namespace ModelTypes {`
`18`	`17`	`export const LABEL_HEADING = 'label:heading';`
`19`	`18`	`export const LABEL_TEXT = 'label:text';`