Merge pull request #1791 from github/elena/eslint-github

Install `eslint-plugin-github` and apply autofixes where possible

Author: elenatanasoiu

extensions/ql-vscode/.eslintrc.js

@@ -5,16 +5,22 @@ module.exports = {
     sourceType: "module",
     project: ["tsconfig.json", "./src/**/tsconfig.json", "./gulpfile.ts/tsconfig.json", "./scripts/tsconfig.json", "./.storybook/tsconfig.json"],
   },
-  plugins: ["@typescript-eslint"],
+  plugins: [
+    "github",
+    "@typescript-eslint"
+  ],
   env: {
     node: true,
     es6: true,
   },
   extends: [
     "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
+    "plugin:github/react",
+    "plugin:github/recommended",
+    "plugin:github/typescript",
     "plugin:jest-dom/recommended",
-    "plugin:prettier/recommended"
+    "plugin:prettier/recommended",
+    "plugin:@typescript-eslint/recommended"
   ],
   rules: {
     "@typescript-eslint/no-use-before-define": 0,
@@ -31,8 +37,36 @@ module.exports = {
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-floating-promises": [ "error", { ignoreVoid: true } ],
+    "@typescript-eslint/no-invalid-this": "off",
+    "@typescript-eslint/no-shadow": "off",
     "prefer-const": ["warn", { destructuring: "all" }],
     "@typescript-eslint/no-throw-literal": "error",
     "no-useless-escape": 0,
+    "camelcase": "off",
+    "eqeqeq": "off",
+    "escompat/no-regexp-lookbehind": "off",
+    "filenames/match-regex": "off",
+    "filenames/match-regexp": "off",
+    "func-style": "off",
+    "i18n-text/no-en": "off",
+    "import/named": "off",
+    "import/no-dynamic-require": "off",
+    "import/no-dynamic-required": "off",
+    "import/no-anonymous-default-export": "off",
+    "import/no-commonjs": "off",
+    "import/no-mutable-exports": "off",
+    "import/no-namespace": "off",
+    "import/no-unresolved": "off",
+    "import/no-webpack-loader-syntax": "off",
+    "jsx-a11y/anchor-is-valid": "off",
+    "jsx-a11y/no-noninteractive-element-interactions": "off",
+    "jsx-a11y/no-static-element-interactions": "off",
+    "jsx-a11y/click-events-have-key-events": "off",
+    "no-invalid-this": "off",
+    "no-fallthrough": "off",
+    "no-console": "off",
+    "no-shadow": "off",
+    "github/array-foreach": "off",
+    "github/no-then": "off",
   },
 };

extensions/ql-vscode/gulpfile.ts/appInsights.ts

@@ -1,4 +1,4 @@
-import * as gulp from "gulp";
+import { src, dest } from "gulp";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const replace = require("gulp-replace");
 
@@ -13,8 +13,7 @@ export function injectAppInsightsKey() {
   }
 
   // replace the key
-  return gulp
-    .src(["out/telemetry.js"])
+  return src(["out/telemetry.js"])
     .pipe(replace(/REPLACE-APP-INSIGHTS-KEY/, process.env.APP_INSIGHTS_KEY))
-    .pipe(gulp.dest("out/"));
+    .pipe(dest("out/"));
 }

extensions/ql-vscode/gulpfile.ts/deploy.ts

