feat: enable rule saving (#145)

Author: Hellebore

media/main.js

@@ -30,6 +30,9 @@
       if (message.command === 'toggle') {
           basic.classList.toggle("hidden");
           advanced.classList.toggle("hidden");
+      } else if (message.command === "setPattern") {
+          const input = document.querySelector('textarea.patternInput');
+          input.value = message.pattern;
       }
     });
 

package.json

@@ -189,6 +189,11 @@
 				"title": "Toggle Advanced Mode",
 				"category": "Sourcery"
 			},
+			{
+				"command": "sourcery.scan.selectLanguage",
+				"title": "Select Language",
+				"category": "Sourcery"
+			},
 			{
 				"command": "sourcery.rule.create",
 				"title": "Create custom rule",
@@ -207,6 +212,11 @@
 		],
 		"menus": {
 			"view/title": [
+				{
+					"command": "sourcery.scan.selectLanguage",
+					"when": "view == sourcery.rules",
+					"group": "navigation"
+				},
 				{
 					"command": "sourcery.scan.toggleAdvanced",
 					"when": "view == sourcery.rules",
@@ -223,7 +233,7 @@
 			"editor/context": [
 				{
 					"submenu": "sourcery.editor",
-					"group": "z_commands@2"
+					"group": "1_modification@2"
 				}
 			],
 			"explorer/context": [
@@ -234,7 +244,7 @@
 			],
 			"sourcery.editor": [
 				{
-					"command": "sourcery.rule.create",
+					"command": "sourcery.scan.open",
 					"title": "Create Sourcery rule with this pattern",
 					"when": "editorLangId==python && editorHasSelection"
 				}
@@ -271,6 +281,14 @@
 				{
 					"command": "sourcery.scan.toggleAdvanced",
 					"when": "false"
+				},
+				{
+					"command": "sourcery.scan.selectLanguage",
+					"when": "false"
+				},
+				{
+					"command": "sourcery.rule.create",
+					"when": "false"
 				}
 			]
 		},

src/extension.ts

@@ -77,7 +77,7 @@ function createLangServer(): LanguageClient {
     return new LanguageClient(command, serverOptions, clientOptions);
 }
 
-function getValidInput(): string | null {
+export function getValidInput(): string | null {
     const editor = window.activeTextEditor;
 
     if (editor) {
@@ -157,6 +157,19 @@ function registerCommands(context: ExtensionContext, riProvider: RuleInputProvid
         riProvider.toggle();
     }));
 
+    context.subscriptions.push(commands.registerCommand('sourcery.scan.selectLanguage', () => {
+        const items = ['python', 'javascript'];
+
+        window.showQuickPick(items, {
+          canPickMany: false,
+          placeHolder: 'Select language'
+        }).then((selected) => {
+                riProvider.setLanguage(selected);
+            }
+        );
+
+    }));
+
     context.subscriptions.push(commands.registerCommand('sourcery.scan.applyRule', (entry) => {
         workspace.openTextDocument(entry.resourceUri).then(doc => {
             window.showTextDocument(doc).then(e => {
@@ -184,7 +197,12 @@ function registerCommands(context: ExtensionContext, riProvider: RuleInputProvid
         vscode.commands.executeCommand('setContext',
             'sourceryRulesActive',
             true);
-        vscode.commands.executeCommand("sourcery.rules.focus")
+
+        vscode.commands.executeCommand("sourcery.rules.focus").then( () => {
+            const input = getValidInput();
+            riProvider.setPattern(input);
+            }
+        );
     }));
 
     context.subscriptions.push(commands.registerCommand('sourcery.walkthrough.open', () => {
@@ -202,22 +220,33 @@ function registerCommands(context: ExtensionContext, riProvider: RuleInputProvid
         });
     }));
 
-    context.subscriptions.push(commands.registerCommand('sourcery.rule.create', () => {
-        const input = getValidInput();
-
-        let request: ExecuteCommandParams = {
-            command: 'config/rule/create',
-            arguments: [{'selected': input}]
-        };
-        languageClient.sendRequest(ExecuteCommandRequest.type, request).then((values) => {
-            const openPath = Uri.file(path.join(workspace.rootPath, '.sourcery.yaml'));
-            workspace.openTextDocument(openPath).then(doc => {
-                const opts: TextDocumentShowOptions = {
-                    selection: new Range(doc.lineCount - 1, 0, doc.lineCount - 1, 0)
-                };
-                window.showTextDocument(doc, opts);
+    context.subscriptions.push(commands.registerCommand('sourcery.rule.create', (rule, advanced: boolean, language: string) => {
+
+        vscode.window.showInputBox({
+            title: "What would you like to call your rule?" ,
+          prompt: "This should be lowercase, with words separated by hyphens (e.g. my-brilliant-rule)"
+        }).then((name) => {
+          if (name) {
+            let request: ExecuteCommandParams = {
+                command: 'config/rule/create',
+                arguments: [{
+                    "rule_id": name,
+                    'rule': rule,
+                    "inplace": false,
+                    'advanced': advanced,
+                    "language": language
+                }
+                ]
+            };
+            languageClient.sendRequest(ExecuteCommandRequest.type, request).then((result) => {
+                const openPath = Uri.file(result);
+                workspace.openTextDocument(openPath).then(doc => {
+                    window.showTextDocument(doc);
+                });
             });
+          }
         });
+
     }));
 
     context.subscriptions.push(commands.registerCommand('sourcery.refactor.workspace', (resource: Uri, selected?: Uri[]) => {
@@ -231,30 +260,31 @@ function registerCommands(context: ExtensionContext, riProvider: RuleInputProvid
         languageClient.sendRequest(ExecuteCommandRequest.type, request);
     }));
 
-    context.subscriptions.push(commands.registerCommand('sourcery.scan.rule', (rule, advanced: boolean, inplace: boolean, language: string) => {
-        if (inplace) {
+    context.subscriptions.push(commands.registerCommand('sourcery.scan.rule', (rule, advanced: boolean, fix: boolean, language: string) => {
+        if (fix) {
             vscode.window
                 .showInformationMessage("Are you sure?", "Yes", "No")
                 .then(answer => {
                     if (answer === "Yes") {
-                        runScan(rule, advanced, inplace, language);
+                        runScan(rule, advanced, fix, language);
                     }
                 })
         } else {
-            runScan(rule, advanced, inplace, language);
+            runScan(rule, advanced, fix, language);
         }
 
     }));
 
-    function runScan(rule, advanced: boolean, inplace: boolean, language: string) {
+    function runScan(rule, advanced: boolean, fix: boolean, language: string) {
         tree.clear();
         treeView.title = "Results";
         let request: ExecuteCommandParams = {
             command: 'rule/scan',
             arguments: [{
                 'rule': rule,
+                'rule_id': 'test-rule',
                 'advanced': advanced,
-                'inplace': inplace,
+                'inplace': fix,
                 "language": language
             }]
         };

src/rule-search.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
-import {window} from 'vscode';
 import {randomBytes} from "crypto";
+import {getValidInput} from "./extension";
 
 export class RuleInputProvider implements vscode.WebviewViewProvider {
 
@@ -18,10 +18,19 @@ export class RuleInputProvider implements vscode.WebviewViewProvider {
 		this._extensionUri = _context.extensionUri;
 	}
 
-	public async toggle() {
+	public toggle() {
 		this._view.webview.postMessage({ command: 'toggle' });
 	}
 
+	public setLanguage(language) {
+		this._languageId = language;
+		this._setTitle();
+	}
+
+	public setPattern(pattern) {
+		this._view.webview.postMessage( {command: "setPattern", pattern: pattern})
+	}
+
 	public async resolveWebviewView(
 		webviewView: vscode.WebviewView,
 		context: vscode.WebviewViewResolveContext,
@@ -38,11 +47,19 @@ export class RuleInputProvider implements vscode.WebviewViewProvider {
 			]
 		};
 
-		this._languageId = this._resolveLanguage();
-		this._setTitle();
+		this._setViewState();
+
+		webviewView.onDidChangeVisibility(() => {
+		  	if (this._view.visible) {
+				  this._setViewState();
+		  	}
+		});
 
 		webviewView.webview.html = await this._getHtmlForWebview(webviewView.webview);
 
+		const input = getValidInput();
+		this.setPattern(input);
+
 		webviewView.webview.onDidReceiveMessage(async data => {
 			switch (data.type) {
 				case "scan": {
@@ -54,12 +71,18 @@ export class RuleInputProvider implements vscode.WebviewViewProvider {
 					break;
 				}
 				case "save": {
-					window.showInformationMessage("Saving rules directly not yet available.")
+					vscode.commands.executeCommand("sourcery.rule.create", data.rule, data.advanced, this._languageId);
+					break;
 				}
 			}
 		});
 	}
 
+	private _setViewState() {
+		this._languageId = this._resolveLanguage();
+		this._setTitle();
+	}
+
 	private _setTitle() {
 		this._view.title = "Rules - " + this._languageId;
 	}
@@ -88,7 +111,7 @@ export class RuleInputProvider implements vscode.WebviewViewProvider {
 					return languageId;
 				}
 			}
-			return languageId;
+			return "python";
 		}
 
 		// Default to python
@@ -138,27 +161,24 @@ export class RuleInputProvider implements vscode.WebviewViewProvider {
 						<label for="patternInput">Pattern</label>
 						<textarea
 							class="patternInput""
-							placeholder="Enter your pattern here..."
 							nonce="${nonce}"
 						></textarea>
 						<label for="replacementInput">Replacement</label>
 						<textarea
 							class="replacementInput""
-							placeholder="Enter your replacement here..."
 							nonce="${nonce}"
 						></textarea>
 						<label for="conditionInput">Condition</label>
 						<textarea
 							class="conditionInput""
-							placeholder="Enter your condition here..."
 							nonce="${nonce}"
 						></textarea>
 					</div>
 					<div id="advancedContainer" class="hidden">
 						<label for="ruleInput">Rule</label>
 						<textarea
 							class="ruleInput""
-							placeholder="Enter your rule here in yaml format.\nHere's an example:\nall:\n- pattern: typing.List\n  replacement: list\n- not:\n    inside:\n      kind: import_from_statement"
+							placeholder="all:\n- pattern: typing.List\n  replacement: list\n- not:\n    inside:\n      kind: import_from_statement"
 							nonce="${nonce}"
 						></textarea>		
 					</div>