Merge pull request #1596 from palantir/ad/master-into-next

Prepare v4.0.0-dev.0

.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
+.sass-cache
 .tscache/
 /build/
+/docs/site/
 /scripts/*.js
 /lib/
 node_modules/

CHANGELOG.md

@@ -1,12 +1,24 @@
 Change Log
 ===
 
+v4.0.0-dev.0
+---
+* TODO
+
+v3.15.1
+---
+* Enabled additional rules in `tslint:latest` configuration (#1506)
+
+v3.15.0
+---
+* Stable release containing changes from the last dev release (v3.15.0-dev.0)
+
 v3.15.0-dev.0
 ---
 * [enhancement] Rules can automatically fix errors (#1423)
 * [enhancement] Better error messages for invalid source files (#1480)
 * [new-rule] `adjacent-overload-signatures` rule (#1426)
-* [new-rule] `file-header` rule (#1411)
+* [new-rule] `file-header` rule (#1441)
 * [new-rule] `object-literal-shorthand` rule (#1488)
 * [new-rule-option] `allow-declarations` option for `only-arrow-functions` rule (#1452)
 * [new-rule-option] `import-sources-order` option for `ordered-imports` rule (#1466)

README.md

@@ -391,7 +391,7 @@ Creating a new release
 ----------------------
 <sup>[back to ToC &uarr;](#table-of-contents)</sup>
 
-1. Bump the version number in `package.json` and `src/tslint.ts`
+1. Bump the version number in `package.json` and `src/tslintMulti.ts`
 2. Add release notes in `CHANGELOG.md`
 3. Run `grunt` to build the latest sources
 4. Commit with message `Prepare release <version>`

docs/Gemfile

@@ -1,3 +1,2 @@
-ruby '2.2.3'
 source 'https://rubygems.org'
 gem 'github-pages'

docs/_data/rules.json

@@ -1,4 +1,14 @@
 [
+  {
+    "ruleName": "adjacent-overload-signatures",
+    "description": "Enforces function overloads to be consecutive.",
+    "optionsDescription": "Not configurable.",
+    "options": null,
+    "optionExamples": [
+      "true"
+    ],
+    "type": "typescript"
+  },
   {
     "ruleName": "align",
     "description": "Enforces vertical alignment.",
@@ -116,6 +126,18 @@
     ],
     "type": "maintainability"
   },
+  {
+    "ruleName": "file-header",
+    "description": "Enforces a certain header comment for all files, matched by a regular expression.",
+    "optionsDescription": "Regular expression to match the header.",
+    "options": {
+      "type": "string"
+    },
+    "optionExamples": [
+      "\"true\", \"Copyright \\d{4}\""
+    ],
+    "type": "style"
+  },
   {
     "ruleName": "forin",
     "description": "Requires a `for ... in` statement to be filtered with an `if` statement.",
@@ -803,6 +825,15 @@
     ],
     "type": "style"
   },
+  {
+    "ruleName": "object-literal-shorthand",
+    "description": "Enforces use of ES6 object literal shorthand when possible.",
+    "options": null,
+    "optionExamples": [
+      "true"
+    ],
+    "type": "style"
+  },
   {
     "ruleName": "object-literal-sort-keys",
     "description": "Requires keys in object literals to be sorted alphabetically",
@@ -863,21 +894,40 @@
     "ruleName": "only-arrow-functions",
     "description": "Disallows traditional (non-arrow) function expressions.",
     "rationale": "Traditional functions don't bind lexical scope, which can lead to unexpected behavior when accessing 'this'.",
-    "optionsDescription": "Not configurable.",
-    "options": null,
+    "optionsDescription": "\nOne argument may be optionally provided:\n\n* `\"allow-declarations\"` allows standalone function declarations.\n        ",
+    "options": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "allow-declarations"
+        ]
+      },
+      "minLength": 0,
+      "maxLength": 1
+    },
     "optionExamples": [
-      "true"
+      "true",
+      "[true, \"allow-declarations\"]"
     ],
     "type": "typescript"
   },
   {
     "ruleName": "ordered-imports",
     "description": "Requires that import statements be alphabetized.",
     "descriptionDetails": "\nEnforce a consistent ordering for ES6 imports:\n- Named imports must be alphabetized (i.e. \"import {A, B, C} from \"foo\";\")\n    - The exact ordering can be controled by the named-imports-order option.\n    - \"longName as name\" imports are ordered by \"longName\".\n- Import sources must be alphabetized within groups, i.e.:\n        import * as foo from \"a\";\n        import * as bar from \"b\";\n- Groups of imports are delineated by blank lines. You can use these to group imports\n    however you like, e.g. by first- vs. third-party or thematically.",
-    "optionsDescription": "\nYou may set the `\"named-imports-order\"` option to control the ordering of named\nimports (the `{A, B, C}` in 'import {A, B, C} from \"foo\"`.)\n\nPossible values for `\"named-imports-order\"` are:\n\n* `\"case-insensitive'`: Correct order is `{A, b, C}`. (This is the default.)\n* `\"lowercase-first\"`: Correct order is `{b, A, C}`.\n* `\"lowercase-last\"`: Correct order is `{A, C, b}`.\n        ",
+    "optionsDescription": "\nYou may set the `\"import-sources-order\"` option to control the ordering of source\nimports (the `\"foo\"` in `import {A, B, C} from \"foo\"`).\n\nPossible values for `\"import-sources-order\"` are:\n* `\"case-insensitive'`: Correct order is `\"Bar\"`, `\"baz\"`, `\"Foo\"`. (This is the default.)\n* `\"lowercase-first\"`: Correct order is `\"baz\"`, `\"Bar\"`, `\"Foo\"`.\n* `\"lowercase-last\"`: Correct order is `\"Bar\"`, `\"Foo\"`, `\"baz\"`.\n\nYou may set the `\"named-imports-order\"` option to control the ordering of named\nimports (the `{A, B, C}` in `import {A, B, C} from \"foo\"`).\n\nPossible values for `\"named-imports-order\"` are:\n\n* `\"case-insensitive'`: Correct order is `{A, b, C}`. (This is the default.)\n* `\"lowercase-first\"`: Correct order is `{b, A, C}`.\n* `\"lowercase-last\"`: Correct order is `{A, C, b}`.\n\n        ",
     "options": {
       "type": "object",
       "properties": {
+        "import-sources-order": {
+          "type": "string",
+          "enum": [
+            "case-insensitive",
+            "lowercase-first",
+            "lowercase-last"
+          ]
+        },
         "named-imports-order": {
           "type": "string",
           "enum": [
@@ -891,7 +941,7 @@
     },
     "optionExamples": [
       "true",
-      "[true, {\"named-imports-order\": \"lowercase-first\"}]"
+      "[true, {\"import-sources-order\": \"lowercase-last\", \"named-imports-order\": \"lowercase-first\"}]"
     ],
     "type": "style"
   },
@@ -1037,13 +1087,14 @@
   {
     "ruleName": "typedef",
     "description": "Requires type definitions to exist.",
-    "optionsDescription": "\nSix arguments may be optionally provided:\n\n* `\"call-signature\"` checks return type of functions.\n* `\"parameter\"` checks type specifier of function parameters for non-arrow functions.\n* `\"arrow-parameter\"` checks type specifier of function parameters for arrow functions.\n* `\"property-declaration\"` checks return types of interface properties.\n* `\"variable-declaration\"` checks variable declarations.\n* `\"member-variable-declaration\"` checks member variable declarations.",
+    "optionsDescription": "\nSeven arguments may be optionally provided:\n\n* `\"call-signature\"` checks return type of functions.\n* `\"arrow-call-signature\"` checks return type of arrow functions.\n* `\"parameter\"` checks type specifier of function parameters for non-arrow functions.\n* `\"arrow-parameter\"` checks type specifier of function parameters for arrow functions.\n* `\"property-declaration\"` checks return types of interface properties.\n* `\"variable-declaration\"` checks variable declarations.\n* `\"member-variable-declaration\"` checks member variable declarations.",
     "options": {
       "type": "array",
       "items": {
         "type": "string",
         "enum": [
           "call-signature",
+          "arrow-call-signature",
           "parameter",
           "arrow-parameter",
           "property-declaration",
@@ -1052,7 +1103,7 @@
         ]
       },
       "minLength": 0,
-      "maxLength": 6
+      "maxLength": 7
     },
     "optionExamples": [
       "[true, \"call-signature\", \"parameter\", \"member-variable-declaration\"]"
@@ -1237,7 +1288,7 @@
           "check-decl",
           "check-operator",
           "check-module",
-          "check-seperator",
+          "check-separator",
           "check-type",
           "check-typecast"
         ]

docs/_layouts/rule.html

@@ -9,6 +9,10 @@
    <h5>Rationale</h5>
    {{page.rationale | markdownify}}
 {% endif %}
+{% if page.requiresTypeInfo %}
+   <strong>Note:</strong>
+   <a href="https://github.com/palantir/tslint#type-checking">This rule requires type info to run</a>
+{% endif %}
 
 
 <h3>Config</h3>
@@ -24,4 +28,4 @@ <h5>Examples</h5>
 <h5>Schema</h5>
 <pre>
 {{page.optionsJSON}}
-</pre>
+</pre>