clean-up tslint.json used in the project

Author: egamma

tslint-server/src/server.ts

@@ -10,6 +10,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as semver from 'semver';
 import Uri from 'vscode-uri';
+import * as util from 'util';
 
 import * as tslint from 'tslint'; // this is a dev dependency only
 
@@ -25,15 +26,16 @@ interface Settings {
 	ignoreDefinitionFiles: boolean;
 	exclude: string | string[];
 	validateWithDefaultConfig: boolean;
-	nodePath: string | undefined,
+	nodePath: string | undefined;
 	run: 'onSave' | 'onType';
-	alwaysShowRuleFailuresAsWarnings: boolean,
-	autoFixOnSave: boolean | string[]
+	alwaysShowRuleFailuresAsWarnings: boolean;
+	autoFixOnSave: boolean | string[];
+	trace: any;
 }
 
 interface Configuration {
-	linterConfiguration: any;
-	isDefaultLinterConfig: boolean
+	linterConfiguration: tslint.Configuration.IConfigurationFile | undefined;
+	isDefaultLinterConfig: boolean;
 }
 
 class ConfigCache {
@@ -47,7 +49,7 @@ class ConfigCache {
 
 	set(path: string, configuration:Configuration) {
 		this.filePath = path;
-		this.configuration = configuration
+		this.configuration = configuration;
 	}
 
 	get(forPath:string): Configuration | undefined {
@@ -61,7 +63,7 @@ class ConfigCache {
 		if (this.configuration) {
 			return this.configuration.isDefaultLinterConfig;
 		}
-		return false
+		return false;
 	}
 
 	flush() {
@@ -76,7 +78,7 @@ class SettingsCache {
 
 	constructor() {
 		this.uri = undefined;
-		this.settings = undefined
+		this.settings = undefined;
 	}
 
 	async get(uri:string): Promise<Settings | undefined> {
@@ -87,6 +89,7 @@ class SettingsCache {
 			let configRequestParam = { items: [{ scopeUri: uri, section: 'tslint' }] };
 			let settings = await connection.sendRequest(ConfigurationRequest.type, configRequestParam);
 			this.settings = settings[0];
+			this.uri = uri;
 			return this.settings;
 		}
 		return globalSettings;
@@ -253,7 +256,7 @@ async function getConfiguration(uri: string, filePath: string, library: any, con
 	}
 
 	let isDefaultConfig = false;
-	let linterConfiguration: any;
+	let linterConfiguration: tslint.Configuration.IConfigurationFile | undefined;
 
 	let linter = getLinterFromLibrary(library);
 	if (isTsLintVersion4(library)) {
@@ -273,13 +276,13 @@ async function getConfiguration(uri: string, filePath: string, library: any, con
 		if (linter.findConfigurationPath) {
 			isDefaultConfig = linter.findConfigurationPath(configFileName, filePath) === undefined;
 		}
-		linterConfiguration = linter.findConfiguration(configFileName, filePath);
+		linterConfiguration = <tslint.Configuration.IConfigurationFile>linter.findConfiguration(configFileName, filePath);
 	}
 
 	let configuration: Configuration = {
 		isDefaultLinterConfig: isDefaultConfig,
-		linterConfiguration: linterConfiguration
-	}
+		linterConfiguration: linterConfiguration,
+	};
 
 	configCache.set(filePath, configuration);
 	return configCache.configuration;
@@ -326,7 +329,7 @@ function getLinterFromLibrary(library): typeof tslint.Linter {
 	if (!isTsLint4) {
 		linter = library;
 	} else {
-		linter = library.Linter
+		linter = library.Linter;
 	}
 	return linter;
 }
@@ -489,6 +492,10 @@ async function doValidate(conn: server.IConnection, library: any, document: serv
 		formattersDirectory: undefined
 	};
 
+	if (settings.trace && settings.trace.server === 'verbose') { 
+		traceConfigurationFile(configuration.linterConfiguration);
+	}
+
 	try { // protect against tslint crashes
 		let linter = getLinterFromLibrary(library);
 		if (isTsLintVersion4(library)) {
@@ -923,4 +930,12 @@ function concatenateEdits(fixes: AutoFix[]): server.TextEdit[] {
 	return textEdits;
 }
 
+function traceConfigurationFile(configuration: tslint.Configuration.IConfigurationFile | undefined) {
+	if (!configuration) {
+		trace("no tslint configuration");
+		return;
+	}
+	trace("tslint configuration:", util.inspect(configuration, undefined, 4));
+}
+
 connection.listen();

tslint-tests/.vscode/settings.json

@@ -6,8 +6,8 @@
     // ],
     "tslint.autoFixOnSave": false,
     // "tslint.nodePath": "c:\\tmp",
-    "tslint.jsEnable": true
+    "tslint.jsEnable": true,
     //"tslint.enable": true
-    // "tslint.trace.server": "verbose"
+    "tslint.trace.server": "verbose"
     // "tslint.alwaysShowRuleFailuresAsWarnings": false
 }

tslint.json

@@ -2,11 +2,11 @@
 	"rules": {
 		"no-unused-expression": true,
 		"no-duplicate-variable": true,
-		"no-duplicate-key": true,
 		"no-unused-variable": true,
 		"curly": true,
 		"class-name": true,
-		"semicolon": ["always"],
+		"semicolon": true,
 		"triple-equals": true
-	}
+	},
+	"defaultSeverity": "warning"
 }

tslint/README.md

@@ -4,10 +4,22 @@ Integrates the [tslint](https://github.com/palantir/tslint) linter for the TypeS
 Please refer to the tslint [documentation](https://github.com/palantir/tslint) for how to configure the linting rules.
 
 # Prerequisites
-The extension requires that tslint is installed either locally or globally.
+The extension requires that the `tslint` and `typescript` modules are installed either locally or globally. The extension will use the tslint module that is installed closest to the linted file. To install tslint and typescript globally you can run `npm install -g tslint typescript`.
 
->Tip: if you get an error saying, "failed to load tslint", but you have tslint installed locally,
- try to install tslint and its typescript dependency globally using `npm install -g tslint typescript`.
+# FAQ
+
+- The `no-unused-variable` rule doesn't report warnings any more?
+
+Since tslint version 5 the rule [no-unused-variable](https://palantir.github.io/tslint/rules/no-unused-variable/) rule requires type information. Rules with type information are currently not supported by vscode-tslint, pls see [issue #70](https://github.com/Microsoft/vscode-tslint/issues/70#issuecomment-241041929). The recommended work around is to enable the TypeScript compiler option `noUnusedLocals` and `noUnusedParameters`in your `tsconfig.json` file.
+
+- How can I use tslint rules that require type information
+
+The recommended way is to run tslint manually on your project from a [task](https://code.visualstudio.com/docs/editor/tasks). To see the lint warnings in the Problems panel you can associate the task with a [Problem matcher](https://code.visualstudio.com/docs/editor/tasks#_processing-task-output-with-problem-matchers) as described in the section [below](#Using-the-extension-with-tasks-running-tslint).
+
+- Linting does not seem to work what can I do?
+
+Click on the `TSlint` status bar item at the bottom left of the status bar to see the output from the vscode-tslint extension.
+You can enable more tracing output by adding the setting "tslint.trace.server" with a value of "verbose" or "messages".
 
 # Configuration options
 

tslint/extension.ts

@@ -17,7 +17,7 @@ interface AllFixesParams {
 interface AllFixesResult {
 	readonly documentVersion: number;
 	readonly edits: TextEdit[];
-	readonly ruleId?: string
+	readonly ruleId?: string;
 }
 
 namespace AllFixesRequest {
@@ -280,7 +280,7 @@ export function activate(context: ExtensionContext) {
 			return;
 		}
 		let folderPicks = folders.map(each => {
-			return {label: each.name, description: each.uri.fsPath}
+			return {label: each.name, description: each.uri.fsPath};
 		});
 		let selection;
 		if (folderPicks.length === 1) {

tslint/package.json

@@ -126,7 +126,18 @@
           "default": false,
           "description": "Always show rule failures as warnings, independent of the tslint configuration.",
           "scope": "resource"
-        }
+        },
+				"tslint.trace.server": {
+					"scope": "window",
+					"type": "string",
+					"enum": [
+						"off",
+						"messages",
+						"verbose"
+					],
+					"default": "off",
+					"description": "Traces the communication between VSCode and the tslint linter service."
+				}
       }
     },
     "colors": [