Guard find-references with experimental setting

Author: jcreedcmu

extensions/ql-vscode/src/config.ts

@@ -39,6 +39,17 @@ class Setting {
 
 const ROOT_SETTING = new Setting('codeQL');
 
+// Enable experimental features
+
+/**
+ * This setting is deliberately not in package.json so that it does
+ * not appear in the settings ui in vscode itself. If users want to
+ * enable experimental features, they can add
+ * "codeQl.experimentalFeatures" directly in their vscode settings
+ * json file.
+ */
+export const EXPERIMENTAL_FEATURES_SETTING = new Setting('experimentalFeatures', ROOT_SETTING);
+
 // Distribution configuration
 
 const DISTRIBUTION_SETTING = new Setting('cli', ROOT_SETTING);

extensions/ql-vscode/src/extension.ts

@@ -3,7 +3,7 @@ import { LanguageClient } from 'vscode-languageclient';
 import { testExplorerExtensionId, TestHub } from 'vscode-test-adapter-api';
 import * as archiveFilesystemProvider from './archive-filesystem-provider';
 import { CodeQLCliServer } from './cli';
-import { DistributionConfigListener, QueryHistoryConfigListener, QueryServerConfigListener } from './config';
+import { DistributionConfigListener, QueryHistoryConfigListener, QueryServerConfigListener, EXPERIMENTAL_FEATURES_SETTING } from './config';
 import { DatabaseManager } from './databases';
 import { DatabaseUI } from './databases-ui';
 import { TemplateQueryDefinitionProvider, TemplateQueryReferenceProvider } from './definitions';
@@ -336,14 +336,16 @@ async function activateWithInstalledDistribution(ctx: ExtensionContext, distribu
 
   ctx.subscriptions.push(client.start());
 
-  languages.registerDefinitionProvider(
-    { scheme: archiveFilesystemProvider.zipArchiveScheme },
-    new TemplateQueryDefinitionProvider(cliServer, qs, dbm)
-  );
-  languages.registerReferenceProvider(
-    { scheme: archiveFilesystemProvider.zipArchiveScheme },
-    new TemplateQueryReferenceProvider(cliServer, qs, dbm)
-  );
+  if (EXPERIMENTAL_FEATURES_SETTING.getValue()) {
+    languages.registerDefinitionProvider(
+      { scheme: archiveFilesystemProvider.zipArchiveScheme },
+      new TemplateQueryDefinitionProvider(cliServer, qs, dbm)
+    );
+    languages.registerReferenceProvider(
+      { scheme: archiveFilesystemProvider.zipArchiveScheme },
+      new TemplateQueryReferenceProvider(cliServer, qs, dbm)
+    );
+  }
 }
 
 function initializeLogging(ctx: ExtensionContext): void {