Adding support for explicit rubocop configfile

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.6.3 (2017-06-06)
+ - Allow `rubocop.configFile` workspace parameter (@stuartpreston)
+
 ## 0.6.2 (2016-11-04)
  - Use Cookstyle in place of Rubocop by default (@smith)
 

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2015 Pendrica
+Copyright 2015-2017 Pendrica
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -16,6 +16,7 @@ The Chef Extension for Visual Studio Code offers rich language support for Chef
  * Entire repo will be linted when files are saved.
  * If you have the [ChefDK](http://downloads.chef.io/chef-dk) installed, linting should "just work" on Windows, Mac OS X and Linux (Ubuntu.) [Cookstyle](https://github.com/chef/cookstyle) will be used by default.
  * If you do not have the ChefDK but do have Rubocop installed, you can set the executable path by setting ```{ "rubocop.path": "c:\\path\\to\\rubocop.bat"}``` in user/workspace settings).
+ * To override the config file used by Rubocop/Cookstyle, use the ```{ "rubocop.configFile": "path/to/config.yml" }``` in user/workspace settings.
 
 #### Foodcritic analysis (experimental):
  * Disabled by default (enable by adding ```{ "foodcritic.enable": true }``` in user/workspace settings)
@@ -110,9 +111,9 @@ Contributions are welcomed, please file issues and pull requests via the [projec
 
 ## Author
 
-This extension was written by Stuart Preston [stuart@pendrica.com](stuart@pendrica.com)
+This extension was written by Stuart Preston [stuart@chef.io](stuart@chef.io)
 
 ## License
 This extension is licensed under an [Apache 2](LICENSE.md) license.
 
-(c) 2015-2016 Pendrica
+(c) 2015-2017 Pendrica

extension.ts

@@ -8,6 +8,7 @@ let diagnosticCollectionRubocop: vscode.DiagnosticCollection;
 let diagnosticCollectionFoodcritic: vscode.DiagnosticCollection;
 let config: vscode.WorkspaceConfiguration;
 let rubocopPath: string;
+let rubocopConfigFile: string;
 let foodcriticPath: string;
 let cookbookPaths: Array<string> = [];
 
@@ -25,8 +26,16 @@ export function activate(context: vscode.ExtensionContext): void {
 		}
 	} else {
 		rubocopPath = vscode.workspace.getConfiguration("rubocop").path;
-		console.log("Using custom Rubocop path:" + rubocopPath);
+		console.log("Using custom Rubocop path: " + rubocopPath);
 	}
+
+	if (vscode.workspace.getConfiguration("rubocop").configFile === "") {
+		console.log("No explicit config file set for Rubocop.");
+	} else {
+		rubocopConfigFile = vscode.workspace.getConfiguration("rubocop").configFile;
+		console.log("Using custom Rubocop config from: " + rubocopConfigFile);
+	}
+
 	if (vscode.workspace.getConfiguration("rubocop").enable) {
 		validateWorkspace();
 		context.subscriptions.push(startLintingOnSaveWatcher());
@@ -41,7 +50,7 @@ export function activate(context: vscode.ExtensionContext): void {
 		}
 	} else {
 		foodcriticPath = vscode.workspace.getConfiguration("foodcritic").path;
-		console.log("Using custom Foodcritic path:" + foodcriticPath);
+		console.log("Using custom Foodcritic path: " + foodcriticPath);
 	}
 
 	if (vscode.workspace.getConfiguration("foodcritic").enable) {
@@ -86,7 +95,12 @@ function convertSeverity(severity: string): vscode.DiagnosticSeverity {
 function validateWorkspace(): void {
 	try {
 		let spawn = require("child_process").spawnSync;
-		let rubocop = spawn(rubocopPath, ["-f", "j", vscode.workspace.rootPath], { cwd: vscode.workspace.rootPath });
+		let rubocop: any;
+		if (rubocopConfigFile) {
+			rubocop = spawn(rubocopPath, ["--config", rubocopConfigFile, "-f", "j", vscode.workspace.rootPath], { cwd: vscode.workspace.rootPath });
+		} else {
+			rubocop = spawn(rubocopPath, ["-f", "j", vscode.workspace.rootPath], { cwd: vscode.workspace.rootPath });
+		}
 		let rubocopOutput = JSON.parse(rubocop.stdout);
 		if (rubocop.status < 2) {
 			let arr = [];

package.json

@@ -1,7 +1,7 @@
 {
   "name": "Chef",
   "description": "Chef language support and snippets for Visual Studio Code",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "publisher": "Pendrica",
   "icon": "images/chef-logo.svg",
   "displayName": "Chef Extension for Visual Studio Code",
@@ -80,6 +80,11 @@
           "default": "",
           "description": "Full path to Rubocop, only change this if you have the ChefDK installed in a non-standard location."
         },
+        "rubocop.configFile": {
+          "type": "string",
+          "default": "",
+          "description": "Path to a Rubocop config file (e.g. .rubocop_shared.yml) - relative paths resolve inside the workspace."
+        },
         "foodcritic.enable": {
           "type": "boolean",
           "default": false,
@@ -94,8 +99,8 @@
     }
   },
   "scripts": {
-    "vscode:prepublish": "node ./node_modules/vscode/bin/compile",
-    "compile": "node ./node_modules/vscode/bin/compile -watch -p ./",
+    "vscode:prepublish": "tsc -p ./",
+    "compile": "tsc -watch -p ./",
     "postinstall": "node ./node_modules/vscode/bin/install"
   }
 }

tsconfig.json

@@ -2,17 +2,15 @@
 	"compilerOptions": {
 		"module": "commonjs",
 		"moduleResolution": "node",
-		"target": "ES5",
+		"target": "ES6",
 		"outDir": "out",
 		"sourceMap": true,
 		"typeRoots": [
-			"node_modules/@types"
+			"node_modules/@types",
+			"typings/"
 		],
-		"types": [
-			"node"
+		"lib": [
+			"es6"
 		]
-	},
-	"exclude": [
-		"node_modules"
-	]
+	}
 }