Merge pull request microsoft#102 from mousetraps/api

microsoft#101 Add parser path setting to syntax visualizer

Author: mousetraps

syntax-visualizer/README.md

@@ -12,4 +12,10 @@ VSCode Extension that demonstrates some of the basic usage and functionality of
 1. npm install `client`/`server` dependencies, run Extension
 2. open PHP file from `example` folder, and `*.ast` file to the side
 3. check out error information, and corresponding AST
-4. make some changes, and save to view updates
+4. make some changes, and save to view updates
+
+## Settings
+* `php.syntaxVisualizer.parserPath`: set this path to use a different parser version than the one bundled with the
+syntax visualizer. For instance, after `git clone https://github.com/Microsoft/tolerant-php-parser`, set
+`php.syntaxVisualizer.parserPath` to the absolute directory of the `tolerant-php-parser/src` folder. This will enable you to easily
+debug the parser during development. 

syntax-visualizer/client/package.json

@@ -20,10 +20,10 @@
       "type": "object",
       "title": "Example configuration",
       "properties": {
-        "languageServerExample.maxNumberOfProblems": {
-          "type": "number",
-          "default": 100,
-          "description": "Controls the maximum number of problems produced by the server."
+        "php.syntaxVisualizer.parserPath": {
+          "type": ["string", "null"],
+          "default": null,
+          "description": "Absolute path to the parser source folder (should contain bootstrap.php)."
         }
       }
     }

syntax-visualizer/client/package.php

@@ -16,6 +16,14 @@
     rmdirRecursive($outDir);
 }
 
+// Package the latest parser source file archive from msft/master
+// This prevents old or in-progress work from being accidentally packaged with the extension.
+// TODO - eventually add more configuration options
+$updateMasterOutput = `git diff master msft/master 2>&1`;
+if (\count($updateMasterOutput) > 0) {
+    throw new Exception("master branch is not up to date with msft/master");
+}
+
 $root = exec("git rev-parse --show-toplevel");
 exec("cd $root && git archive --format zip --output \"$outZip\" master");
 

syntax-visualizer/client/php-syntax-visualizer-0.0.1.vsix

@@ -28,8 +28,8 @@ export function activate(context: ExtensionContext) {
 		// Register the server for PHP documents
 		documentSelector: ['php'],
 		synchronize: {
-			// Synchronize the setting section 'languageServerExample' to the server
-			configurationSection: 'languageServerExample',
+			// Synchronize the setting section 'php' to the server
+			configurationSection: 'php',
 			// Notify the server about file changes to '.clientrc files contain in the workspace
 			fileEvents: workspace.createFileSystemWatcher('**/.clientrc')
 		}

syntax-visualizer/client/src/extension.ts

@@ -8,14 +8,7 @@
 use Microsoft\PhpParser\DiagnosticsProvider;
 use Microsoft\PhpParser\PositionUtilities;
 
-$configFile = __DIR__ . "/config.php";
-if (file_exists($configFile)) {
-    require_once($configFile);
-}
-
-if (!isset($GLOBALS["PARSER_PATH"])) {
-    $GLOBALS["PARSER_PATH"] = __DIR__ . "/../../../src/";
-}
+$GLOBALS["PARSER_PATH"] = isset($argv[2]) ? $argv[2] . "/" : __DIR__ . "/../../../src/";
 
 require_once($GLOBALS["PARSER_PATH"] . "bootstrap.php");
 

syntax-visualizer/server/src/parse.php

@@ -12,6 +12,12 @@ import {
 	CompletionItem, CompletionItemKind
 } from 'vscode-languageserver';
 
+var os = require('os');
+var execSync = require('child_process').execSync;
+var querystring = require('querystring');
+var path = require('path');
+var fs = require('fs');
+
 // Create a connection for the server. The connection uses Node's IPC as a transport
 let connection: IConnection = createConnection(new IPCMessageReader(process), new IPCMessageWriter(process));
 
@@ -44,50 +50,51 @@ documents.onDidSave((change) => {
 });
 
 // The settings interface describe the server relevant settings part
-interface Settings {
-	languageServerExample: ExampleSettings;
+interface PhpSettings {
+	syntaxVisualizer: SyntaxVisualizerSettings;
 }
 
-// These are the example settings we defined in the client's package.json
-// file
-interface ExampleSettings {
-	maxNumberOfProblems: number;
+interface SyntaxVisualizerSettings {
+	parserPath: string;
 }
 
-// hold the maxNumberOfProblems setting
-let maxNumberOfProblems: number;
+// hold the parserSrc setting
+let parserPath: string | null;
 // The settings have changed. Is send on server activation
 // as well.
 connection.onDidChangeConfiguration((change) => {
-	let settings = <Settings>change.settings;
-	maxNumberOfProblems = settings.languageServerExample.maxNumberOfProblems || 100;
+	let syntaxVisualizerSettings = <SyntaxVisualizerSettings>change.settings.php.syntaxVisualizer;
+	let fallbackParserPath = fs.existsSync(`${__dirname}/parser`)
+		? `${__dirname}/parser/src`
+		: `${__dirname}/../../../src`;
+		
+	parserPath = syntaxVisualizerSettings && syntaxVisualizerSettings.parserPath
+		? syntaxVisualizerSettings.parserPath
+		: fallbackParserPath;
+	console.log(`parser path: ${parserPath}`);
+
 	// Revalidate any open text documents
 	documents.all().forEach(validateTextDocument);
 });
 
 function validateTextDocument(textDocument: TextDocument): void {
-	var os = require('os');
-	var execSync = require('child_process').execSync;
-	var querystring = require('querystring');
-	var path = require('path');
 	var fileToRead = path.normalize(querystring.unescape(textDocument.uri)).substr(os.platform() === 'win32' ? 6 : 5);
 	if (fileToRead.startsWith("x")) {
 		return;
 	}
-	var fs = require('fs');
 	var cmd = fs.existsSync(`${__dirname}/parser`)
-		? `php ${__dirname}/parse.php ${fileToRead}`
+		? `php ${__dirname}/parse.php`
 		: `php ${__dirname}/../../server/src/parse.php`;
 
-	cmd += ` ${fileToRead}`;
+	cmd += ` ${fileToRead} ${parserPath}`;
 	var out = execSync(cmd).toString();
 	var outErrors = JSON.parse(out);
 	let diagnostics: Diagnostic[] = [];
 	let lines = textDocument.getText().split(/\n/g);
 
 	let allErrors = outErrors;
 
-	for (var i = 0; i < allErrors.length && i < maxNumberOfProblems; i++) {		
+	for (var i = 0; i < allErrors.length; i++) {		
 		let error = allErrors[i];
 		diagnostics.push({
 			severity: DiagnosticSeverity.Error,