Migrating to ESLint and adding recommit checks (#17908)

* chore: Update eslint configuration and remove unused files

* Adding pre commit hook

* Fixing eslint parser

* fix lint

* chore: Update eslint configuration and remove unused files

* Update eslint configuration and add eslint-plugin-jsdoc

* chore: Update eslint configuration to use "warn" level for "notice/notice" rule

Author: aasimkhan30

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint

.vscode/settings.json

@@ -21,4 +21,5 @@
 	"yaml.schemas": {
 		"https://raw.githubusercontent.com/microsoft/azure-pipelines-vscode/master/service-schema.json": "build/**/*.yml"
 	},
+    "eslint.validate": [ "javascript", "javascriptreact", "html", "typescriptreact", "typescript" ],
 }

.vscode/tasks.json

@@ -20,6 +20,13 @@
                 "_id": "build",
                 "isDefault": false
             }
+        },
+        {
+            "type": "npm",
+            "script": "lint",
+            "problemMatcher": [],
+            "label": "npm: lint",
+            "detail": "eslint ."
         }
     ]
 }

eslint.config.mjs

@@ -0,0 +1,71 @@
+// @ts-check
+
+import tseslint from 'typescript-eslint';
+import notice from "eslint-plugin-notice";
+import jsdoc from 'eslint-plugin-jsdoc';
+
+export default [
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    ignores: ['src/prompts/**/*.ts'],  // Ignore prompts files as they are copied from other repos
+    languageOptions: {
+      parser: tseslint.parser
+    },
+    plugins: {
+      notice,
+      jsdoc
+    },
+    rules: {
+      "notice/notice": [
+        "warn",
+        {
+          template: `/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+`,
+          onNonMatchingHeader: 'prepend',
+          messages: {
+            whenFailedToMatch: "Missing or incorrectly formatted copyright statement.",
+          }
+        },
+
+      ],
+      "no-undef": "off",
+      "no-unused-vars": "off",
+      "constructor-super": "warn",
+      "curly": "off",
+      "eqeqeq": "warn",
+      "no-buffer-constructor": "warn",
+      "no-caller": "warn",
+      "no-debugger": "warn",
+      "no-duplicate-case": "warn",
+      "no-duplicate-imports": "off",
+      "no-eval": "warn",
+      "no-async-promise-executor": "off",
+      "no-extra-semi": "warn",
+      "no-new-wrappers": "warn",
+      "no-redeclare": "off",
+      "no-sparse-arrays": "warn",
+      "no-throw-literal": "off",
+      "no-unsafe-finally": "warn",
+      "no-unused-labels": "warn",
+      "no-restricted-globals": [
+        "warn",
+        "name",
+        "length",
+        "event",
+        "closed",
+        "external",
+        "status",
+        "origin",
+        "orientation",
+        "context"
+      ], // non-complete list of globals that are easy to access unintentionally
+      "no-var": "off",
+      "semi": "off",
+      "jsdoc/no-types": "warn",
+    },
+  }
+];

gulpfile.js

@@ -1,8 +1,6 @@
 var gulp = require('gulp');
 var rename = require('gulp-rename');
-var gulpTsLint = require('gulp-tslint');
 var ts = require('gulp-typescript');
-var tslint = require('tslint');
 var tsProject = ts.createProject('tsconfig.json');
 var del = require('del');
 var srcmap = require('gulp-sourcemaps');
@@ -14,24 +12,20 @@ var nls = require('vscode-nls-dev');
 var argv = require('yargs').argv;
 var min = (argv.min === undefined) ? false : true;
 var vscodeTest = require('@vscode/test-electron');
+const gulpESLintNew = require('gulp-eslint-new');
 
 require('./tasks/packagetasks');
 require('./tasks/localizationtasks');
 
 gulp.task('ext:lint', () => {
-	// !! If updating this make sure to check if you need to update the TSA Scan task in ADO !!
-	var program = tslint.Linter.createProgram('tsconfig.json');
 	return gulp.src([
 		config.paths.project.root + '/src/**/*.ts',
 		'!' + config.paths.project.root + '/src/views/htmlcontent/**/*',
 		config.paths.project.root + '/test/**/*.ts'
 	])
-		.pipe((gulpTsLint({
-			program,
-			formatter: "verbose",
-			rulesDirectory: "node_modules/tslint-microsoft-contrib"
-		})))
-		.pipe(gulpTsLint.report());
+		.pipe(gulpESLintNew())
+		.pipe(gulpESLintNew.format())           // Output lint results to the console.
+		.pipe(gulpESLintNew.failAfterError());
 });
 
 // Copy icons for OE

package.json

@@ -50,7 +50,8 @@
   "scripts": {
     "build": "gulp build",
     "compile": "gulp ext:compile",
-    "watch": "gulp watch"
+    "watch": "gulp watch",
+    "lint": "gulp lint"
   },
   "devDependencies": {
     "@angular/common": "~2.1.2",
@@ -61,8 +62,10 @@
     "@angular/platform-browser-dynamic": "~2.1.2",
     "@angular/router": "~3.1.2",
     "@angular/upgrade": "~2.1.2",
+    "@eslint/js": "^9.5.0",
     "@types/azdata": "^1.44.0",
     "@types/ejs": "^3.1.0",
+    "@types/eslint__js": "^8.42.3",
     "@types/jquery": "^3.3.31",
     "@types/jqueryui": "^1.12.7",
     "@types/keytar": "^4.4.2",
@@ -83,15 +86,19 @@
     "coveralls": "^3.0.2",
     "decache": "^4.1.0",
     "del": "^2.2.1",
+    "eslint": "^9.5.0",
+    "eslint-plugin-jsdoc": "^48.2.12",
+    "eslint-plugin-notice": "^1.0.0",
     "gulp": "^4.0.2",
     "gulp-concat": "^2.6.0",
+    "gulp-eslint-new": "^2.1.0",
     "gulp-istanbul-report": "0.0.1",
     "gulp-rename": "^1.2.2",
     "gulp-shell": "^0.7.0",
     "gulp-sourcemaps": "^1.6.0",
-    "gulp-tslint": "^8.1.4",
     "gulp-typescript": "^5.0.1",
     "gulp-uglify": "^2.0.0",
+    "husky": "^9.0.11",
     "istanbul": "^0.4.5",
     "pm-mocha-jenkins-reporter": "^0.2.6",
     "remap-istanbul": "0.9.6",
@@ -101,10 +108,9 @@
     "systemjs": "0.19.40",
     "systemjs-builder": "^0.15.32",
     "systemjs-plugin-json": "^0.2.0",
-    "tslint": "^6.1.3",
-    "tslint-microsoft-contrib": "^6.2.0",
     "typemoq": "^1.7.0",
-    "typescript": "^5.0.4",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.13.1",
     "uglify-js": "mishoo/UglifyJS2#harmony-v2.8.22",
     "vscode-nls-dev": "2.0.1",
     "yargs": "https://registry.npmjs.org/yargs/-/yargs-3.32.0.tgz"
@@ -1215,4 +1221,4 @@
       }
     }
   }
-}
+}