[docs] additional code examples for 12 rules

src/rules/arrowReturnShorthandRule.ts

@@ -20,6 +20,7 @@ import * as ts from "typescript";
 
 import * as Lint from "../index";
 import { hasCommentAfterPosition } from "../language/utils";
+import { codeExamples } from "./code-examples/arrowReturnShorthand.examples";
 
 const OPTION_MULTILINE = "multiline";
 
@@ -45,6 +46,7 @@ export class Rule extends Lint.Rules.AbstractRule {
  `,
  type: "style",
  typescriptOnly: false,
+ codeExamples,
  };
  /* tslint:enable:object-literal-sort-keys */
 

src/rules/classNameRule.ts

@@ -20,6 +20,7 @@ import * as ts from "typescript";
 
 import * as Lint from "../index";
 import { isPascalCased } from "../utils";
+import { codeExamples } from "./code-examples/className.examples";
 
 export class Rule extends Lint.Rules.AbstractRule {
  /* tslint:disable:object-literal-sort-keys */
@@ -37,6 +38,7 @@ export class Rule extends Lint.Rules.AbstractRule {
  optionExamples: [true],
  type: "style",
  typescriptOnly: false,
+ codeExamples,
  };
  /* tslint:enable:object-literal-sort-keys */
 

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

@@ -0,0 +1,57 @@
+/**
+ * @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: "Enforces usage of the shorthand return syntax when an arrow function's body does not span multiple lines.",
+ config: Lint.Utils.dedent`
+ "rules": { "arrow-return-shorthand": true }
+ `,
+ pass: Lint.Utils.dedent`
+ const calc = (x: number, y: number) => ({ add: x + y, sub: x - y, mul: x * y });
+ const calc2 = (x: number, y: number) => {
+ return { add: x + y, sub: x - y, mul: x * y }
+ };
+ `,
+ fail: Lint.Utils.dedent`
+ const calc = (x: number, y: number) => { return { add: x + y, sub: x - y, mul: x * y } };
+ const calc2 = (x: number, y: number) => {
+ return { add: x + y, sub: x - y, mul: x * y }
+ };
+ `,
+ },
+ {
+ description: "Enforces usage of the shorthand return syntax even when an arrow function's body spans multiple lines.",
+ config: Lint.Utils.dedent`
+ "rules": { "arrow-return-shorthand": [true, "multiline"] }
+ `,
+ pass: Lint.Utils.dedent`
+ const calc = (x: number, y: number) => ({ add: x + y, sub: x - y, mul: x * y });
+ const calc2 = (x: number, y: number) =>
+ ({ add: x + y, sub: x - y, mul: x * y });
+ `,
+ fail: Lint.Utils.dedent`
+ const calc = (x: number, y: number) => { return { add: x + y, sub: x - y, mul: x * y } };
+ const calc2 = (x: number, y: number) => {
+ return { add: x + y, sub: x - y, mul: x * y }
+ };
+ `,
+ },
+];

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

@@ -0,0 +1,36 @@
+/**
+ * @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: "Enforces PascalCased class and interface names.",
+ config: Lint.Utils.dedent`
+ "rules": { "class-name": true }
+ `,
+ pass: Lint.Utils.dedent`
+ class MyClass { }
+ interface MyInterface { }
+ `,
+ fail: Lint.Utils.dedent`
+ class myClass { }
+ interface myInterface { }
+ `,
+ },
+];

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2013 Palantir Technologies, Inc.
+ * 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.

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

@@ -0,0 +1,34 @@
+/**
+ * @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: "Disallows usages of `any` as a type declaration.",
+ config: Lint.Utils.dedent`
+ "rules": { "no-any": true }
+ `,
+ pass: Lint.Utils.dedent`
+ let foo: object;
+ `,
+ fail: Lint.Utils.dedent`
+ let foo: any;
+ `,
+ },
+];

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

@@ -0,0 +1,36 @@
+/**
+ * @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: "Disallows empty interfaces.",
+ config: Lint.Utils.dedent`
+ "rules": { "no-empty-interface": true }
+ `,
+ pass: Lint.Utils.dedent`
+ interface I {
+ foo: string;
+ }
+ `,
+ fail: Lint.Utils.dedent`
+ interface I { }
+ `,
+ },
+];

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

@@ -0,0 +1,34 @@
+/**
+ * @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: "Disallows sparse arrays",
+ config: Lint.Utils.dedent`
+ "rules": { "no-sparse-arrays": true }
+ `,
+ pass: Lint.Utils.dedent`
+ const arr: string[] = ['elemenet1', 'element2'];
+ `,
+ fail: Lint.Utils.dedent`
+ const arr: string[] = ['elemenet1',, 'element2'];
+ `,
+ },
+];

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2013 Palantir Technologies, Inc.
+ * 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.

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

@@ -0,0 +1,38 @@
+/**
+ * @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: "Disallows unnecessary callback wrappers",
+ config: Lint.Utils.dedent`
+ "rules": { "no-unnecessary-callback-wrapper": true }
+ `,
+ pass: Lint.Utils.dedent`
+ const handleContent = (content) => console.log('Handle content:', content);
+ const handleError = (error) => console.log('Handle error:', error);
+ promise.then(handleContent).catch(handleError);
+ `,
+ fail: Lint.Utils.dedent`
+ const handleContent = (content) => console.log('Handle content:', content);
+ const handleError = (error) => console.log('Handle error:', error);
+ promise.then((content) => handleContent(content)).catch((error) => handleError(error));
+ `,
+ },
+];

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

@@ -0,0 +1,73 @@
+/**
+ * @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: "Requires that an object literal's keys be sorted alphabetically.",
+ config: Lint.Utils.dedent`
+ "rules": { "object-literal-sort-keys": true }
+ `,
+ pass: Lint.Utils.dedent`
+ let o = {
+ bar: 2,
+ foo: 1
+ };
+ `,
+ fail: Lint.Utils.dedent`
+ let o = {
+ foo: 1,
+ bar: 2
+ };
+ `,
+ },
+ {
+ description: Lint.Utils.dedent`Requires that an object literal's keys be sorted by interface-definition.
+ If there is no interface fallback to alphabetically.`,
+ config: Lint.Utils.dedent`
+ "rules": {
+ "object-literal-sort-keys": {
+ "options": "match-declaration-order"
+ }
+ }
+ `,
+ pass: Lint.Utils.dedent`
+ interface I {
+ foo: number;
+ bar: number;
+ }
+
+ let o: I = {
+ foo: 1,
+ bar: 2
+ };
+ `,
+ fail: Lint.Utils.dedent`
+ interface I {
+ foo: number;
+ bar: number;
+ }
+
+ let o: I = {
+ bar: 2,
+ foo: 1
+ };
+ `,
+ },
+];