aboutsummaryrefslogtreecommitdiff
path: root/node_modules/tslint/lib/runner.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/tslint/lib/runner.d.ts')
-rw-r--r--node_modules/tslint/lib/runner.d.ts25
1 files changed, 21 insertions, 4 deletions
diff --git a/node_modules/tslint/lib/runner.d.ts b/node_modules/tslint/lib/runner.d.ts
index 80b0430de..0d19ecd75 100644
--- a/node_modules/tslint/lib/runner.d.ts
+++ b/node_modules/tslint/lib/runner.d.ts
@@ -1,3 +1,19 @@
+/**
+ * @license
+ * Copyright 2013 Palantir Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
export interface Options {
/**
* Path to a configuration file.
@@ -10,7 +26,7 @@ export interface Options {
/**
* File paths to lint.
*/
- files?: string[];
+ files: string[];
/**
* Whether to return status code 0 even if there are lint errors.
*/
@@ -48,9 +64,10 @@ export interface Options {
*/
rulesDirectory?: string | string[];
/**
- * That TSLint produces the correct output for the specified directory.
+ * Run the tests in the given directories to ensure a (custom) TSLint rule's output matches the expected output.
+ * When this property is `true` the `files` property is used to specify the directories from which the tests should be executed.
*/
- test?: string;
+ test?: boolean;
/**
* Whether to enable type checking when linting a project.
*/
@@ -59,7 +76,7 @@ export interface Options {
export declare const enum Status {
Ok = 0,
FatalError = 1,
- LintError = 2,
+ LintError = 2
}
export interface Logger {
log(message: string): void;