GH-708 Improve eslint config (#27)

- Refactor eslint config according to the recommendations of https://typescript-eslint.io/docs/linting/monorepo/
- Add CLI script for fixing eslint issues

Part of eclipse-glsp/glsp#708

packages/vscode-integration-webview/.eslintrc.js → .eslintrc.js

@@ -1,9 +1,12 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
+    root: true,
     extends: '@eclipse-glsp',
+    ignorePatterns: ['**/{node_modules,lib}', '**/.eslintrc.js'],
+
     parserOptions: {
         tsconfigRootDir: __dirname,
-        project: 'tsconfig.json'
+        project: 'tsconfig.eslint.json'
     },
     rules: {
         'no-restricted-imports': [
@@ -15,7 +18,7 @@ module.exports = {
             {
                 name: 'sprotty-protocol',
                 message:
-                    "The sprotty-protocol default exports are customized and reexported by GLSP. Please use '@eclipse-glsp/client' instead"
+                    "The sprotty-protocol default exports are customized and reexported by GLSP. Please use '@eclipse-glsp/protocol' or '@eclipse-glsp/client' instead"
             }
         ]
     }

example/workflow/extension/.eslintrc.js

@@ -1,10 +1,6 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
-    extends: '@eclipse-glsp',
-    parserOptions: {
-        tsconfigRootDir: __dirname,
-        project: 'tsconfig.json'
-    },
+    extends: '../../../.eslintrc.js',
     rules: {
         'import/no-unresolved': 'off'
     }

example/workflow/extension/package.json

@@ -198,7 +198,8 @@
     "prepare": "yarn clean && yarn build && yarn lint",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
     "watch": "tsc -w",
-    "lint": "eslint -c ./.eslintrc.js --ext .ts ./src",
+    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint:fix": "eslint --fix --ext .ts,.tsx ./src",
     "build": "tsc  && yarn download:Server",
     "publish": "vsce publish",
     "download:Server": "ts-node ../scripts/download.ts"

example/workflow/webview/package.json

@@ -46,7 +46,8 @@
     "prepare": "yarn clean && yarn build && yarn lint",
     "clean": "rimraf lib ../extension/pack tsconfig.tsbuildinfo",
     "build": "tsc && webpack --mode=development",
-    "lint": "eslint -c ./.eslintrc.js --ext .ts ./src",
+    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint:fix": "eslint --fix --ext .ts,.tsx ./src",
     "watch": "tsc -w"
   }
 }

packages/vscode-integration-webview/package.json

@@ -43,7 +43,8 @@
     "clean": "rimraf lib tsconfig.tsbuildinfo",
     "build": "tsc",
     "watch": "tsc -w",
-    "lint": "eslint -c ./.eslintrc.js --ext .ts ./src"
+    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint:fix": "eslint --fix --ext .ts,.tsx ./src"
   },
   "publishConfig": {
     "access": "public"

packages/vscode-integration/.eslintrc.js

@@ -1,10 +1,6 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
-    extends: '@eclipse-glsp',
-    parserOptions: {
-        tsconfigRootDir: __dirname,
-        project: 'tsconfig.json'
-    },
+    extends: '../../.eslintrc.js',
     rules: {
         'import/no-unresolved': 'off'
     }

packages/vscode-integration/package.json

@@ -46,7 +46,8 @@
     "clean": "rimraf lib tsconfig.tsbuildinfo",
     "build": "tsc",
     "watch": "tsc -w",
-    "lint": "eslint -c ./.eslintrc.js --ext .ts ./src"
+    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint:fix": "eslint --fix --ext .ts,.tsx ./src"
   },
   "publishConfig": {
     "access": "public"

packages/vscode-integration/src/quickstart-components/configuration-util.ts

@@ -13,8 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { CenterAction, FitToScreenAction, LayoutOperation, RequestExportSvgAction } from '@eclipse-glsp/protocol';
-import { SelectAllAction } from 'sprotty-protocol';
+import { CenterAction, FitToScreenAction, LayoutOperation, RequestExportSvgAction, SelectAllAction } from '@eclipse-glsp/protocol';
 import * as vscode from 'vscode';
 import { GlspVscodeConnector } from '../glsp-vscode-connector';
 

tsconfig.eslint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@eclipse-glsp/ts-config/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "exclude": ["**/node_modules", "**/.eslintrc.js"],
+  "include": ["packages/*/src", "example/**/*/src", "**/scripts/"]
+}