@@ -1,5 +1,13 @@
-import * as fs from "fs-extra";
-import * as path from "path";
+import {
+  copy,
+  readFile,
+  mkdirs,
+  readdir,
+  unlinkSync,
+  remove,
+  writeFile,
+} from "fs-extra";
+import { resolve, join } from "path";
 
 export interface DeployedPackage {
   distPath: string;
@@ -25,12 +33,9 @@ async function copyPackage(
 ): Promise<void> {
   for (const file of packageFiles) {
     console.log(
-      `copying ${path.resolve(sourcePath, file)} to ${path.resolve(
-        destPath,
-        file,
-      )}`,
+      `copying ${resolve(sourcePath, file)} to ${resolve(destPath, file)}`,
     );
-    await fs.copy(path.resolve(sourcePath, file), path.resolve(destPath, file));
+    await copy(resolve(sourcePath, file), resolve(destPath, file));
   }
 }
 
@@ -39,53 +44,52 @@ export async function deployPackage(
 ): Promise<DeployedPackage> {
   try {
     const packageJson: any = JSON.parse(
-      await fs.readFile(packageJsonPath, "utf8"),
+      await readFile(packageJsonPath, "utf8"),
     );
 
     // Default to development build; use flag --release to indicate release build.
     const isDevBuild = !process.argv.includes("--release");
-    const distDir = path.join(__dirname, "../../../dist");
-    await fs.mkdirs(distDir);
+    const distDir = join(__dirname, "../../../dist");
+    await mkdirs(distDir);
 
     if (isDevBuild) {
       // NOTE: rootPackage.name had better not have any regex metacharacters
       const oldDevBuildPattern = new RegExp(
-        "^" + packageJson.name + "[^/]+-dev[0-9.]+\\.vsix$",
+        `^${packageJson.name}[^/]+-dev[0-9.]+\\.vsix$`,
       );
       // Dev package filenames are of the form
       //    vscode-codeql-0.0.1-dev.2019.9.27.19.55.20.vsix
-      (await fs.readdir(distDir))
+      (await readdir(distDir))
         .filter((name) => name.match(oldDevBuildPattern))
         .map((build) => {
           console.log(`Deleting old dev build ${build}...`);
-          fs.unlinkSync(path.join(distDir, build));
+          unlinkSync(join(distDir, build));
         });
       const now = new Date();
       packageJson.version =
-        packageJson.version +
-        `-dev.${now.getUTCFullYear()}.${
+        `${packageJson.version}-dev.${now.getUTCFullYear()}.${
           now.getUTCMonth() + 1
         }.${now.getUTCDate()}` +
         `.${now.getUTCHours()}.${now.getUTCMinutes()}.${now.getUTCSeconds()}`;
     }
 
-    const distPath = path.join(distDir, packageJson.name);
-    await fs.remove(distPath);
-    await fs.mkdirs(distPath);
+    const distPath = join(distDir, packageJson.name);
+    await remove(distPath);
+    await mkdirs(distPath);
 
-    await fs.writeFile(
-      path.join(distPath, "package.json"),
+    await writeFile(
+      join(distPath, "package.json"),
       JSON.stringify(packageJson, null, 2),
     );
 
-    const sourcePath = path.join(__dirname, "..");
+    const sourcePath = join(__dirname, "..");
     console.log(
       `Copying package '${packageJson.name}' and its dependencies to '${distPath}'...`,
     );
     await copyPackage(sourcePath, distPath);
 
     return {
-      distPath: distPath,
+      distPath,
       name: packageJson.name,
       version: packageJson.version,
     };

extensions/ql-vscode/gulpfile.ts/index.ts

@@ -1,14 +1,14 @@
-import * as gulp from "gulp";
+import { series, parallel } from "gulp";
 import { compileTypeScript, watchTypeScript, cleanOutput } from "./typescript";
 import { compileTextMateGrammar } from "./textmate";
 import { copyTestData, watchTestData } from "./tests";
 import { compileView, watchView } from "./webpack";
 import { packageExtension } from "./package";
 import { injectAppInsightsKey } from "./appInsights";
 
-export const buildWithoutPackage = gulp.series(
+export const buildWithoutPackage = series(
   cleanOutput,
-  gulp.parallel(
+  parallel(
     compileTypeScript,
     compileTextMateGrammar,
     compileView,
@@ -27,7 +27,7 @@ export {
   injectAppInsightsKey,
   compileView,
 };
-export default gulp.series(
+export default series(
   buildWithoutPackage,
   injectAppInsightsKey,
   packageExtension,

extensions/ql-vscode/gulpfile.ts/package.ts

@@ -1,22 +1,22 @@
-import * as path from "path";
+import { resolve } from "path";
 import { deployPackage } from "./deploy";
-import * as childProcess from "child-process-promise";
+import { spawn } from "child-process-promise";
 
 export async function packageExtension(): Promise<void> {
-  const deployedPackage = await deployPackage(path.resolve("package.json"));
+  const deployedPackage = await deployPackage(resolve("package.json"));
   console.log(
     `Packaging extension '${deployedPackage.name}@${deployedPackage.version}'...`,
   );
   const args = [
     "package",
     "--out",
-    path.resolve(
+    resolve(
       deployedPackage.distPath,
       "..",
       `${deployedPackage.name}-${deployedPackage.version}.vsix`,
     ),
   ];
-  const proc = childProcess.spawn("./node_modules/.bin/vsce", args, {
+  const proc = spawn("./node_modules/.bin/vsce", args, {
     cwd: deployedPackage.distPath,
   });
   proc.childProcess.stdout!.on("data", (data) => {

extensions/ql-vscode/gulpfile.ts/tests.ts

@@ -1,21 +1,21 @@
-import * as gulp from "gulp";
+import { watch, src, dest } from "gulp";
 
 export function copyTestData() {
   return Promise.all([copyNoWorkspaceData(), copyCliIntegrationData()]);
 }
 
 export function watchTestData() {
-  return gulp.watch(["src/vscode-tests/*/data/**/*"], copyTestData);
+  return watch(["src/vscode-tests/*/data/**/*"], copyTestData);
 }
 
 function copyNoWorkspaceData() {
-  return gulp
-    .src("src/vscode-tests/no-workspace/data/**/*")
-    .pipe(gulp.dest("out/vscode-tests/no-workspace/data"));
+  return src("src/vscode-tests/no-workspace/data/**/*").pipe(
+    dest("out/vscode-tests/no-workspace/data"),
+  );
 }
 
 function copyCliIntegrationData() {
-  return gulp
-    .src("src/vscode-tests/cli-integration/data/**/*")
-    .pipe(gulp.dest("out/vscode-tests/cli-integration/data"));
+  return src("src/vscode-tests/cli-integration/data/**/*").pipe(
+    dest("out/vscode-tests/cli-integration/data"),
+  );
 }

extensions/ql-vscode/gulpfile.ts/textmate.ts

@@ -1,6 +1,6 @@
-import * as gulp from "gulp";
-import * as jsYaml from "js-yaml";
-import * as through from "through2";
+import { src, dest } from "gulp";
+import { load } from "js-yaml";
+import { obj } from "through2";
 import * as PluginError from "plugin-error";
 import * as Vinyl from "vinyl";
 
@@ -61,11 +61,11 @@ function getNodeMatchText(rule: any): string {
     for (const patternIndex in rule.patterns) {
       const pattern = rule.patterns[patternIndex];
       if (pattern.include !== null) {
-        patterns.push("(?" + pattern.include + ")");
+        patterns.push(`(?${pattern.include})`);
       }
     }
 
-    return "(?:" + patterns.join("|") + ")";
+    return `(?:${patterns.join("|")})`;
   } else {
     return "";
   }
@@ -149,8 +149,8 @@ function visitAllMatchesInRule(rule: any, action: (match: any) => any) {
  * @param key Base key of the property to be transformed.
  */
 function expandPatternMatchProperties(rule: any, key: "begin" | "end") {
-  const patternKey = key + "Pattern";
-  const capturesKey = key + "Captures";
+  const patternKey = `${key}Pattern`;
+  const capturesKey = `${key}Captures`;
   const pattern = rule[patternKey];
   if (pattern !== undefined) {
     const patterns: string[] = Array.isArray(pattern) ? pattern : [pattern];
@@ -207,7 +207,7 @@ function transformFile(yaml: any) {
   });
 
   if (yaml.regexOptions !== undefined) {
-    const regexOptions = "(?" + yaml.regexOptions + ")";
+    const regexOptions = `(?${yaml.regexOptions})`;
     visitAllRulesInFile(yaml, (rule) => {
       visitAllMatchesInRule(rule, (match) => {
         return regexOptions + match;
@@ -219,7 +219,7 @@ function transformFile(yaml: any) {
 }
 
 export function transpileTextMateGrammar() {
-  return through.obj(
+  return obj(
     (
       file: Vinyl,
       _encoding: string,
@@ -230,7 +230,7 @@ export function transpileTextMateGrammar() {
       } else if (file.isBuffer()) {
         const buf: Buffer = file.contents;
         const yamlText: string = buf.toString("utf8");
-        const jsonData: any = jsYaml.load(yamlText);
+        const jsonData: any = load(yamlText);
         transformFile(jsonData);
 
         file.contents = Buffer.from(JSON.stringify(jsonData, null, 2), "utf8");
@@ -247,8 +247,7 @@ export function transpileTextMateGrammar() {
 }
 
 export function compileTextMateGrammar() {
-  return gulp
-    .src("syntaxes/*.tmLanguage.yml")
+  return src("syntaxes/*.tmLanguage.yml")
     .pipe(transpileTextMateGrammar())
-    .pipe(gulp.dest("out/syntaxes"));
+    .pipe(dest("out/syntaxes"));
 }