From 8d3988af5b8078c20e84edd53d63da276ea4a979 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 23 Oct 2018 13:58:47 +0000 Subject: [PATCH] Finished removing unecessary (placating missing-jsdoc) JSDocs (#562) * Marked missing-jsdoc as deprecated Continues #400. * Finished removing unecessary (placating missing-jsdoc) JSDocs Fixes #557 * Added recommended_ruleset.js removal * Really disabled missing-jsdoc * Yup, re-ran auto-updating tasks locally * Fixed informativeDocsRule post-merge --- README.md | 2 +- recommended_ruleset.js | 2 +- src/chaiPreferContainsToIndexOfRule.ts | 3 --- src/chaiVagueErrorsRule.ts | 3 --- src/exportNameRule.ts | 4 +--- src/functionNameRule.ts | 3 --- src/importNameRule.ts | 3 --- src/informativeDocsRule.ts | 6 +++--- src/insecureRandomRule.ts | 3 --- src/jqueryDeferredMustCompleteRule.ts | 3 --- src/maxFuncBodyLengthRule.ts | 3 --- src/missingJsdocRule.ts | 16 ++++++++++------ src/missingOptionalAnnotationRule.ts | 3 --- src/mochaAvoidOnlyRule.ts | 3 --- src/mochaNoSideEffectCodeRule.ts | 3 --- src/mochaUnneededDoneRule.ts | 3 --- src/noBackboneGetSetOutsideModelRule.ts | 6 ------ src/noBannedTermsRule.ts | 3 --- src/noConstantConditionRule.ts | 3 --- src/noControlRegexRule.ts | 3 --- src/noCookiesRule.ts | 3 --- src/noDeleteExpressionRule.ts | 3 --- src/noDisableAutoSanitizationRule.ts | 3 --- src/noDocumentDomainRule.ts | 3 --- src/noDocumentWriteRule.ts | 3 --- src/noDuplicateCaseRule.ts | 3 --- src/noDuplicateParameterNamesRule.ts | 3 --- src/noEmptyInterfacesRule.ts | 3 --- src/noEmptyLineAfterOpeningBraceRule.ts | 3 --- src/noExecScriptRule.ts | 3 --- src/noForInRule.ts | 3 --- src/noFunctionConstructorWithStringArgsRule.ts | 3 --- src/noFunctionExpressionRule.ts | 3 --- src/noHttpStringRule.ts | 3 --- src/noIncrementDecrementRule.ts | 3 --- src/noInnerHtmlRule.ts | 3 --- src/noInvalidRegexpRule.ts | 3 --- src/noJqueryRawElementsRule.ts | 3 --- src/noMissingVisibilityModifiersRule.ts | 3 --- src/noMultilineStringRule.ts | 3 --- src/noMultipleVarDeclRule.ts | 3 --- src/noOctalLiteralRule.ts | 3 --- src/noRegexSpacesRule.ts | 3 --- src/noRelativeImportsRule.ts | 3 --- src/noReservedKeywordsRule.ts | 3 --- src/noSingleLineBlockCommentRule.ts | 3 --- src/noStatelessClassRule.ts | 3 --- src/noStringBasedSetImmediateRule.ts | 3 --- src/noStringBasedSetIntervalRule.ts | 3 --- src/noStringBasedSetTimeoutRule.ts | 3 --- src/noSuspiciousCommentRule.ts | 3 --- src/noTypeofUndefinedRule.ts | 3 --- src/noUnexternalizedStringsRule.ts | 3 --- src/noUnnecessaryBindRule.ts | 3 --- src/noUnnecessaryFieldInitializationRule.ts | 3 --- src/noUnnecessaryLocalVariableRule.ts | 3 --- src/noUnnecessaryOverrideRule.ts | 3 --- src/noUnnecessarySemicolonsRule.ts | 3 --- src/noUnsupportedBrowserCodeRule.ts | 3 --- src/noUselessFilesRule.ts | 3 --- src/noVarSelfRule.ts | 3 --- src/noWithStatementRule.ts | 3 --- src/nonLiteralFsPathRule.ts | 3 --- src/nonLiteralRequireRule.ts | 3 --- src/possibleTimingAttackRule.ts | 3 --- src/preferArrayLiteralRule.ts | 3 --- src/preferTypeCastRule.ts | 3 --- src/promiseMustCompleteRule.ts | 3 --- src/reactA11yAnchorsRule.ts | 3 --- src/reactA11yLangRule.ts | 3 --- src/reactA11yMetaRule.ts | 3 --- src/reactA11yTitlesRule.ts | 3 --- src/reactAnchorBlankNoopenerRule.ts | 3 --- src/reactIframeMissingSandboxRule.ts | 3 --- src/reactNoDangerousHtmlRule.ts | 3 --- src/reactThisBindingIssueRule.ts | 4 ---- src/reactUnusedPropsAndStateRule.ts | 3 --- src/tests/AstUtilsTests.ts | 3 --- .../ChaiPreferContainsToIndexOfRuleTests.ts | 3 --- src/tests/ChaiVagueErrorsRuleTests.ts | 3 --- src/tests/ExportNameRuleTests.ts | 3 --- src/tests/FixNoRequireImportsFormatterTests.ts | 3 --- src/tests/FixNoVarKeywordFormatterTests.ts | 3 --- src/tests/FunctionNameRuleTests.ts | 3 --- src/tests/ImportNameRuleTests.ts | 3 --- src/tests/InsecureRandomRuleTests.ts | 3 --- src/tests/MaxFuncBodyLengthRuleTests.ts | 3 --- src/tests/MissingJsdocRuleTests.ts | 3 --- src/tests/MissingOptionalAnnotationTests.ts | 3 --- src/tests/MochaAvoidOnlyRuleTests.ts | 3 --- src/tests/MochaNoSideEffectCodeRuleTests.ts | 3 --- src/tests/MochaUnneededDoneRuleTests.ts | 3 --- .../NoBackboneGetSetOutsideModelRuleTests.ts | 3 --- src/tests/NoBannedTermsTests.ts | 3 --- src/tests/NoConstantConditionRuleTests.ts | 3 --- src/tests/NoControlRegexRuleTests.ts | 3 --- src/tests/NoCookiesTests.ts | 3 --- src/tests/NoDeleteExpressionTests.ts | 3 --- src/tests/NoDisableAutoSanitizationTests.ts | 3 --- src/tests/NoDocumentDomainRuleTests.ts | 3 --- src/tests/NoDocumentWriteTests.ts | 3 --- src/tests/NoDuplicateCaseRuleTests.ts | 3 --- src/tests/NoDuplicateParameterNamesTests.ts | 3 --- src/tests/NoEmptyInterfacesRuleTests.ts | 3 --- .../NoEmptyLineAfterOpeningBraceRuleTests.ts | 3 --- src/tests/NoExecScriptTests.ts | 3 --- src/tests/NoForInRuleTests.ts | 3 --- .../NoFunctionConstructorWithStringArgsTests.ts | 3 --- src/tests/NoFunctionExpressionRuleTests.ts | 3 --- src/tests/NoHttpStringRuleTests.ts | 3 --- src/tests/NoIncrementDecrementTests.ts | 3 --- src/tests/NoInnerHtmlRuleTests.ts | 3 --- src/tests/NoInvalidRegexpRuleTests.ts | 3 --- src/tests/NoJqueryRawElementsRuleTests.ts | 3 --- .../NoMissingVisibilityModifiersRuleTests.ts | 3 --- src/tests/NoMultilineStringTests.ts | 3 --- src/tests/NoMultipleVarDeclRuleTests.ts | 3 --- src/tests/NoOctalLiteralTests.ts | 3 --- src/tests/NoRegexSpacesRuleTests.ts | 3 --- src/tests/NoRelativeImportsRuleTests.ts | 3 --- src/tests/NoReservedKeywordsTests.ts | 3 --- src/tests/NoSingleLineBlockCommentRuleTests.ts | 3 --- src/tests/NoStatelessClassRuleTests.ts | 3 --- src/tests/NoStringBasedSetImmediateTests.ts | 3 --- src/tests/NoStringBasedSetIntervalTests.ts | 3 --- src/tests/NoStringBasedSetTimeoutTests.ts | 3 --- src/tests/NoSuspiciousCommentRuleTests.ts | 3 --- src/tests/NoTypeofUndefinedRuleTests.ts | 3 --- src/tests/NoUnexternalizedStringsRuleTests.ts | 3 --- src/tests/NoUnnecessaryBindRuleTests.ts | 3 --- src/tests/NoUnnecessaryOverrideRuleTests.ts | 3 --- src/tests/NoUnnecessarySemicolonsTests.ts | 3 --- src/tests/NoUnsupportedBrowserCodeRuleTests.ts | 3 --- src/tests/NoUselessFilesRuleTests.ts | 3 --- src/tests/NoVarSelfRuleTests.ts | 3 --- src/tests/NoWithStatementTests.ts | 3 --- src/tests/NonLiteralFsPathRuleTest.ts | 3 --- src/tests/NonLiteralRequireRuleTests.ts | 3 --- src/tests/PossibleTimingAttackRuleTests.ts | 3 --- src/tests/PreferTypeCastRuleTests.ts | 3 --- src/tests/PromiseMustCompleteRuleTests.ts | 3 --- src/tests/ReactA11yAnchorsRuleTests.ts | 3 --- src/tests/ReactA11yLangRuleTests.ts | 3 --- src/tests/ReactA11yMetaRuleTests.ts | 3 --- src/tests/ReactA11yTitlesRuleTests.ts | 3 --- src/tests/ReactAnchorBlankNoopenerRuleTests.ts | 3 --- src/tests/ReactIframeMissingSandboxRuleTests.ts | 3 --- src/tests/ReactNoDangerousHtmlRuleTests.ts | 3 --- src/tests/ReactThisBindingIssueRuleTests.ts | 3 --- src/tests/ReactTsxCurlySpacingRuleTests.ts | 3 --- src/tests/ReactUnusedPropsAndStateRuleTests.ts | 3 --- .../UnderscoreConsistentInvocationRuleTests.ts | 3 --- src/tests/UnnecessaryLocalVariableRuleTests.ts | 3 --- src/tests/UseNamedParameterRuleTests.ts | 3 --- src/tests/UtilsTests.ts | 3 --- src/tests/ValidTypeofRuleTests.ts | 3 --- src/tests/jqueryDeferredMustCompleteRuleTests.ts | 3 --- .../noUnnecessaryFieldInitializationRuleTests.ts | 3 --- src/tests/preferArrayLiteralRuleTests.ts | 3 --- src/underscoreConsistentInvocationRule.ts | 3 --- src/useNamedParameterRule.ts | 3 --- src/utils/BannedTermWalker.ts | 3 --- src/validTypeofRule.ts | 3 --- templates/rule.snippet | 3 --- tslint-warnings.csv | 2 -- tslint.json | 2 +- 166 files changed, 17 insertions(+), 498 deletions(-) diff --git a/README.md b/README.md index 15e35c932..8d8df493f 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Rule Name | Description | Since `insecure-random` | Do not use insecure sources for random bytes. Use a secure random number generator instead. Bans all uses of Math.random and crypto.pseudoRandomBytes. Better alternatives are crypto.randomBytes and window.crypto.getRandomValues.
References:
* [CWE 330](https://cwe.mitre.org/data/definitions/330.html)
* [MDN Math.random](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random)
* [Node.js crypto.randomBytes()](https://nodejs.org/api/crypto.html#crypto_crypto_randombytes_size_callback)
* [window.crypto.getRandomValues()](https://developer.mozilla.org/en-US/docs/Web/API/window.crypto.getRandomValues)
| 2.0.11 `jquery-deferred-must-complete` | When a JQuery Deferred instance is created, then either reject() or resolve() must be called on it within all code branches in the scope. For more examples see the [feature request](https://github.com/Microsoft/tslint-microsoft-contrib/issues/26). | 1.0 `max-func-body-length` | Avoid long functions. The line count of a function body must not exceed the value configured within this rule's options.
You can setup a general max function body length applied for every function/method/arrow function e.g. \[true, 30\] or set different maximum length for every type e.g. \[true, \{ "func-body-length": 10 , "func-expression-body-length": 10 , "arrow-body-length": 5, "method-body-length": 15, "ctor-body-length": 5 \}\]. To specify a function name whose parameters you can ignore for this rule, pass a regular expression as a string(this can be useful for Mocha users to ignore the describe() function). Since version 2.0.9, you can also ignore single- and multi-line comments from the total function length, eg. \[true, \{ "ignore-comments": true \}\] | 2.0.3 -`missing-jsdoc` | All files must have a top level [JSDoc](http://usejsdoc.org/) comment. A JSDoc comment starts with /** (not one more or one less asterisk) and a JSDoc at the 'top-level' appears without leading spaces. Trailing spaces are acceptable but not recommended. | 1.0 +`missing-jsdoc` | Deprecated - This rule can be replaced with TSLint's file-header. All files must have a top level [JSDoc](http://usejsdoc.org/) comment. A JSDoc comment starts with /** (not one more or one less asterisk) and a JSDoc at the 'top-level' appears without leading spaces. Trailing spaces are acceptable but not recommended. | 1.0 `missing-optional-annotation` | Deprecated - This rule is now enforced by the TypeScript compiler. A parameter that follows one or more parameters marked as optional is not itself marked optional | 0.0.1 `mocha-avoid-only` | Do not invoke Mocha's describe.only, it.only or context.only functions. These functions are useful ways to run a single unit test or a single test case during your build, but please be careful to not push these methods calls to your version control repository because it will turn off any of the other tests.| 1.0 `mocha-no-side-effect-code` | All test logic in a Mocha test case should be within Mocha lifecycle method and not defined statically to execute when the module loads. Put all assignments and initialization statements in a before(), beforeEach(), beforeAll(), after(), afterEach(), afterAll(), or it() function. Code executed outside of these lifecycle methods can throw exceptions before the test runner is initialized and can result in errors or even test runner crashes. This rule can be configured with a regex to ignore certain initializations. For example, to ignore any calls to `RestDataFactory` configure the rule with: `[true, { ignore: '^RestDataFactory\\..*' }]`| 2.0.10 diff --git a/recommended_ruleset.js b/recommended_ruleset.js index 7cd037830..49e0a5aea 100644 --- a/recommended_ruleset.js +++ b/recommended_ruleset.js @@ -126,7 +126,6 @@ module.exports = { "max-line-length": [true, 140], "member-access": true, "member-ordering": [true, { "order": "fields-first" }], - "missing-jsdoc": true, "mocha-unneeded-done": true, "new-parens": true, "newline-per-chained-call": true, @@ -257,6 +256,7 @@ module.exports = { /** * Deprecated rules. The following rules are deprecated for various reasons. */ + "missing-jsdoc": false, "missing-optional-annotation": false, // now supported by TypeScript compiler "no-duplicate-case": false, "no-duplicate-parameter-names": false, // now supported by TypeScript compiler diff --git a/src/chaiPreferContainsToIndexOfRule.ts b/src/chaiPreferContainsToIndexOfRule.ts index 05e2c0ee5..68431c927 100644 --- a/src/chaiPreferContainsToIndexOfRule.ts +++ b/src/chaiPreferContainsToIndexOfRule.ts @@ -8,9 +8,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Found chai call with indexOf that can be converted to .contain assertion: '; -/** - * Implementation of the chai-prefer-contains-to-index-of rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/chaiVagueErrorsRule.ts b/src/chaiVagueErrorsRule.ts index 699264673..dfd808f20 100644 --- a/src/chaiVagueErrorsRule.ts +++ b/src/chaiVagueErrorsRule.ts @@ -12,9 +12,6 @@ const FAILURE_STRING_COMPARE_TRUE: string = BASE_ERROR + 'Move the strict equali const FAILURE_STRING_COMPARE_FALSE: string = BASE_ERROR + 'Move the strict inequality comparison from the expect ' + 'call into the assertion value. '; -/** - * Implementation of the chai-vague-errors rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/exportNameRule.ts b/src/exportNameRule.ts index 0b17078d7..3012e15ba 100644 --- a/src/exportNameRule.ts +++ b/src/exportNameRule.ts @@ -8,9 +8,7 @@ import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; export const OPTION_IGNORE_CASE: string = 'ignore-case'; -/** - * Implementation of the export-name rule. - */ + export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/functionNameRule.ts b/src/functionNameRule.ts index b8c74c608..fa5df1f28 100644 --- a/src/functionNameRule.ts +++ b/src/functionNameRule.ts @@ -41,9 +41,6 @@ interface Options { readonly validateStatics: string; } -/** - * Implementation of the function-name rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/importNameRule.ts b/src/importNameRule.ts index d197e0c15..b52314577 100644 --- a/src/importNameRule.ts +++ b/src/importNameRule.ts @@ -6,9 +6,6 @@ import {Utils} from './utils/Utils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import { isObject } from './utils/TypeGuard'; -/** - * Implementation of the import-name rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/informativeDocsRule.ts b/src/informativeDocsRule.ts index 51ebdbfb3..dc2a2950c 100644 --- a/src/informativeDocsRule.ts +++ b/src/informativeDocsRule.ts @@ -28,7 +28,7 @@ interface Options { export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { description: 'Enforces that comments do more than just reiterate names of objects.', - options: null, + options: undefined, optionsDescription: 'Not configurable.', optionExamples: [ true, @@ -65,10 +65,10 @@ export class Rule extends Lint.Rules.AbstractRule { } } -function parseOptions(ruleArguments: any[]): Options { +function parseOptions(ruleArguments: unknown[]): Options { const rawOptions: RawOptions = ruleArguments.length === 0 ? {} - : ruleArguments[0]; + : ruleArguments[0]; return { aliases: parseAliasesOption( diff --git a/src/insecureRandomRule.ts b/src/insecureRandomRule.ts index b98b66034..896ab51eb 100644 --- a/src/insecureRandomRule.ts +++ b/src/insecureRandomRule.ts @@ -10,9 +10,6 @@ const MATH_FAIL_STRING: string = 'Math.random produces insecure random numbers. const NODE_FAIL_STRING: string = 'crypto.pseudoRandomBytes produces insecure random numbers. ' + 'Use crypto.randomBytes() instead'; -/** - * Implementation of the insecure-random rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/jqueryDeferredMustCompleteRule.ts b/src/jqueryDeferredMustCompleteRule.ts index aa37dfe66..4ae740859 100644 --- a/src/jqueryDeferredMustCompleteRule.ts +++ b/src/jqueryDeferredMustCompleteRule.ts @@ -6,9 +6,6 @@ import {AstUtils} from './utils/AstUtils'; import {Utils} from './utils/Utils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the jquery-deferred-must-complete rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/maxFuncBodyLengthRule.ts b/src/maxFuncBodyLengthRule.ts index 45ae0b337..a1aac4e24 100644 --- a/src/maxFuncBodyLengthRule.ts +++ b/src/maxFuncBodyLengthRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; import {forEachTokenWithTrivia} from 'tsutils'; import { isObject } from './utils/TypeGuard'; -/** - * Implementation of the max-func-body-length rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/missingJsdocRule.ts b/src/missingJsdocRule.ts index a610d1f76..e97e76539 100644 --- a/src/missingJsdocRule.ts +++ b/src/missingJsdocRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the missing-jsdoc rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { @@ -16,17 +13,24 @@ export class Rule extends Lint.Rules.AbstractRule { options: null, // tslint:disable-line:no-null-keyword optionsDescription: '', typescriptOnly: true, - issueClass: 'Non-SDL', + issueClass: 'Ignored', issueType: 'Warning', severity: 'Low', level: 'Opportunity for Excellence', - group: 'Clarity', - commonWeaknessEnumeration: '398, 710' + group: 'Deprecated', + recommendation: 'false,' }; public static FAILURE_STRING: string = 'File missing JSDoc comment at the top-level: '; + private static isWarningShown: boolean = false; + public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { + if (Rule.isWarningShown === false) { + console.warn('Warning: missing-jsdoc rule is deprecated. ' + + 'Replace your usage with the TSLint missing-jsdoc rule.'); + Rule.isWarningShown = true; + } return this.applyWithWalker(new MissingJSDocWalker(sourceFile, this.getOptions())); } } diff --git a/src/missingOptionalAnnotationRule.ts b/src/missingOptionalAnnotationRule.ts index d8a861c23..2afea1a2c 100644 --- a/src/missingOptionalAnnotationRule.ts +++ b/src/missingOptionalAnnotationRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the missing-optional-annotation rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/mochaAvoidOnlyRule.ts b/src/mochaAvoidOnlyRule.ts index b7ae8eef6..8c25a088b 100644 --- a/src/mochaAvoidOnlyRule.ts +++ b/src/mochaAvoidOnlyRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import {MochaUtils} from './utils/MochaUtils'; -/** - * Implementation of the mocha-avoid-only rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/mochaNoSideEffectCodeRule.ts b/src/mochaNoSideEffectCodeRule.ts index 4751990ea..7234445bb 100644 --- a/src/mochaNoSideEffectCodeRule.ts +++ b/src/mochaNoSideEffectCodeRule.ts @@ -10,9 +10,6 @@ import { isObject } from './utils/TypeGuard'; const FAILURE_STRING: string = 'Mocha test contains dangerous variable initialization. Move to before()/beforeEach(): '; -/** - * Implementation of the mocha-no-side-effect-code rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/mochaUnneededDoneRule.ts b/src/mochaUnneededDoneRule.ts index 2ddfff59f..f9a40f0ef 100644 --- a/src/mochaUnneededDoneRule.ts +++ b/src/mochaUnneededDoneRule.ts @@ -8,9 +8,6 @@ import {MochaUtils} from './utils/MochaUtils'; const FAILURE_STRING: string = 'Unneeded Mocha Done. Parameter can be safely removed: '; -/** - * Implementation of the mocha-unneeded-done rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noBackboneGetSetOutsideModelRule.ts b/src/noBackboneGetSetOutsideModelRule.ts index c69201f55..57d368c2a 100644 --- a/src/noBackboneGetSetOutsideModelRule.ts +++ b/src/noBackboneGetSetOutsideModelRule.ts @@ -5,12 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-backbone-get-set-outside-model rule. - * - * Currently only makes sure that get and set Backbone methods are called - * on the this reference. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noBannedTermsRule.ts b/src/noBannedTermsRule.ts index c671fd49a..33483f097 100644 --- a/src/noBannedTermsRule.ts +++ b/src/noBannedTermsRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import {BannedTermWalker} from './utils/BannedTermWalker'; -/** - * Implementation of the no-banned-terms rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noConstantConditionRule.ts b/src/noConstantConditionRule.ts index f9ecbcce2..fb3b34ae9 100644 --- a/src/noConstantConditionRule.ts +++ b/src/noConstantConditionRule.ts @@ -6,9 +6,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import { isObject } from './utils/TypeGuard'; -/** - * Implementation of the no-constant-condition rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noControlRegexRule.ts b/src/noControlRegexRule.ts index 962dc23be..c3f70262f 100644 --- a/src/noControlRegexRule.ts +++ b/src/noControlRegexRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-control-regex rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noCookiesRule.ts b/src/noCookiesRule.ts index db86a8ed0..63b27876d 100644 --- a/src/noCookiesRule.ts +++ b/src/noCookiesRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-cookies-rule rule. - */ export class Rule extends Lint.Rules.TypedRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDeleteExpressionRule.ts b/src/noDeleteExpressionRule.ts index c585e6a08..e4168d88a 100644 --- a/src/noDeleteExpressionRule.ts +++ b/src/noDeleteExpressionRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-delete-expression rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDisableAutoSanitizationRule.ts b/src/noDisableAutoSanitizationRule.ts index 323e11d24..5c055a51f 100644 --- a/src/noDisableAutoSanitizationRule.ts +++ b/src/noDisableAutoSanitizationRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-disable-auto-sanitization rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDocumentDomainRule.ts b/src/noDocumentDomainRule.ts index 81960cf12..928a51f13 100644 --- a/src/noDocumentDomainRule.ts +++ b/src/noDocumentDomainRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-document-domain rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDocumentWriteRule.ts b/src/noDocumentWriteRule.ts index 546ca4218..0fc1b9f5f 100644 --- a/src/noDocumentWriteRule.ts +++ b/src/noDocumentWriteRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-document-write rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDuplicateCaseRule.ts b/src/noDuplicateCaseRule.ts index 353f96996..f15acf3d9 100644 --- a/src/noDuplicateCaseRule.ts +++ b/src/noDuplicateCaseRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-duplicate-case rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noDuplicateParameterNamesRule.ts b/src/noDuplicateParameterNamesRule.ts index aa8d0ef9b..beb6112c6 100644 --- a/src/noDuplicateParameterNamesRule.ts +++ b/src/noDuplicateParameterNamesRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-duplicate-parameter-names rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noEmptyInterfacesRule.ts b/src/noEmptyInterfacesRule.ts index a8505fa90..8fedf079d 100644 --- a/src/noEmptyInterfacesRule.ts +++ b/src/noEmptyInterfacesRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-empty-interfaces rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noEmptyLineAfterOpeningBraceRule.ts b/src/noEmptyLineAfterOpeningBraceRule.ts index 3536c2636..8e98b6bf0 100644 --- a/src/noEmptyLineAfterOpeningBraceRule.ts +++ b/src/noEmptyLineAfterOpeningBraceRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import {forEachTokenWithTrivia} from 'tsutils'; -/** - * Implementation of the no-empty-line-after-opening-brace rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noExecScriptRule.ts b/src/noExecScriptRule.ts index 5783773a8..36a6767ee 100644 --- a/src/noExecScriptRule.ts +++ b/src/noExecScriptRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; import {AstUtils} from './utils/AstUtils'; -/** - * Implementation of the no-exec-script rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noForInRule.ts b/src/noForInRule.ts index f4597f292..1c086c592 100644 --- a/src/noForInRule.ts +++ b/src/noForInRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-for-in rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noFunctionConstructorWithStringArgsRule.ts b/src/noFunctionConstructorWithStringArgsRule.ts index d7bdc9e8b..6ceff66be 100644 --- a/src/noFunctionConstructorWithStringArgsRule.ts +++ b/src/noFunctionConstructorWithStringArgsRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-function-constructor-with-string-args rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noFunctionExpressionRule.ts b/src/noFunctionExpressionRule.ts index 8284144aa..54d1ea665 100644 --- a/src/noFunctionExpressionRule.ts +++ b/src/noFunctionExpressionRule.ts @@ -5,9 +5,6 @@ import { AstUtils } from './utils/AstUtils'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-function-expression rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noHttpStringRule.ts b/src/noHttpStringRule.ts index abcb97914..787f9f071 100644 --- a/src/noHttpStringRule.ts +++ b/src/noHttpStringRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {Utils} from './utils/Utils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-http-string rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noIncrementDecrementRule.ts b/src/noIncrementDecrementRule.ts index 41cef44c1..a2312bae4 100644 --- a/src/noIncrementDecrementRule.ts +++ b/src/noIncrementDecrementRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-increment-decrement rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noInnerHtmlRule.ts b/src/noInnerHtmlRule.ts index 63c26f5a4..3de342e03 100644 --- a/src/noInnerHtmlRule.ts +++ b/src/noInnerHtmlRule.ts @@ -9,9 +9,6 @@ const FAILURE_INNER: string = 'Writing a string to the innerHTML property is ins const FAILURE_OUTER: string = 'Writing a string to the outerHTML property is insecure: '; const FAILURE_HTML_LIB: string = 'Using the html() function to write a string to innerHTML is insecure: '; -/** - * Implementation of the no-inner-html rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noInvalidRegexpRule.ts b/src/noInvalidRegexpRule.ts index 9017dfcd8..2427384aa 100644 --- a/src/noInvalidRegexpRule.ts +++ b/src/noInvalidRegexpRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-invalid-regexp rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noJqueryRawElementsRule.ts b/src/noJqueryRawElementsRule.ts index 853dc9b21..1cea35cf4 100644 --- a/src/noJqueryRawElementsRule.ts +++ b/src/noJqueryRawElementsRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING_MANIPULATION: string = 'Replace HTML string manipulation with jQuery API: '; const FAILURE_STRING_COMPLEX: string = 'Replace complex HTML strings with jQuery API: '; -/** - * Implementation of the no-jquery-raw-elements rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noMissingVisibilityModifiersRule.ts b/src/noMissingVisibilityModifiersRule.ts index c50342e43..f2605b62e 100644 --- a/src/noMissingVisibilityModifiersRule.ts +++ b/src/noMissingVisibilityModifiersRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the mo-missing-visibility-modifiers rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noMultilineStringRule.ts b/src/noMultilineStringRule.ts index 581b1ad6e..4f104441c 100644 --- a/src/noMultilineStringRule.ts +++ b/src/noMultilineStringRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-multiline-string rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noMultipleVarDeclRule.ts b/src/noMultipleVarDeclRule.ts index 3135cfdda..40c596211 100644 --- a/src/noMultipleVarDeclRule.ts +++ b/src/noMultipleVarDeclRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-multiple-var-decl rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noOctalLiteralRule.ts b/src/noOctalLiteralRule.ts index a13def04a..13ce350a8 100644 --- a/src/noOctalLiteralRule.ts +++ b/src/noOctalLiteralRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-octal-literal rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noRegexSpacesRule.ts b/src/noRegexSpacesRule.ts index 8f1e9598a..742e72c56 100644 --- a/src/noRegexSpacesRule.ts +++ b/src/noRegexSpacesRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-regex-spaces rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noRelativeImportsRule.ts b/src/noRelativeImportsRule.ts index 2323f6322..6681e352f 100644 --- a/src/noRelativeImportsRule.ts +++ b/src/noRelativeImportsRule.ts @@ -13,9 +13,6 @@ const FAILURE_STRING_EXT_SIBLINGS: string = const FAILURE_STRING_IMPORT_SIBLINGS: string = 'Imported module path starts with reference to parent directory. Please use an absolute path or sibling files/folders: '; -/** - * Implementation of the no-relative-imports rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noReservedKeywordsRule.ts b/src/noReservedKeywordsRule.ts index dd4338277..d6a4c75c6 100644 --- a/src/noReservedKeywordsRule.ts +++ b/src/noReservedKeywordsRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {BannedTermWalker} from './utils/BannedTermWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-reserved-keywords rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noSingleLineBlockCommentRule.ts b/src/noSingleLineBlockCommentRule.ts index f7b1b4835..808777455 100644 --- a/src/noSingleLineBlockCommentRule.ts +++ b/src/noSingleLineBlockCommentRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Replace block comment with a single-line comment'; -/** - * Implementation of the no-single-line-block-comment rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noStatelessClassRule.ts b/src/noStatelessClassRule.ts index 6c322722b..7bd7b067e 100644 --- a/src/noStatelessClassRule.ts +++ b/src/noStatelessClassRule.ts @@ -8,9 +8,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'A stateless class was found. This indicates a failure in the object model: '; -/** - * Implementation of the no-stateless-classes rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noStringBasedSetImmediateRule.ts b/src/noStringBasedSetImmediateRule.ts index 8f92fe72f..4b6a03f81 100644 --- a/src/noStringBasedSetImmediateRule.ts +++ b/src/noStringBasedSetImmediateRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {NoStringParameterToFunctionCallWalker} from './utils/NoStringParameterToFunctionCallWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-string-parameter-to-function-call rule. - */ export class Rule extends Lint.Rules.OptionallyTypedRule { public static metadata: ExtendedMetadata = { diff --git a/src/noStringBasedSetIntervalRule.ts b/src/noStringBasedSetIntervalRule.ts index 7b252e860..441d33e8a 100644 --- a/src/noStringBasedSetIntervalRule.ts +++ b/src/noStringBasedSetIntervalRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {NoStringParameterToFunctionCallWalker} from './utils/NoStringParameterToFunctionCallWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-string-based-set-interval rule. - */ export class Rule extends Lint.Rules.OptionallyTypedRule { public static metadata: ExtendedMetadata = { diff --git a/src/noStringBasedSetTimeoutRule.ts b/src/noStringBasedSetTimeoutRule.ts index 7d58994da..73063af4d 100644 --- a/src/noStringBasedSetTimeoutRule.ts +++ b/src/noStringBasedSetTimeoutRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {NoStringParameterToFunctionCallWalker} from './utils/NoStringParameterToFunctionCallWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-string-based-set-timeout rule. - */ export class Rule extends Lint.Rules.OptionallyTypedRule { public static metadata: ExtendedMetadata = { diff --git a/src/noSuspiciousCommentRule.ts b/src/noSuspiciousCommentRule.ts index fec310046..0741d18c1 100644 --- a/src/noSuspiciousCommentRule.ts +++ b/src/noSuspiciousCommentRule.ts @@ -7,9 +7,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Suspicious comment found: '; const SUSPICIOUS_WORDS = ['BUG', 'HACK', 'FIXME', 'LATER', 'LATER2', 'TODO']; -/** - * Implementation of the no-suspicious-comment rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noTypeofUndefinedRule.ts b/src/noTypeofUndefinedRule.ts index 1157d608e..99741a31a 100644 --- a/src/noTypeofUndefinedRule.ts +++ b/src/noTypeofUndefinedRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Avoid typeof x === \'undefined\' comparisons. Prefer x == undefined or x === undefined: '; -/** - * Implementation of the no-typeof-undefined rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnexternalizedStringsRule.ts b/src/noUnexternalizedStringsRule.ts index 448ca8d5a..5b9cad7ac 100644 --- a/src/noUnexternalizedStringsRule.ts +++ b/src/noUnexternalizedStringsRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-unexternalized-strings rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnnecessaryBindRule.ts b/src/noUnnecessaryBindRule.ts index aeeba1f46..3aeb06ec7 100644 --- a/src/noUnnecessaryBindRule.ts +++ b/src/noUnnecessaryBindRule.ts @@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-unnecessary-bin rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnnecessaryFieldInitializationRule.ts b/src/noUnnecessaryFieldInitializationRule.ts index a59c9ca3d..3022549ad 100644 --- a/src/noUnnecessaryFieldInitializationRule.ts +++ b/src/noUnnecessaryFieldInitializationRule.ts @@ -8,9 +8,6 @@ import {AstUtils} from './utils/AstUtils'; const FAILURE_UNDEFINED_INIT: string = 'Unnecessary field initialization. Field explicitly initialized to undefined: '; const FAILURE_UNDEFINED_DUPE: string = 'Unnecessary field initialization. Field value already initialized in declaration: '; -/** - * Implementation of the no-unnecessary-field-initialization rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnnecessaryLocalVariableRule.ts b/src/noUnnecessaryLocalVariableRule.ts index ca0b12ecf..360cd28bb 100644 --- a/src/noUnnecessaryLocalVariableRule.ts +++ b/src/noUnnecessaryLocalVariableRule.ts @@ -7,9 +7,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Unnecessary local variable: '; -/** - * Implementation of the no-unnecessary-local-variable rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnnecessaryOverrideRule.ts b/src/noUnnecessaryOverrideRule.ts index 3c0be0a5d..bcf3978fb 100644 --- a/src/noUnnecessaryOverrideRule.ts +++ b/src/noUnnecessaryOverrideRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Unnecessary method override. A method that only calls super can be removed: '; -/** - * Implementation of the no-unnecessary-override rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUnnecessarySemicolonsRule.ts b/src/noUnnecessarySemicolonsRule.ts index 1473222e3..2086e0774 100644 --- a/src/noUnnecessarySemicolonsRule.ts +++ b/src/noUnnecessarySemicolonsRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-unnecessary-semicolons rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static FAILURE_STRING: string = 'unnecessary semi-colon'; diff --git a/src/noUnsupportedBrowserCodeRule.ts b/src/noUnsupportedBrowserCodeRule.ts index 2e3dcbf38..6630bb496 100644 --- a/src/noUnsupportedBrowserCodeRule.ts +++ b/src/noUnsupportedBrowserCodeRule.ts @@ -16,9 +16,6 @@ interface BrowserVersion { version: number | string; } -/** - * Implementation of the no-unsupported-browser-code rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noUselessFilesRule.ts b/src/noUselessFilesRule.ts index 189be1597..77a9de455 100644 --- a/src/noUselessFilesRule.ts +++ b/src/noUselessFilesRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING_EMPTY: string = 'This file is empty and should be deleted.'; const FAILURE_STRING_COMMENTS: string = 'This file only contains comments and should be deleted.'; -/** - * Implementation of the no-useless-files rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noVarSelfRule.ts b/src/noVarSelfRule.ts index b4bae730b..21ec37bdb 100644 --- a/src/noVarSelfRule.ts +++ b/src/noVarSelfRule.ts @@ -5,9 +5,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Assigning this reference to local variable: '; -/** - * Implementation of the no-var-self rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/noWithStatementRule.ts b/src/noWithStatementRule.ts index f7848b631..82e62af1b 100644 --- a/src/noWithStatementRule.ts +++ b/src/noWithStatementRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the no-with-statement rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/nonLiteralFsPathRule.ts b/src/nonLiteralFsPathRule.ts index 6c741dc1f..28f3dfa08 100644 --- a/src/nonLiteralFsPathRule.ts +++ b/src/nonLiteralFsPathRule.ts @@ -57,9 +57,6 @@ const PATH_PARAMETER_POSITIONS: { [key: string]: number[] } = { writeFileSync: [0] }; -/** - * Implementation of the non-literal-fs-path rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/nonLiteralRequireRule.ts b/src/nonLiteralRequireRule.ts index 8d2ca1c99..d56a2ec4b 100644 --- a/src/nonLiteralRequireRule.ts +++ b/src/nonLiteralRequireRule.ts @@ -8,9 +8,6 @@ import {Utils} from './utils/Utils'; const FAILURE_STRING: string = 'Non-literal (insecure) parameter passed to require(): '; -/** - * Implementation of the non-literal-require rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/possibleTimingAttackRule.ts b/src/possibleTimingAttackRule.ts index b4c63f966..bf84beb1f 100644 --- a/src/possibleTimingAttackRule.ts +++ b/src/possibleTimingAttackRule.ts @@ -8,9 +8,6 @@ import {Utils} from './utils/Utils'; const FAILURE_STRING: string = 'Possible timing attack detected. Direct comparison found: '; const SENSITIVE_VAR_NAME: RegExp = /^(password|secret|api|apiKey|token|auth|pass|hash)$/im; -/** - * Implementation of the possible-timing-attack rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/preferArrayLiteralRule.ts b/src/preferArrayLiteralRule.ts index 53ddf2f2b..032ccae3e 100644 --- a/src/preferArrayLiteralRule.ts +++ b/src/preferArrayLiteralRule.ts @@ -6,9 +6,6 @@ import {AstUtils} from './utils/AstUtils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; import { isObject } from './utils/TypeGuard'; -/** - * Implementation of the prefer-array-literal rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/preferTypeCastRule.ts b/src/preferTypeCastRule.ts index 6460c92c0..abe22ef3e 100644 --- a/src/preferTypeCastRule.ts +++ b/src/preferTypeCastRule.ts @@ -7,9 +7,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Found as-cast instead of a traditional type-cast. Please convert to a type-cast: '; -/** - * Implementation of the prefer-type-cast rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/promiseMustCompleteRule.ts b/src/promiseMustCompleteRule.ts index b596db1bc..4c18bff43 100644 --- a/src/promiseMustCompleteRule.ts +++ b/src/promiseMustCompleteRule.ts @@ -6,9 +6,6 @@ import {AstUtils} from './utils/AstUtils'; import {Utils} from './utils/Utils'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the promise-must-complete rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactA11yAnchorsRule.ts b/src/reactA11yAnchorsRule.ts index 5826cdff7..e0d97b182 100644 --- a/src/reactA11yAnchorsRule.ts +++ b/src/reactA11yAnchorsRule.ts @@ -33,9 +33,6 @@ export const DIFFERENT_HREF_DIFFERENT_TEXT_FAILURE_STRING: string = export const ACCESSIBLE_HIDDEN_CONTENT_FAILURE_STRING: string = 'Link content can not be hidden for screen-readers by using aria-hidden attribute.'; -/** - * Implementation of the react-a11y-anchors rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactA11yLangRule.ts b/src/reactA11yLangRule.ts index 45a79e505..6f5fc3850 100644 --- a/src/reactA11yLangRule.ts +++ b/src/reactA11yLangRule.ts @@ -21,9 +21,6 @@ const LANGUAGE_CODES: string[] = [ 'ur', 'uz', 'vi', 'vo', 'wa', 'cy', 'wo', 'xh', 'yi', 'ji', 'yo', 'zu' ]; -/** - * Implementation of the react-a11y-lang rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactA11yMetaRule.ts b/src/reactA11yMetaRule.ts index 3d6353a53..cede6e7af 100644 --- a/src/reactA11yMetaRule.ts +++ b/src/reactA11yMetaRule.ts @@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata'; const FAILURE_STRING: string = 'Do not use http-equiv="refresh"'; -/** - * Implementation of the react-a11y-meta rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactA11yTitlesRule.ts b/src/reactA11yTitlesRule.ts index 6e2e6645a..de266f858 100644 --- a/src/reactA11yTitlesRule.ts +++ b/src/reactA11yTitlesRule.ts @@ -10,9 +10,6 @@ const LONG_TITLE_FAILURE_STRING: string = 'Title length must not be longer than const WORD_TITLE_FAILURE_STRING: string = 'Title must contain more than one word'; const MAX_TITLE_LENGTH: number = 60; -/** - * Implementation of the react-a11y-titles rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactAnchorBlankNoopenerRule.ts b/src/reactAnchorBlankNoopenerRule.ts index 5a7439400..2b17061f1 100644 --- a/src/reactAnchorBlankNoopenerRule.ts +++ b/src/reactAnchorBlankNoopenerRule.ts @@ -11,9 +11,6 @@ import { getJsxAttributesFromJsxElement, const FAILURE_STRING: string = 'Anchor tags with target="_blank" should also include rel="noopener noreferrer"'; -/** - * Implementation of the react-anchor-blank-noopener rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactIframeMissingSandboxRule.ts b/src/reactIframeMissingSandboxRule.ts index 6fdaa4af1..c3ad12d3d 100644 --- a/src/reactIframeMissingSandboxRule.ts +++ b/src/reactIframeMissingSandboxRule.ts @@ -25,9 +25,6 @@ const ALLOWED_VALUES: string[] = [ 'allow-top-navigation' ]; -/** - * Implementation of the react-iframe-missing-sandbox rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactNoDangerousHtmlRule.ts b/src/reactNoDangerousHtmlRule.ts index 82abbc84c..3fe94a4b7 100644 --- a/src/reactNoDangerousHtmlRule.ts +++ b/src/reactNoDangerousHtmlRule.ts @@ -11,9 +11,6 @@ export interface Exception { comment: string; } -/** - * Implementation of the react-no-dangerous-html rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/reactThisBindingIssueRule.ts b/src/reactThisBindingIssueRule.ts index 4756ec95a..e6cc29f19 100644 --- a/src/reactThisBindingIssueRule.ts +++ b/src/reactThisBindingIssueRule.ts @@ -13,11 +13,7 @@ const FAILURE_DOUBLE_BIND: string = 'A function is having its \'this\' reference const FAILURE_UNBOUND_LISTENER: string = 'A class method is passed as a JSX attribute without having the \'this\' ' + 'reference bound: '; -/** - * Implementation of the react-this-binding-issue rule. - */ export class Rule extends Lint.Rules.AbstractRule { - public static metadata: ExtendedMetadata = { ruleName: 'react-this-binding-issue', type: 'maintainability', diff --git a/src/reactUnusedPropsAndStateRule.ts b/src/reactUnusedPropsAndStateRule.ts index 411508f87..7683c1aff 100644 --- a/src/reactUnusedPropsAndStateRule.ts +++ b/src/reactUnusedPropsAndStateRule.ts @@ -12,9 +12,6 @@ const STATE_REGEX = 'state-interface-regex'; const FAILURE_UNUSED_PROP: string = 'Unused React property defined in interface: '; const FAILURE_UNUSED_STATE: string = 'Unused React state defined in interface: '; -/** - * Implementation of the react-unused-props-and-state rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/tests/AstUtilsTests.ts b/src/tests/AstUtilsTests.ts index 6ea8b61d6..fb118e783 100644 --- a/src/tests/AstUtilsTests.ts +++ b/src/tests/AstUtilsTests.ts @@ -1,9 +1,6 @@ import {AstUtils} from '../utils/AstUtils'; import * as chai from 'chai'; -/** - * Unit tests. - */ describe('AstUtils', () : void => { describe('isJQuery', (): void => { it('should match expected strings', (): void => { diff --git a/src/tests/ChaiPreferContainsToIndexOfRuleTests.ts b/src/tests/ChaiPreferContainsToIndexOfRuleTests.ts index 1b375e616..b3a8fe398 100644 --- a/src/tests/ChaiPreferContainsToIndexOfRuleTests.ts +++ b/src/tests/ChaiPreferContainsToIndexOfRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('chaiPreferContainsToIndexOfRule', () : void => { const ruleName : string = 'chai-prefer-contains-to-index-of'; diff --git a/src/tests/ChaiVagueErrorsRuleTests.ts b/src/tests/ChaiVagueErrorsRuleTests.ts index 38a956ac8..6a0335b0b 100644 --- a/src/tests/ChaiVagueErrorsRuleTests.ts +++ b/src/tests/ChaiVagueErrorsRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('chaiVagueErrorsRule', () : void => { const ruleName : string = 'chai-vague-errors'; diff --git a/src/tests/ExportNameRuleTests.ts b/src/tests/ExportNameRuleTests.ts index b7ab1aba8..255b276d5 100644 --- a/src/tests/ExportNameRuleTests.ts +++ b/src/tests/ExportNameRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('exportNameRule', () : void => { const ruleName : string = 'export-name'; diff --git a/src/tests/FixNoRequireImportsFormatterTests.ts b/src/tests/FixNoRequireImportsFormatterTests.ts index a43355153..6c8fa0c60 100644 --- a/src/tests/FixNoRequireImportsFormatterTests.ts +++ b/src/tests/FixNoRequireImportsFormatterTests.ts @@ -26,9 +26,6 @@ class FormatterForTesting extends Formatter { } } -/** - * Unit tests. - */ describe('fixNoRequireImportsFormatter', () : void => { const ruleName : string = 'no-require-imports'; diff --git a/src/tests/FixNoVarKeywordFormatterTests.ts b/src/tests/FixNoVarKeywordFormatterTests.ts index 14c43d0d5..5fc3c3ab3 100644 --- a/src/tests/FixNoVarKeywordFormatterTests.ts +++ b/src/tests/FixNoVarKeywordFormatterTests.ts @@ -26,9 +26,6 @@ class FixNoVarKeywordFormatterForTesting extends Formatter { } } -/** - * Unit tests. - */ describe('fixNoVarKeywordFormatter', () : void => { const ruleName : string = 'no-var-keyword'; diff --git a/src/tests/FunctionNameRuleTests.ts b/src/tests/FunctionNameRuleTests.ts index 8f238730a..951a56aab 100644 --- a/src/tests/FunctionNameRuleTests.ts +++ b/src/tests/FunctionNameRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('functionNameRule', () : void => { const ruleName : string = 'function-name'; diff --git a/src/tests/ImportNameRuleTests.ts b/src/tests/ImportNameRuleTests.ts index 8d91be397..c50383485 100644 --- a/src/tests/ImportNameRuleTests.ts +++ b/src/tests/ImportNameRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('importNameRule', () : void => { const ruleName : string = 'import-name'; diff --git a/src/tests/InsecureRandomRuleTests.ts b/src/tests/InsecureRandomRuleTests.ts index 4d7c5470a..2b5140db2 100644 --- a/src/tests/InsecureRandomRuleTests.ts +++ b/src/tests/InsecureRandomRuleTests.ts @@ -1,8 +1,5 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('insecureRandomRule', () : void => { const ruleName : string = 'insecure-random'; diff --git a/src/tests/MaxFuncBodyLengthRuleTests.ts b/src/tests/MaxFuncBodyLengthRuleTests.ts index 1d6e66052..378cb2adf 100644 --- a/src/tests/MaxFuncBodyLengthRuleTests.ts +++ b/src/tests/MaxFuncBodyLengthRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import { TestHelper } from './TestHelper'; -/** - * Unit tests. - */ describe('maxFuncBodyLengthRule', (): void => { let options: [boolean, number | object, object?]; const script: string = ` diff --git a/src/tests/MissingJsdocRuleTests.ts b/src/tests/MissingJsdocRuleTests.ts index 4f73f0dba..18c6fb7aa 100644 --- a/src/tests/MissingJsdocRuleTests.ts +++ b/src/tests/MissingJsdocRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('missing-jsdoc', () : void => { const ruleName : string = 'missing-jsdoc'; diff --git a/src/tests/MissingOptionalAnnotationTests.ts b/src/tests/MissingOptionalAnnotationTests.ts index caa62c640..165d2d248 100644 --- a/src/tests/MissingOptionalAnnotationTests.ts +++ b/src/tests/MissingOptionalAnnotationTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('missingOptionalAnnotationRule', () : void => { const ruleName : string = 'missing-optional-annotation'; diff --git a/src/tests/MochaAvoidOnlyRuleTests.ts b/src/tests/MochaAvoidOnlyRuleTests.ts index 8065e9c90..6694c58a9 100644 --- a/src/tests/MochaAvoidOnlyRuleTests.ts +++ b/src/tests/MochaAvoidOnlyRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('mochaAvoidOnlyRule', () : void => { const ruleName : string = 'mocha-avoid-only'; diff --git a/src/tests/MochaNoSideEffectCodeRuleTests.ts b/src/tests/MochaNoSideEffectCodeRuleTests.ts index 7c02f2bf7..d892cafc9 100644 --- a/src/tests/MochaNoSideEffectCodeRuleTests.ts +++ b/src/tests/MochaNoSideEffectCodeRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('mochaNoSideEffectCodeRule', () : void => { const ruleName : string = 'mocha-no-side-effect-code'; diff --git a/src/tests/MochaUnneededDoneRuleTests.ts b/src/tests/MochaUnneededDoneRuleTests.ts index 00ff5e345..e74fd644b 100644 --- a/src/tests/MochaUnneededDoneRuleTests.ts +++ b/src/tests/MochaUnneededDoneRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('mochaUnneededDoneRule', () : void => { const ruleName : string = 'mocha-unneeded-done'; diff --git a/src/tests/NoBackboneGetSetOutsideModelRuleTests.ts b/src/tests/NoBackboneGetSetOutsideModelRuleTests.ts index e45a65dcb..161084378 100644 --- a/src/tests/NoBackboneGetSetOutsideModelRuleTests.ts +++ b/src/tests/NoBackboneGetSetOutsideModelRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noBackboneGetSetOutsideModelRule', () : void => { const ruleName : string = 'no-backbone-get-set-outside-model'; diff --git a/src/tests/NoBannedTermsTests.ts b/src/tests/NoBannedTermsTests.ts index c3af3dcd6..8faca1421 100644 --- a/src/tests/NoBannedTermsTests.ts +++ b/src/tests/NoBannedTermsTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noBannedTermsRule', () : void => { const RULE_NAME : string = 'no-banned-terms'; diff --git a/src/tests/NoConstantConditionRuleTests.ts b/src/tests/NoConstantConditionRuleTests.ts index 71a4ea26d..5154aebb2 100644 --- a/src/tests/NoConstantConditionRuleTests.ts +++ b/src/tests/NoConstantConditionRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noConstantConditionRule', () : void => { const ruleName : string = 'no-constant-condition'; diff --git a/src/tests/NoControlRegexRuleTests.ts b/src/tests/NoControlRegexRuleTests.ts index ae3049784..eabc00fe3 100644 --- a/src/tests/NoControlRegexRuleTests.ts +++ b/src/tests/NoControlRegexRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noControlRegexRule', () : void => { const ruleName : string = 'no-control-regex'; diff --git a/src/tests/NoCookiesTests.ts b/src/tests/NoCookiesTests.ts index e03ff648a..c4d715e97 100644 --- a/src/tests/NoCookiesTests.ts +++ b/src/tests/NoCookiesTests.ts @@ -1,8 +1,5 @@ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noCookiesRule', () : void => { it('should not produce violations', () : void => { const ruleName : string = 'no-cookies'; diff --git a/src/tests/NoDeleteExpressionTests.ts b/src/tests/NoDeleteExpressionTests.ts index 74cfbc997..36746a50e 100644 --- a/src/tests/NoDeleteExpressionTests.ts +++ b/src/tests/NoDeleteExpressionTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDeleteExpressionRule', (): void => { const RULE_NAME: string = 'no-delete-expression'; diff --git a/src/tests/NoDisableAutoSanitizationTests.ts b/src/tests/NoDisableAutoSanitizationTests.ts index 8410034bb..76a769cc3 100644 --- a/src/tests/NoDisableAutoSanitizationTests.ts +++ b/src/tests/NoDisableAutoSanitizationTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDisableAutoSanitizationRule', () : void => { it('should produce violation for execUnsafeLocalFunction', () : void => { const ruleName : string = 'no-disable-auto-sanitization'; diff --git a/src/tests/NoDocumentDomainRuleTests.ts b/src/tests/NoDocumentDomainRuleTests.ts index df58efb08..50cb4012c 100644 --- a/src/tests/NoDocumentDomainRuleTests.ts +++ b/src/tests/NoDocumentDomainRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDocumentDomainRule', () : void => { const ruleName : string = 'no-document-domain'; diff --git a/src/tests/NoDocumentWriteTests.ts b/src/tests/NoDocumentWriteTests.ts index a5197129b..25270964e 100644 --- a/src/tests/NoDocumentWriteTests.ts +++ b/src/tests/NoDocumentWriteTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDocumentWriteRule', () : void => { const RULE_NAME : string = 'no-document-write'; diff --git a/src/tests/NoDuplicateCaseRuleTests.ts b/src/tests/NoDuplicateCaseRuleTests.ts index df1a6c0f8..77a905872 100644 --- a/src/tests/NoDuplicateCaseRuleTests.ts +++ b/src/tests/NoDuplicateCaseRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDuplicateCaseRule', () : void => { const ruleName : string = 'no-duplicate-case'; diff --git a/src/tests/NoDuplicateParameterNamesTests.ts b/src/tests/NoDuplicateParameterNamesTests.ts index 4de9f4380..d3f94f048 100644 --- a/src/tests/NoDuplicateParameterNamesTests.ts +++ b/src/tests/NoDuplicateParameterNamesTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noDuplicateParameterNames', () : void => { const RULE_NAME : string = 'no-duplicate-parameter-names'; diff --git a/src/tests/NoEmptyInterfacesRuleTests.ts b/src/tests/NoEmptyInterfacesRuleTests.ts index 32ff7ca71..d06e803a0 100644 --- a/src/tests/NoEmptyInterfacesRuleTests.ts +++ b/src/tests/NoEmptyInterfacesRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noEmptyInterfacesRule', () : void => { const ruleName : string = 'no-empty-interfaces'; diff --git a/src/tests/NoEmptyLineAfterOpeningBraceRuleTests.ts b/src/tests/NoEmptyLineAfterOpeningBraceRuleTests.ts index 7f6395e65..0ba46f4d7 100644 --- a/src/tests/NoEmptyLineAfterOpeningBraceRuleTests.ts +++ b/src/tests/NoEmptyLineAfterOpeningBraceRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noEmptyLineAfterOpeningBraceRule', (): void => { const ruleName: string = 'no-empty-line-after-opening-brace'; diff --git a/src/tests/NoExecScriptTests.ts b/src/tests/NoExecScriptTests.ts index ba067a6de..1544f082b 100644 --- a/src/tests/NoExecScriptTests.ts +++ b/src/tests/NoExecScriptTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noExecScriptRule', () : void => { const RULE_NAME : string = 'no-exec-script'; diff --git a/src/tests/NoForInRuleTests.ts b/src/tests/NoForInRuleTests.ts index 4f2487bfd..20fb7f730 100644 --- a/src/tests/NoForInRuleTests.ts +++ b/src/tests/NoForInRuleTests.ts @@ -3,9 +3,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noForInRule', () : void => { const ruleName : string = 'no-for-in'; diff --git a/src/tests/NoFunctionConstructorWithStringArgsTests.ts b/src/tests/NoFunctionConstructorWithStringArgsTests.ts index c84881489..89aa0b4ce 100644 --- a/src/tests/NoFunctionConstructorWithStringArgsTests.ts +++ b/src/tests/NoFunctionConstructorWithStringArgsTests.ts @@ -1,8 +1,5 @@ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noFunctionConstructorWithStringArgsRule', () : void => { const RULE_NAME : string = 'no-function-constructor-with-string-args'; diff --git a/src/tests/NoFunctionExpressionRuleTests.ts b/src/tests/NoFunctionExpressionRuleTests.ts index 3d34e700e..5b38fd298 100644 --- a/src/tests/NoFunctionExpressionRuleTests.ts +++ b/src/tests/NoFunctionExpressionRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noFunctionExpressionRule', (): void => { const ruleName: string = 'no-function-expression'; diff --git a/src/tests/NoHttpStringRuleTests.ts b/src/tests/NoHttpStringRuleTests.ts index c57e9693f..98a9e8600 100644 --- a/src/tests/NoHttpStringRuleTests.ts +++ b/src/tests/NoHttpStringRuleTests.ts @@ -2,9 +2,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noHttpStringRule', (): void => { const ruleName: string = 'no-http-string'; diff --git a/src/tests/NoIncrementDecrementTests.ts b/src/tests/NoIncrementDecrementTests.ts index 8d5e1122f..4c770c328 100644 --- a/src/tests/NoIncrementDecrementTests.ts +++ b/src/tests/NoIncrementDecrementTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noIncrementDecrementRule', () : void => { const RULE_NAME : string = 'no-increment-decrement'; diff --git a/src/tests/NoInnerHtmlRuleTests.ts b/src/tests/NoInnerHtmlRuleTests.ts index 84e429c0f..06fa9befc 100644 --- a/src/tests/NoInnerHtmlRuleTests.ts +++ b/src/tests/NoInnerHtmlRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noInnerHtmlRule', () : void => { const ruleName : string = 'no-inner-html'; diff --git a/src/tests/NoInvalidRegexpRuleTests.ts b/src/tests/NoInvalidRegexpRuleTests.ts index 13e74c745..963192746 100644 --- a/src/tests/NoInvalidRegexpRuleTests.ts +++ b/src/tests/NoInvalidRegexpRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noInvalidRegexpRule', () : void => { const ruleName : string = 'no-invalid-regexp'; diff --git a/src/tests/NoJqueryRawElementsRuleTests.ts b/src/tests/NoJqueryRawElementsRuleTests.ts index b0c69ef76..241edcf9e 100644 --- a/src/tests/NoJqueryRawElementsRuleTests.ts +++ b/src/tests/NoJqueryRawElementsRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noJqueryRawElementsRule', () : void => { const ruleName : string = 'no-jquery-raw-elements'; diff --git a/src/tests/NoMissingVisibilityModifiersRuleTests.ts b/src/tests/NoMissingVisibilityModifiersRuleTests.ts index c763ae1da..ee759b331 100644 --- a/src/tests/NoMissingVisibilityModifiersRuleTests.ts +++ b/src/tests/NoMissingVisibilityModifiersRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noMissingVisibilityModifiers', () : void => { const ruleName : string = 'no-missing-visibility-modifiers'; diff --git a/src/tests/NoMultilineStringTests.ts b/src/tests/NoMultilineStringTests.ts index 42eaf3a84..a117240f7 100644 --- a/src/tests/NoMultilineStringTests.ts +++ b/src/tests/NoMultilineStringTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noMultilineStringRule', () : void => { const RULE_NAME : string = 'no-multiline-string'; diff --git a/src/tests/NoMultipleVarDeclRuleTests.ts b/src/tests/NoMultipleVarDeclRuleTests.ts index 5396be642..604211183 100644 --- a/src/tests/NoMultipleVarDeclRuleTests.ts +++ b/src/tests/NoMultipleVarDeclRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noMultipleVarDeclRule', () : void => { const ruleName : string = 'no-multiple-var-decl'; diff --git a/src/tests/NoOctalLiteralTests.ts b/src/tests/NoOctalLiteralTests.ts index 7388e1be6..a1f62347f 100644 --- a/src/tests/NoOctalLiteralTests.ts +++ b/src/tests/NoOctalLiteralTests.ts @@ -3,9 +3,6 @@ import {TestHelper} from './TestHelper'; /* tslint:disable:no-octal-literal */ /* tslint:disable:max-func-body-length */ -/** - * Unit tests. - */ describe('noOctalLiteralRule', () : void => { const ruleName : string = 'no-octal-literal'; diff --git a/src/tests/NoRegexSpacesRuleTests.ts b/src/tests/NoRegexSpacesRuleTests.ts index 27aa0b394..c30f2b3be 100644 --- a/src/tests/NoRegexSpacesRuleTests.ts +++ b/src/tests/NoRegexSpacesRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noRegexSpacesRule', () : void => { const ruleName : string = 'no-regex-spaces'; diff --git a/src/tests/NoRelativeImportsRuleTests.ts b/src/tests/NoRelativeImportsRuleTests.ts index a57d768c4..3f4b8bd86 100644 --- a/src/tests/NoRelativeImportsRuleTests.ts +++ b/src/tests/NoRelativeImportsRuleTests.ts @@ -2,9 +2,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noRelativeImportsRule', () : void => { const ruleName : string = 'no-relative-imports'; diff --git a/src/tests/NoReservedKeywordsTests.ts b/src/tests/NoReservedKeywordsTests.ts index efbe84c8e..66d549532 100644 --- a/src/tests/NoReservedKeywordsTests.ts +++ b/src/tests/NoReservedKeywordsTests.ts @@ -3,9 +3,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noBannedTermsRule', () : void => { const RULE_NAME : string = 'no-reserved-keywords'; diff --git a/src/tests/NoSingleLineBlockCommentRuleTests.ts b/src/tests/NoSingleLineBlockCommentRuleTests.ts index a0a7b2ff4..d5098697e 100644 --- a/src/tests/NoSingleLineBlockCommentRuleTests.ts +++ b/src/tests/NoSingleLineBlockCommentRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noSingleLineBlockCommentRule', () : void => { const ruleName : string = 'no-single-line-block-comment'; diff --git a/src/tests/NoStatelessClassRuleTests.ts b/src/tests/NoStatelessClassRuleTests.ts index c07ac6dd0..5f2cacf58 100644 --- a/src/tests/NoStatelessClassRuleTests.ts +++ b/src/tests/NoStatelessClassRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noStatelessClassRule', () : void => { const ruleName : string = 'no-stateless-class'; diff --git a/src/tests/NoStringBasedSetImmediateTests.ts b/src/tests/NoStringBasedSetImmediateTests.ts index e915197c9..bc1acff16 100644 --- a/src/tests/NoStringBasedSetImmediateTests.ts +++ b/src/tests/NoStringBasedSetImmediateTests.ts @@ -1,9 +1,6 @@ /* tslint:disable:max-func-body-length */ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ /* tslint:disable:no-consecutive-blank-lines */ describe('noStringBasedSetImmediateRule', () : void => { const RULE_NAME : string = 'no-string-based-set-immediate'; diff --git a/src/tests/NoStringBasedSetIntervalTests.ts b/src/tests/NoStringBasedSetIntervalTests.ts index f568708bd..079ccc652 100644 --- a/src/tests/NoStringBasedSetIntervalTests.ts +++ b/src/tests/NoStringBasedSetIntervalTests.ts @@ -2,9 +2,6 @@ /* tslint:disable:no-consecutive-blank-lines */ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noStringBasedSetIntervalRule', () : void => { const RULE_NAME : string = 'no-string-based-set-interval'; diff --git a/src/tests/NoStringBasedSetTimeoutTests.ts b/src/tests/NoStringBasedSetTimeoutTests.ts index 22a778689..46017fffd 100644 --- a/src/tests/NoStringBasedSetTimeoutTests.ts +++ b/src/tests/NoStringBasedSetTimeoutTests.ts @@ -1,8 +1,5 @@ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noStringBasedSetTimeoutRule', () : void => { const RULE_NAME : string = 'no-string-based-set-timeout'; diff --git a/src/tests/NoSuspiciousCommentRuleTests.ts b/src/tests/NoSuspiciousCommentRuleTests.ts index 24a19b337..8578bf9db 100644 --- a/src/tests/NoSuspiciousCommentRuleTests.ts +++ b/src/tests/NoSuspiciousCommentRuleTests.ts @@ -4,9 +4,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noSuspiciousCommentRule', (): void => { const ruleName: string = 'no-suspicious-comment'; diff --git a/src/tests/NoTypeofUndefinedRuleTests.ts b/src/tests/NoTypeofUndefinedRuleTests.ts index 97384dd5c..4dea6743b 100644 --- a/src/tests/NoTypeofUndefinedRuleTests.ts +++ b/src/tests/NoTypeofUndefinedRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noTypeofUndefinedRule', () : void => { const ruleName : string = 'no-typeof-undefined'; diff --git a/src/tests/NoUnexternalizedStringsRuleTests.ts b/src/tests/NoUnexternalizedStringsRuleTests.ts index ab394b78b..0ca41bbaa 100644 --- a/src/tests/NoUnexternalizedStringsRuleTests.ts +++ b/src/tests/NoUnexternalizedStringsRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUnexternalizedStringsRule', () : void => { const ruleName : string = 'no-unexternalized-strings'; diff --git a/src/tests/NoUnnecessaryBindRuleTests.ts b/src/tests/NoUnnecessaryBindRuleTests.ts index 906f93a29..9ab43b983 100644 --- a/src/tests/NoUnnecessaryBindRuleTests.ts +++ b/src/tests/NoUnnecessaryBindRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUnnecessaryBindRule', () : void => { const ruleName : string = 'no-unnecessary-bind'; diff --git a/src/tests/NoUnnecessaryOverrideRuleTests.ts b/src/tests/NoUnnecessaryOverrideRuleTests.ts index 2026eba42..0648a3412 100644 --- a/src/tests/NoUnnecessaryOverrideRuleTests.ts +++ b/src/tests/NoUnnecessaryOverrideRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUnnecessaryOverrideRule', () : void => { const ruleName : string = 'no-unnecessary-override'; diff --git a/src/tests/NoUnnecessarySemicolonsTests.ts b/src/tests/NoUnnecessarySemicolonsTests.ts index c1cf29766..0a354a781 100644 --- a/src/tests/NoUnnecessarySemicolonsTests.ts +++ b/src/tests/NoUnnecessarySemicolonsTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUnnecessarySemiColons', () : void => { const ruleName : string = 'no-unnecessary-semicolons'; diff --git a/src/tests/NoUnsupportedBrowserCodeRuleTests.ts b/src/tests/NoUnsupportedBrowserCodeRuleTests.ts index e93125eac..22a41bb60 100644 --- a/src/tests/NoUnsupportedBrowserCodeRuleTests.ts +++ b/src/tests/NoUnsupportedBrowserCodeRuleTests.ts @@ -3,9 +3,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUnsupportedBrowserCodeRule', () : void => { const ruleName : string = 'no-unsupported-browser-code'; diff --git a/src/tests/NoUselessFilesRuleTests.ts b/src/tests/NoUselessFilesRuleTests.ts index 9365e28d6..62cb255aa 100644 --- a/src/tests/NoUselessFilesRuleTests.ts +++ b/src/tests/NoUselessFilesRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noUselessFilesRule', () : void => { const ruleName : string = 'no-useless-files'; diff --git a/src/tests/NoVarSelfRuleTests.ts b/src/tests/NoVarSelfRuleTests.ts index f1b91eb0d..f37b4d01e 100644 --- a/src/tests/NoVarSelfRuleTests.ts +++ b/src/tests/NoVarSelfRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noVarSelfRule', () : void => { const ruleName : string = 'no-var-self'; diff --git a/src/tests/NoWithStatementTests.ts b/src/tests/NoWithStatementTests.ts index babe5fb3c..6e4cf4e19 100644 --- a/src/tests/NoWithStatementTests.ts +++ b/src/tests/NoWithStatementTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('noWithStatementsRule', () : void => { it('should produce violations', () : void => { diff --git a/src/tests/NonLiteralFsPathRuleTest.ts b/src/tests/NonLiteralFsPathRuleTest.ts index e8a9e7230..56d6e0917 100644 --- a/src/tests/NonLiteralFsPathRuleTest.ts +++ b/src/tests/NonLiteralFsPathRuleTest.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('nonLiteralFsPathRule', (): void => { const ruleName: string = 'non-literal-fs-path'; diff --git a/src/tests/NonLiteralRequireRuleTests.ts b/src/tests/NonLiteralRequireRuleTests.ts index 653181392..7f8de301c 100644 --- a/src/tests/NonLiteralRequireRuleTests.ts +++ b/src/tests/NonLiteralRequireRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('nonLiteralRequireRule', () : void => { const ruleName : string = 'non-literal-require'; diff --git a/src/tests/PossibleTimingAttackRuleTests.ts b/src/tests/PossibleTimingAttackRuleTests.ts index 66f36dcff..e4cccbca8 100644 --- a/src/tests/PossibleTimingAttackRuleTests.ts +++ b/src/tests/PossibleTimingAttackRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('possibleTimingAttackRule', () : void => { const ruleName : string = 'possible-timing-attack'; diff --git a/src/tests/PreferTypeCastRuleTests.ts b/src/tests/PreferTypeCastRuleTests.ts index 4027ea3cb..7d2a7ab42 100644 --- a/src/tests/PreferTypeCastRuleTests.ts +++ b/src/tests/PreferTypeCastRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('preferTypeCastRule', () : void => { const ruleName : string = 'prefer-type-cast'; diff --git a/src/tests/PromiseMustCompleteRuleTests.ts b/src/tests/PromiseMustCompleteRuleTests.ts index 4f35fbd65..70d49da32 100644 --- a/src/tests/PromiseMustCompleteRuleTests.ts +++ b/src/tests/PromiseMustCompleteRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('promiseMustCompleteRule', () : void => { const ruleName : string = 'promise-must-complete'; diff --git a/src/tests/ReactA11yAnchorsRuleTests.ts b/src/tests/ReactA11yAnchorsRuleTests.ts index 59ddaad72..11dc97ae0 100644 --- a/src/tests/ReactA11yAnchorsRuleTests.ts +++ b/src/tests/ReactA11yAnchorsRuleTests.ts @@ -12,9 +12,6 @@ import { ACCESSIBLE_HIDDEN_CONTENT_FAILURE_STRING } from '../reactA11yAnchorsRule'; -/** - * Unit tests. - */ describe('reactA11yAnchorsRule', () : void => { const ruleName : string = 'react-a11y-anchors'; diff --git a/src/tests/ReactA11yLangRuleTests.ts b/src/tests/ReactA11yLangRuleTests.ts index 8d53e79b4..f5514fc86 100644 --- a/src/tests/ReactA11yLangRuleTests.ts +++ b/src/tests/ReactA11yLangRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactA11yLangRule', () : void => { const ruleName : string = 'react-a11y-lang'; diff --git a/src/tests/ReactA11yMetaRuleTests.ts b/src/tests/ReactA11yMetaRuleTests.ts index 77c72e1fd..80877e138 100644 --- a/src/tests/ReactA11yMetaRuleTests.ts +++ b/src/tests/ReactA11yMetaRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactA11yMetaRule', () : void => { const ruleName : string = 'react-a11y-meta'; diff --git a/src/tests/ReactA11yTitlesRuleTests.ts b/src/tests/ReactA11yTitlesRuleTests.ts index eea5b905f..6bd1637ee 100644 --- a/src/tests/ReactA11yTitlesRuleTests.ts +++ b/src/tests/ReactA11yTitlesRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactA11yTitlesRule', () : void => { const ruleName : string = 'react-a11y-titles'; diff --git a/src/tests/ReactAnchorBlankNoopenerRuleTests.ts b/src/tests/ReactAnchorBlankNoopenerRuleTests.ts index 64c5d6c0b..0b2ab24eb 100644 --- a/src/tests/ReactAnchorBlankNoopenerRuleTests.ts +++ b/src/tests/ReactAnchorBlankNoopenerRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactAnchorBlankNoopenerRule', () : void => { const ruleName : string = 'react-anchor-blank-noopener'; diff --git a/src/tests/ReactIframeMissingSandboxRuleTests.ts b/src/tests/ReactIframeMissingSandboxRuleTests.ts index b8e299d0a..9ce270c74 100644 --- a/src/tests/ReactIframeMissingSandboxRuleTests.ts +++ b/src/tests/ReactIframeMissingSandboxRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactIframeMissingSandboxRule', () : void => { const ruleName : string = 'react-iframe-missing-sandbox'; diff --git a/src/tests/ReactNoDangerousHtmlRuleTests.ts b/src/tests/ReactNoDangerousHtmlRuleTests.ts index d44f9e5e0..8f507da82 100644 --- a/src/tests/ReactNoDangerousHtmlRuleTests.ts +++ b/src/tests/ReactNoDangerousHtmlRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactNoDangerousHtmlRule', () : void => { const ruleName : string = 'react-no-dangerous-html'; diff --git a/src/tests/ReactThisBindingIssueRuleTests.ts b/src/tests/ReactThisBindingIssueRuleTests.ts index bfa3b92eb..743c82cd9 100644 --- a/src/tests/ReactThisBindingIssueRuleTests.ts +++ b/src/tests/ReactThisBindingIssueRuleTests.ts @@ -1,8 +1,5 @@ import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactThisBindingIssueRule', () : void => { const ruleName : string = 'react-this-binding-issue'; diff --git a/src/tests/ReactTsxCurlySpacingRuleTests.ts b/src/tests/ReactTsxCurlySpacingRuleTests.ts index 6096991b3..957a41339 100644 --- a/src/tests/ReactTsxCurlySpacingRuleTests.ts +++ b/src/tests/ReactTsxCurlySpacingRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import { TestHelper } from './TestHelper'; -/** - * Unit tests. - */ describe('reactTsxCurlySpacing', () => { const ruleName: string = 'react-tsx-curly-spacing'; diff --git a/src/tests/ReactUnusedPropsAndStateRuleTests.ts b/src/tests/ReactUnusedPropsAndStateRuleTests.ts index 0674f3e1a..db86b7c1a 100644 --- a/src/tests/ReactUnusedPropsAndStateRuleTests.ts +++ b/src/tests/ReactUnusedPropsAndStateRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('reactUnusedPropsAndStateRule', () : void => { const ruleName : string = 'react-unused-props-and-state'; diff --git a/src/tests/UnderscoreConsistentInvocationRuleTests.ts b/src/tests/UnderscoreConsistentInvocationRuleTests.ts index d1d2f8957..ac1a9c54c 100644 --- a/src/tests/UnderscoreConsistentInvocationRuleTests.ts +++ b/src/tests/UnderscoreConsistentInvocationRuleTests.ts @@ -4,9 +4,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('underscoreConsistentInvocationRule', () : void => { const ruleName : string = 'underscore-consistent-invocation'; diff --git a/src/tests/UnnecessaryLocalVariableRuleTests.ts b/src/tests/UnnecessaryLocalVariableRuleTests.ts index df34ddd23..96aa3ae6e 100644 --- a/src/tests/UnnecessaryLocalVariableRuleTests.ts +++ b/src/tests/UnnecessaryLocalVariableRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('unnecessaryLocalVariableRule', () : void => { const ruleName : string = 'no-unnecessary-local-variable'; diff --git a/src/tests/UseNamedParameterRuleTests.ts b/src/tests/UseNamedParameterRuleTests.ts index 210925e81..2eeeef5ec 100644 --- a/src/tests/UseNamedParameterRuleTests.ts +++ b/src/tests/UseNamedParameterRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('useNamedParameterRule', () : void => { const ruleName : string = 'use-named-parameter'; diff --git a/src/tests/UtilsTests.ts b/src/tests/UtilsTests.ts index cf381187f..04b75e946 100644 --- a/src/tests/UtilsTests.ts +++ b/src/tests/UtilsTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import * as chai from 'chai'; -/** - * Unit tests. - */ describe('Utils', () : void => { describe('contains', (): void => { it('should handle empty states', (): void => { diff --git a/src/tests/ValidTypeofRuleTests.ts b/src/tests/ValidTypeofRuleTests.ts index 7f5e88319..4e68b8805 100644 --- a/src/tests/ValidTypeofRuleTests.ts +++ b/src/tests/ValidTypeofRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('validTypeofRule', () : void => { const ruleName : string = 'valid-typeof'; diff --git a/src/tests/jqueryDeferredMustCompleteRuleTests.ts b/src/tests/jqueryDeferredMustCompleteRuleTests.ts index f413a453b..a545d00cd 100644 --- a/src/tests/jqueryDeferredMustCompleteRuleTests.ts +++ b/src/tests/jqueryDeferredMustCompleteRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('jquery-deferred-must-complete', () : void => { const ruleName : string = 'jquery-deferred-must-complete'; diff --git a/src/tests/noUnnecessaryFieldInitializationRuleTests.ts b/src/tests/noUnnecessaryFieldInitializationRuleTests.ts index 265b25ff3..c9a663ca0 100644 --- a/src/tests/noUnnecessaryFieldInitializationRuleTests.ts +++ b/src/tests/noUnnecessaryFieldInitializationRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('unnecessaryFieldInitializationRule', () : void => { const ruleName : string = 'no-unnecessary-field-initialization'; diff --git a/src/tests/preferArrayLiteralRuleTests.ts b/src/tests/preferArrayLiteralRuleTests.ts index ae2ba4cbd..c6ab64d05 100644 --- a/src/tests/preferArrayLiteralRuleTests.ts +++ b/src/tests/preferArrayLiteralRuleTests.ts @@ -1,9 +1,6 @@ import {Utils} from '../utils/Utils'; import {TestHelper} from './TestHelper'; -/** - * Unit tests. - */ describe('preferArrayLiteralRule', () : void => { const ruleName : string = 'prefer-array-literal'; diff --git a/src/underscoreConsistentInvocationRule.ts b/src/underscoreConsistentInvocationRule.ts index 7feb1a285..4151bedcf 100644 --- a/src/underscoreConsistentInvocationRule.ts +++ b/src/underscoreConsistentInvocationRule.ts @@ -27,9 +27,6 @@ const FUNCTION_NAMES: string[] = [ 'lastIndexOf', 'findLastIndex', 'sortedIndex', 'range' ]; -/** - * Implementation of the underscore-consistent-invocation rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/useNamedParameterRule.ts b/src/useNamedParameterRule.ts index 4398ee45e..38d7eb387 100644 --- a/src/useNamedParameterRule.ts +++ b/src/useNamedParameterRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the use-named-parameter rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/src/utils/BannedTermWalker.ts b/src/utils/BannedTermWalker.ts index 05c3ff394..f786d77ab 100644 --- a/src/utils/BannedTermWalker.ts +++ b/src/utils/BannedTermWalker.ts @@ -3,9 +3,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './ErrorTolerantWalker'; import { isObject, isNamed } from './TypeGuard'; -/** - * Implementation of the banned-term rulesets. - */ export class BannedTermWalker extends ErrorTolerantWalker { private failureString : string; private bannedTerms: string[]; diff --git a/src/validTypeofRule.ts b/src/validTypeofRule.ts index 107d50ede..db988590d 100644 --- a/src/validTypeofRule.ts +++ b/src/validTypeofRule.ts @@ -4,9 +4,6 @@ import * as Lint from 'tslint'; import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker'; import {ExtendedMetadata} from './utils/ExtendedMetadata'; -/** - * Implementation of the valid-typeof rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/templates/rule.snippet b/templates/rule.snippet index ec16f885b..8800c7a34 100644 --- a/templates/rule.snippet +++ b/templates/rule.snippet @@ -10,9 +10,6 @@ import {Utils} from './utils/Utils'; const FAILURE_STRING: string = 'Some error message: '; // TODO: Define an error message -/** - * Implementation of the %RULE_NAME% rule. - */ export class Rule extends Lint.Rules.AbstractRule { public static metadata: ExtendedMetadata = { diff --git a/tslint-warnings.csv b/tslint-warnings.csv index 15b523a42..85a3f6d2e 100644 --- a/tslint-warnings.csv +++ b/tslint-warnings.csv @@ -52,8 +52,6 @@ member-access,Requires explicit visibility declarations for class members.,TSLIN CWE 710 - Coding Standards Violation" member-ordering,Enforces member ordering.,TSLINT7UKID8,tslint,Non-SDL,Warning,Low,Opportunity for Excellence,See description on the tslint or tslint-microsoft-contrib website,TSLint Procedure,"398, 710","CWE 398 - Indicator of Poor Code Quality CWE 710 - Coding Standards Violation" -missing-jsdoc,All files must have a top level JSDoc comment.,TSLINT117J7CN,tslint,Non-SDL,Warning,Low,Opportunity for Excellence,See description on the tslint or tslint-microsoft-contrib website,TSLint Procedure,"398, 710","CWE 398 - Indicator of Poor Code Quality -CWE 710 - Coding Standards Violation" mocha-avoid-only,"Do not invoke Mocha's describe.only, it.only or context.only functions.",TSLINT1M1BHOM,tslint,Non-SDL,Error,Critical,Opportunity for Excellence,See description on the tslint or tslint-microsoft-contrib website,TSLint Procedure,, new-parens,Requires parentheses when invoking a constructor via the `new` keyword.,TSLINTJF199B,tslint,Non-SDL,Warning,Low,Opportunity for Excellence,See description on the tslint or tslint-microsoft-contrib website,TSLint Procedure,710,"CWE 710 - Coding Standards Violation" newline-before-return,Enforces blank line before return when not the only line in the block.,TSLINT1QRE306,tslint,Non-SDL,Warning,Low,Opportunity for Excellence,See description on the tslint or tslint-microsoft-contrib website,TSLint Procedure,710,"CWE 710 - Coding Standards Violation" diff --git a/tslint.json b/tslint.json index eded70cd3..eafff3a16 100644 --- a/tslint.json +++ b/tslint.json @@ -72,7 +72,7 @@ "member-ordering": [ false ], - "missing-jsdoc": true, + "missing-jsdoc": false, "missing-optional-annotation": false, "mocha-avoid-only": true, "mocha-no-side-effect-code": true,