Merge remote-tracking branch 'origin/main' into koesie10/fix-duplicate-downloads

Author: koesie10

CODEOWNERS

@@ -1,3 +1,4 @@
 **/* @github/codeql-vscode-reviewers
 **/remote-queries/ @github/code-scanning-secexp-reviewers
 **/variant-analysis/ @github/code-scanning-secexp-reviewers
+**/databases/ @github/code-scanning-secexp-reviewers

CONTRIBUTING.md

@@ -102,11 +102,17 @@ We have several types of tests:
 
 The CLI integration tests require an instance of the CodeQL CLI to run so they will require some extra setup steps. When adding new tests to our test suite, please be mindful of whether they need to be in the cli-integration folder. If the tests don't depend on the CLI, they are better suited to being a VSCode integration test.
 
+Any test data you're using (sample projects, config files, etc.) must go in a `src/vscode-tests/*/data` directory. When you run the tests, the test runner will copy the data directory to `out/vscode-tests/*/data`.
+
 #### Running the tests
 
+Pre-requisites:
+1. Run `npm run build`.
+2. You will need to have `npm run watch` running in the background.
+
 ##### 1. From the terminal
 
-First move into the `extensions/ql-vscode` directory. Then, depending on which tests you want to run, use the appropriate command to run the tests:
+Then, from the `extensions/ql-vscode` directory, use the appropriate command to run the tests:
 
 * Unit tests: `npm run test:unit`
 * View Tests: `npm test:view`

extensions/ql-vscode/.eslintignore

@@ -0,0 +1,6 @@
+.vscode-test/
+node_modules/
+out/
+
+# Include the Storybook config
+!.storybook

extensions/ql-vscode/.eslintrc.js

@@ -3,7 +3,7 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2018,
     sourceType: "module",
-    project: ["tsconfig.json", "./src/**/tsconfig.json", "./gulpfile.ts/tsconfig.json"],
+    project: ["tsconfig.json", "./src/**/tsconfig.json", "./gulpfile.ts/tsconfig.json", "./scripts/tsconfig.json", "./.storybook/tsconfig.json"],
   },
   plugins: ["@typescript-eslint"],
   env: {

extensions/ql-vscode/.mocharc.json

@@ -1,6 +1,4 @@
 {
   "exit": true,
-  "require": [
-    "test/mocha.setup.js"
-  ]
+  "require": ["test/mocha.setup.js"]
 }

extensions/ql-vscode/.storybook/preview.ts

@@ -7,7 +7,7 @@ import '@vscode/codicons/dist/codicon.css';
 // https://storybook.js.org/docs/react/configure/overview#configure-story-rendering
 export const parameters = {
   // All props starting with `on` will automatically receive an action as a prop
-  actions: { argTypesRegex: "^on[A-Z].*" },
+  actions: { argTypesRegex: '^on[A-Z].*' },
   // All props matching these names will automatically get the correct control
   controls: {
     matchers: {

extensions/ql-vscode/.storybook/vscode-theme-addon/preset.ts

@@ -1,7 +1,7 @@
 export function config(entry = []) {
-  return [...entry, require.resolve("./preview.ts")];
+  return [...entry, require.resolve('./preview.ts')];
 }
 
 export function managerEntries(entry = []) {
-  return [...entry, require.resolve("./manager.tsx")];
+  return [...entry, require.resolve('./manager.tsx')];
 }

extensions/ql-vscode/.storybook/vscode-theme-addon/theme.ts

@@ -6,4 +6,4 @@ export enum VSCodeTheme {
 export const themeNames: { [key in VSCodeTheme]: string } = {
   [VSCodeTheme.Dark]: 'Dark+',
   [VSCodeTheme.Light]: 'Light+',
-}
+};

extensions/ql-vscode/.storybook/vscode-theme-addon/withTheme.ts

@@ -4,9 +4,11 @@ import type { AnyFramework, PartialStoryFn as StoryFunction, StoryContext } from
 import { VSCodeTheme } from './theme';
 
 const themeFiles: { [key in VSCodeTheme]: string } = {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
   [VSCodeTheme.Dark]: require('!file-loader?modules!../../src/stories/vscode-theme-dark.css').default,
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
   [VSCodeTheme.Light]: require('!file-loader?modules!../../src/stories/vscode-theme-light.css').default,
-}
+};
 
 export const withTheme = (
   StoryFn: StoryFunction<AnyFramework>,
@@ -18,7 +20,7 @@ export const withTheme = (
     const styleSelectorId =
       context.viewMode === 'docs'
         ? `addon-vscode-theme-docs-${context.id}`
-        : `addon-vscode-theme-theme`;
+        : 'addon-vscode-theme-theme';
 
     const theme = Object.values(VSCodeTheme).includes(vscodeTheme) ? vscodeTheme as VSCodeTheme : VSCodeTheme.Dark;
 

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

@@ -1,7 +1,7 @@
 import * as gulp from 'gulp';
 import { compileTypeScript, watchTypeScript, cleanOutput } from './typescript';
 import { compileTextMateGrammar } from './textmate';
-import { copyTestData } from './tests';
+import { copyTestData, watchTestData } from './tests';
 import { compileView, watchView } from './webpack';
 import { packageExtension } from './package';
 import { injectAppInsightsKey } from './appInsights';
@@ -21,6 +21,7 @@ export {
   watchView,
   compileTypeScript,
   copyTestData,
+  watchTestData,
   injectAppInsightsKey,
   compileView,
 };