Add code examples

- Added code examples for prefer-while rule

src/rules/code-examples/preferWhile.examples.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2018 Palantir Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as Lint from "../../index";
+
+// tslint:disable: object-literal-sort-keys
+export const codeExamples = [
+ {
+ description: "Prefer `while` loops instead of `for` loops without an initializer and incrementor.",
+ config: Lint.Utils.dedent`
+ "rules": { "prefer-while": true }
+ `,
+ pass: Lint.Utils.dedent`
+ for(let x = 1; x < 10; x++) {
+ console.log(x);
+ }
+
+ for (let i = 0; i < 10; x+=1) {
+ console.log(x);
+ }
+
+ for (let i = 0; i < 10;) {
+ i += 1;
+ }
+ `,
+ fail: Lint.Utils.dedent`
+ for(;;) {
+ console.log(x);
+ }
+
+ for(;true===true;) {
+ console.log(x);
+ }
+ `,
+ },
+];

src/rules/preferWhileRule.ts

@@ -18,6 +18,7 @@
 import { isForStatement } from "tsutils";
 import * as ts from "typescript";
 import * as Lint from "../index";
+import { codeExamples } from "./code-examples/preferWhile.examples";
 
 export class Rule extends Lint.Rules.AbstractRule {
  /* tslint:disable:object-literal-sort-keys */
@@ -31,6 +32,7 @@ export class Rule extends Lint.Rules.AbstractRule {
  hasFix: true,
  type: "style",
  typescriptOnly: false,
+ codeExamples,
  };
  /* tslint:enable:object-literal-sort-keys */