diff --git a/.circleci/config.yml b/.circleci/config.yml index b15baf9768e..39f28497765 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -43,7 +43,7 @@ jobs: - run: yarn test test2.1: docker: - - image: circleci/node:4 + - image: circleci/node:6 steps: - checkout - attach_workspace: diff --git a/.editorconfig b/.editorconfig index 136f3bd6803..3c44241cc4f 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,6 +7,3 @@ end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true - -[tslint.json] -indent_size = 2 diff --git a/.gitignore b/.gitignore index 867cab0c905..d3bcc025629 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,6 @@ /scripts/*.js /scripts/*.js.map /lib/ -/test/executable/tslint.json node_modules/ !test/rules/**/node_modules tscommand*.txt diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index 141e0095c74..00000000000 --- a/.prettierignore +++ /dev/null @@ -1,36 +0,0 @@ -# See https://help.github.com/ignore-files/ for more about ignoring files. - -# dependencies -/node_modules - -# docs -.github -/docs - -# testing -/coverage -/test/external/ -/test/files/ -/test/rules/ - -# production -/build -/lib - -# ide -/.idea - -# npm -package.json -package-lock.json - -# misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* diff --git a/.prettierrc.json b/.prettierrc.json deleted file mode 100644 index c37611da667..00000000000 --- a/.prettierrc.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "tabWidth": 4, - "printWidth": 100, - "trailingComma": "all", - "overrides": [ - { - "files": "*.json", - "options": { - "parser": "json" - } - }, - { - "files": "*.scss", - "options": { - "parser": "scss" - } - } - ] -} diff --git a/.vscode/launch.json b/.vscode/launch.json index 1e19b6e7c0b..1d10e4a290c 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -47,7 +47,7 @@ "stopOnEntry": false, "args": ["run", "test"], "cwd": "${workspaceRoot}", - "preLaunchTask": "tsc", + "preLaunchTask": "compile_tests", "runtimeExecutable": null, "runtimeArgs": ["--nolazy"], "env": { diff --git a/.vscode/settings.json b/.vscode/settings.json index 69313dbf0a7..22803497de8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -21,6 +21,8 @@ "node_modules": true }, + "tslint.configFile": "tslint-vscode.json", + // Always use project's provided typescript compiler version "typescript.tsdk": "node_modules/typescript/lib", "files.eol": "\n" diff --git a/.vscode/tasks.json b/.vscode/tasks.json index f3aafc3f3d3..00290a5ba84 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -1,11 +1,10 @@ { - // See https://go.microsoft.com/fwlink/?LinkId=733558 - // for the documentation about the tasks.json format - "version": "0.1.0", - "command": "tsc", - "isShellCommand": true, - "args": ["-w", "-p", "test"], - "showOutput": "silent", - "isWatching": true, - "problemMatcher": "$tsc-watch" -} \ No newline at end of file + "tasks": [ + { + "identifier": "compile_tests", + "type": "npm", + "script": "compile:test", + "problemMatcher": ["$tsc"] + } + ] +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 3998cc93689..5620bbb6e1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,167 @@ # Change Log +## v5.12.1 + +## :hammer_and_wrench: Bugfixes & enhancements + +- [bugfix] Revert breaking change to tslint:recommended, update tslint:latest (#4404) +- [bugfix] Correcting fixer for the [`increment-decrement`](https://palantir.github.io/tslint/rules/increment-decrement/) rule (#4415) +- [bugfix] Fix [`strict-type-predicates`](https://palantir.github.io/tslint/rules/strict-type-predicates/) with `unknown` (#4444) +- [bugfix] Skip linting of `.json` files to avoid problems with `--resolveJsonModule` compiler option (#4001) +- [bugfix] fix some [`quotemark`](https://palantir.github.io/tslint/rules/quotemark/) issues when using backticks with the `avoid-template` option (#4408) +- [enhancement] Mention file names in test script parse failures (#4397) + +Thanks to our contributors! +- Young Min Kim +- Enes SOYLU +- Thomas den Hollander +- Adrian Leonhard + +## v5.12.0 + +## :tada: Features + +- [feature] Configure format from file (#4155) +- [feature] Make cli expect array for rules dir (#3788) +- [feature] Set js rules to all valid active rules (#3641) +- [improvement] Add tests for typescript@2.9 and typescript@3.0 (#4053) +- [new-fixer][`type-literal-delimiter`](https://palantir.github.io/tslint/rules/type-literal-delimiter/) (#3964) +- [new-rule-option][`whitespace`](https://palantir.github.io/tslint/rules/whitespace/) Add whitespace rule for open braces (#4068) +- [new-rule-option][`file-name-casing`](https://palantir.github.io/tslint/rules/file-name-casing/): Add file name whitelist (#4206) +- [new-rule-option][`object-literal-sort-keys`](https://palantir.github.io/tslint/rules/object-literal-sort-keys/): `locale-compare` (#4193) +- [new-rule-option][`strict-boolean-expressions`](https://palantir.github.io/tslint/rules/strict-boolean-expressions/) adds `allow-enum` to allow using enums in boolean expressions (#3604) +- [new-rule-option][`import-blacklist`](https://palantir.github.io/tslint/rules/import-blacklist/): support blacklisting specific named exports (#3926) +- [new-rule-option][`type-literal-delimiter`](https://palantir.github.io/tslint/rules/type-literal-delimiter/): Add `{ singleLine: "always" | "never"}` (#3964) +- [new-rule-option][`file-name-casing`](https://palantir.github.io/tslint/rules/file-name-casing/): Add `snake-case` option (#4081) +- [new-rule-option][`file-header`](https://palantir.github.io/tslint/rules/file-header/): Enforce Blank Line after File Header (#3740) +- [new-rule][`ban-ts-ignore`](https://palantir.github.io/tslint/rules/ban-ts-ignore/) (#3728) +- [new-rule][`function-constructor`](https://palantir.github.io/tslint/rules/function-constructor/) (#4198) +- [new-rule][`increment-decrement`](https://palantir.github.io/tslint/rules/increment-decrement/) (#3575) +- [new-rule][`no-default-import`](https://palantir.github.io/tslint/rules/no-default-import/) (#4023) +- [new-rule][`unnecessary-constructor`](https://palantir.github.io/tslint/rules/unnecessary-constructor/) (#3647) +- [new-rule][`comment-type`](https://palantir.github.io/tslint/rules/comment-type/) (#4008) +- [new-rule][`unnecessary-bind`](https://palantir.github.io/tslint/rules/unnecessary-bind/) (#3588) + +## :hammer_and_wrench: Bugfixes & enhancements + +- [api] Allow `exclude` to work with node API (#4143) +- [api] Upgrade TSLint to support TS 3.1 (#4274) +- [bugfix] Allow whitelisted modules to start with `@` symbol (#4192) +- [bugfix] Added exception for generators in [`return-undefined`](https://palantir.github.io/tslint/rules/return-undefined/) rule (#4370) +- [bugfix] Allow unknown in 'no-object-literal-type-assertion' rule. (#4362) +- [bugfix] Completed docs rule can check single-line comments (#3841) +- [bugfix][`prefer-method-signature`](https://palantir.github.io/tslint/rules/prefer-method-signature/): Correct the auto-fix code of rule, now capable to handle multiline signature. (#4066) +- [bugfix] Default logger.error should log to stderr. (#3982) +- [bugfix] Fixes an issue where TSLint doesn't correctly resolve packages in a `node_modules` folder that are symlinked to another location where their dependencies are satisfied. (#4295) +- [bugfix] Fix configuration tests when comparing rules (#4346) +- [bugfix] Fix semicolon: Cannot read property 'initializer' of undefined (#4351) +- [bugfix] Fix whitespace rule in importClause with 'as' statement (#4249) +- [bugfix][`no-invalid-this`](https://palantir.github.io/tslint/rules/no-invalid-this/): fixes false positives on method-like syntax and false negatives on nested functions (#4034) +- [bugfix][`one-line`](https://palantir.github.io/tslint/rules/one-line/): Check block in a case clause (#3619) +- [bugfix][`whitespace`](https://palantir.github.io/tslint/rules/whitespace/) Don't require space between import and paren with in type imports (#4243) +- [bugfix] remove [`no-unused-variable`](https://palantir.github.io/tslint/rules/no-unused-variable/) from `tslint:all` (#4079) +- [bugfix][`callable-types`](https://palantir.github.io/tslint/rules/callable-types/) support interfaces containing a single construct signature (#4291) (#4352) +- [bugfix][`ordered-imports`](https://palantir.github.io/tslint/rules/ordered-imports/): Setting `import-sources-order: any` no longer invalidates `grouped-imports: true` (#4374) +- [develop] Add issue templates (#4028) +- [develop] Add test for 3.0 (#4119) +- [develop] Changes the node version from 4 to 6 for TS 2.1 tests. (#4282) +- [develop] Fix prettier command in package.json (#4275) +- [develop] Fix semantic merge break from #4374 and #3733 (#4378) +- [develop] Fix typo in launch.json (#4287) +- [develop] Prettier (#4012) +- [develop] Re-ran Prettier on source files again, with some more ignores (#4270) +- [develop] Update 'json-stringify-pretty-compact' to 1.2.0 and remove unnecessary type declaration (#4371) +- [develop] Upgrade prettier and run over all files (#4214) +- [docs] "< 0" means less than zero, not greater than (#4183) +- [docs] Added badges for dependencies status (#4160) +- [docs] Additional code examples for rules (#3869) +- [docs] Clarify no-shadowed-variable doc (#4347) +- [docs] Fix docs typo (#4165) +- [docs] Fix docs typo (#4182) +- [docs] Fix typo in index.md (#4242) +- [docs] Fix typos in formatter descriptions (#4288) +- [docs] Fixed typo in documentation (#4047) +- [docs] Includes new name Azure DevOps for VSO (#4289) +- [docs] Typo correction in no-unused-expression (#4322) +- [docs] Update documentation to reflect changes made in #2229. (#4336) +- [docs] Update stylish example (#4095) +- [docs] Use latest docs deps to avoid vulnerable libs (#4366) +- [docs] prefer-object-spread: this is new to ES2018, not ES2015 (#4321) +- [documentation] Update configuration documentation to include array syntax (#4258) +- [enhancement] Add `homepage` to package.json (#4101) +- [enhancement] Add esSpecCompliant: true to recommended trailing-comma config (#4072) +- [enhancement] Add new tests to workflows (#4054) +- [enhancement] Add quiet flag to hide warnings (#4025) +- [enhancement] Don't flag unmatched ${ in no-invalid-template-strings (#3769) +- [enhancement] Show offending value in 'no-magic-numbers' error message (#4332) +- [enhancement][`ordered-imports`](https://palantir.github.io/tslint/rules/ordered-imports/): When `grouped-imports` option of the rule is set, the fact that imports of the same type are all in one group is also checked. (#3733) +- [enhancement] Yaml parser now uses default schema, allowing for `<<:` to be used to merge anchors (#4350) +- [enhancement] Improve JUnit formatter (#4327) +- [enhancement] completed-docs: check properties and methods in interfaces (#4032) +- [enhancement] file-name-casing-rule supports regex expression for matching file (#4284) +- [enhancement] prose formatter uses `line:column` instead of `[line, column]` (#4222) +- [rule-change] Add "backtick" option for quotemark (#4029) +- [rule-change] Allow void expressions in binary expressions (#4323) + +Thanks to our contributors! + +- Shinigami +- Matthew Herbst +- Joshua R +- John Wiseheart +- Mitchell Wills +- Eric Ferreira +- Daniel Reichhart +- Rui +- Pavel Birukov +- Brian Schlenker +- Michael Black +- Andy Hanson +- atsu85 +- PomanoB +- Oleg Vaskevich +- Daniel McNab +- Jan Pilzer +- Sebastian Silbermann +- Michael Lavina +- reduckted +- Ryan Waskiewicz +- Bowen Ni +- Josh Goldberg +- Erik +- Nathan +- Kevin Verdieck +- Joe Chung +- Peter Safranek +- Xavier Downs +- Igor Ovsiannikov +- RyosukeFukushima +- Andrew Boyton +- samuela +- stefanhamburger +- Carsten Dietzel +- Jakob Warkotsch +- Karthick Manoharan +- Ian Clanton-Thuon +- Yordis Prieto +- Mike Frysinger +- Dario Banfi +- Gérôme Grignon +- Antony74 +- Morgan Zolob +- Young Min Kim +- rrogowski +- Eric Anderson +- Simon Marchi +- ulrichb +- Marvin Altemeier +- Ifiok Jr +- Andrew MacLeay +- Ethan +- Dan Homola +- NN +- Roman Rogowski + ## v5.11.0 ## :warning: Deprecations diff --git a/README.md b/README.md index cdc4f0340d2..391fbf78af9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ [![NPM version](https://badge.fury.io/js/tslint.svg)](http://badge.fury.io/js/tslint) [![Downloads](http://img.shields.io/npm/dm/tslint.svg)](https://npmjs.org/package/tslint) +[![Dependency Status](https://david-dm.org/palantir/tslint.svg)](https://david-dm.org/palantir/tslint) +[![devDependency Status](https://david-dm.org/palantir/tslint/dev-status.svg)](https://david-dm.org/palantir/tslint/?type=dev) +[![peerDependency Status](https://david-dm.org/palantir/tslint/peer-status.svg)](https://david-dm.org/palantir/tslint/?type=peer) [![Circle CI](https://circleci.com/gh/palantir/tslint.svg?style=svg)](https://circleci.com/gh/palantir/tslint) # TSLint @@ -14,7 +17,7 @@ TSLint supports: - inline disabling and enabling of rules with comment flags in source code - configuration presets (`tslint:latest`, `tslint-react`, etc.) and plugin composition - automatic fixing of formatting & style violations -- integration with [MSBuild](https://github.com/joshuakgoldberg/tslint.msbuild), [Grunt](https://github.com/palantir/grunt-tslint), [Gulp](https://github.com/panuhorsmalahti/gulp-tslint), [Atom](https://github.com/AtomLinter/linter-tslint), [Eclipse](https://github.com/palantir/eclipse-tslint), [Emacs](http://flycheck.org), [Sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [Vim](https://github.com/scrooloose/syntastic), [Visual Studio 2015](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.WebAnalyzer), [Visual Studio 2017](https://marketplace.visualstudio.com/items?itemName=RichNewman.TypeScriptAnalyzer), [Visual Studio code](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [WebStorm](https://www.jetbrains.com/webstorm/help/tslint.html) and [more](https://palantir.github.io/tslint/usage/third-party-tools/) +- integration with [MSBuild](https://github.com/joshuakgoldberg/tslint.msbuild), [Grunt](https://github.com/palantir/grunt-tslint), [Gulp](https://github.com/panuhorsmalahti/gulp-tslint), [Atom](https://github.com/AtomLinter/linter-tslint), [Eclipse](https://github.com/palantir/eclipse-tslint), [Emacs](https://www.flycheck.org/), [Sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [Vim](https://github.com/scrooloose/syntastic), [Visual Studio 2015](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.WebAnalyzer), [Visual Studio 2017](https://marketplace.visualstudio.com/items?itemName=RichNewman.TypeScriptAnalyzer), [Visual Studio code](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [WebStorm](https://www.jetbrains.com/webstorm/help/tslint.html) and [more](https://palantir.github.io/tslint/usage/third-party-tools/) ## Installation & Usage diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 3eaa6478c32..de7c3788f57 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - activesupport (4.2.9) + activesupport (4.2.10) i18n (~> 0.7) minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) @@ -13,106 +13,115 @@ GEM execjs coffee-script-source (1.11.1) colorator (1.1.0) - commonmarker (0.17.7.1) + commonmarker (0.17.13) ruby-enum (~> 0.5) - concurrent-ruby (1.0.5) + concurrent-ruby (1.1.3) + dnsruby (1.61.2) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) ethon (0.11.0) ffi (>= 1.3.0) + eventmachine (1.2.7) execjs (2.7.0) - faraday (0.13.1) + faraday (0.15.4) multipart-post (>= 1.2, < 3) - ffi (1.9.18) + ffi (1.9.25) forwardable-extended (2.6.0) gemoji (3.0.0) - github-pages (172) - activesupport (= 4.2.9) - github-pages-health-check (= 1.3.5) - jekyll (= 3.6.2) - jekyll-avatar (= 0.5.0) - jekyll-coffeescript (= 1.0.2) - jekyll-commonmark-ghpages (= 0.1.3) + github-pages (193) + activesupport (= 4.2.10) + github-pages-health-check (= 1.8.1) + jekyll (= 3.7.4) + jekyll-avatar (= 0.6.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.5) jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.9.2) - jekyll-gist (= 1.4.1) - jekyll-github-metadata (= 2.9.3) - jekyll-mentions (= 1.2.0) + jekyll-feed (= 0.11.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.9.4) + jekyll-mentions (= 1.4.1) jekyll-optional-front-matter (= 0.3.0) jekyll-paginate (= 1.1.0) jekyll-readme-index (= 0.2.0) - jekyll-redirect-from (= 0.12.1) - jekyll-relative-links (= 0.5.2) - jekyll-remote-theme (= 0.2.3) - jekyll-sass-converter (= 1.5.0) - jekyll-seo-tag (= 2.3.0) - jekyll-sitemap (= 1.1.1) + jekyll-redirect-from (= 0.14.0) + jekyll-relative-links (= 0.5.3) + jekyll-remote-theme (= 0.3.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.5.0) + jekyll-sitemap (= 1.2.0) jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.0) - jekyll-theme-cayman (= 0.1.0) - jekyll-theme-dinky (= 0.1.0) - jekyll-theme-hacker (= 0.1.0) - jekyll-theme-leap-day (= 0.1.0) - jekyll-theme-merlot (= 0.1.0) - jekyll-theme-midnight (= 0.1.0) - jekyll-theme-minimal (= 0.1.0) - jekyll-theme-modernist (= 0.1.0) - jekyll-theme-primer (= 0.5.2) - jekyll-theme-slate (= 0.1.0) - jekyll-theme-tactile (= 0.1.0) - jekyll-theme-time-machine (= 0.1.0) - jekyll-titles-from-headings (= 0.5.0) - jemoji (= 0.8.1) - kramdown (= 1.14.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.3) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.1) + jemoji (= 0.10.1) + kramdown (= 1.17.0) liquid (= 4.0.0) - listen (= 3.0.6) + listen (= 3.1.5) mercenary (~> 0.3) - minima (= 2.1.1) + minima (= 2.5.0) + nokogiri (>= 1.8.2, < 2.0) rouge (= 2.2.1) terminal-table (~> 1.4) - github-pages-health-check (1.3.5) + github-pages-health-check (1.8.1) addressable (~> 2.3) - net-dns (~> 0.8) + dnsruby (~> 1.60) octokit (~> 4.0) public_suffix (~> 2.0) - typhoeus (~> 0.7) - html-pipeline (2.7.1) + typhoeus (~> 1.3) + html-pipeline (2.9.1) activesupport (>= 2) nokogiri (>= 1.4) - i18n (0.9.1) + http_parser.rb (0.6.0) + i18n (0.9.5) concurrent-ruby (~> 1.0) - jekyll (3.6.2) + jekyll (3.7.4) addressable (~> 2.4) colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) + jekyll-watch (~> 2.0) kramdown (~> 1.14) liquid (~> 4.0) mercenary (~> 0.3.3) pathutil (~> 0.9) - rouge (>= 1.7, < 3) + rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.5.0) + jekyll-avatar (0.6.0) jekyll (~> 3.0) - jekyll-coffeescript (1.0.2) + jekyll-coffeescript (1.1.1) coffee-script (~> 2.2) coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.1.0) + jekyll-commonmark (1.2.0) commonmarker (~> 0.14) jekyll (>= 3.0, < 4.0) - jekyll-commonmark-ghpages (0.1.3) + jekyll-commonmark-ghpages (0.1.5) commonmarker (~> 0.17.6) jekyll-commonmark (~> 1) rouge (~> 2) jekyll-default-layout (0.1.4) jekyll (~> 3.0) - jekyll-feed (0.9.2) + jekyll-feed (0.11.0) jekyll (~> 3.3) - jekyll-gist (1.4.1) + jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.9.3) + jekyll-github-metadata (2.9.4) jekyll (~> 3.1) octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.2.0) - activesupport (~> 4.0) + jekyll-mentions (1.4.1) html-pipeline (~> 2.3) jekyll (~> 3.0) jekyll-optional-front-matter (0.3.0) @@ -120,98 +129,99 @@ GEM jekyll-paginate (1.1.0) jekyll-readme-index (0.2.0) jekyll (~> 3.0) - jekyll-redirect-from (0.12.1) + jekyll-redirect-from (0.14.0) jekyll (~> 3.3) - jekyll-relative-links (0.5.2) + jekyll-relative-links (0.5.3) jekyll (~> 3.3) - jekyll-remote-theme (0.2.3) + jekyll-remote-theme (0.3.1) jekyll (~> 3.5) rubyzip (>= 1.2.1, < 3.0) - typhoeus (>= 0.7, < 2.0) - jekyll-sass-converter (1.5.0) + jekyll-sass-converter (1.5.2) sass (~> 3.4) - jekyll-seo-tag (2.3.0) + jekyll-seo-tag (2.5.0) jekyll (~> 3.3) - jekyll-sitemap (1.1.1) + jekyll-sitemap (1.2.0) jekyll (~> 3.3) jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.0) + jekyll-theme-architect (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.0) + jekyll-theme-cayman (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.0) + jekyll-theme-dinky (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.0) + jekyll-theme-hacker (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.0) + jekyll-theme-leap-day (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.0) + jekyll-theme-merlot (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.0) + jekyll-theme-midnight (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.0) + jekyll-theme-minimal (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.0) + jekyll-theme-modernist (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.2) + jekyll-theme-primer (0.5.3) jekyll (~> 3.5) jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.2) - jekyll-theme-slate (0.1.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.0) + jekyll-theme-tactile (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.0) + jekyll-theme-time-machine (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.0) + jekyll-titles-from-headings (0.5.1) jekyll (~> 3.3) - jekyll-watch (1.5.1) + jekyll-watch (2.1.2) listen (~> 3.0) - jemoji (0.8.1) - activesupport (~> 4.0, >= 4.2.9) + jemoji (0.10.1) gemoji (~> 3.0) html-pipeline (~> 2.2) - jekyll (>= 3.0) - kramdown (1.14.0) + jekyll (~> 3.0) + kramdown (1.17.0) liquid (4.0.0) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) + listen (3.1.5) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + ruby_dep (~> 1.2) mercenary (0.3.6) mini_portile2 (2.3.0) - minima (2.1.1) - jekyll (~> 3.3) - minitest (5.10.3) + minima (2.5.0) + jekyll (~> 3.5) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.11.3) multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.8.1) + nokogiri (1.8.5) mini_portile2 (~> 2.3.0) - octokit (4.8.0) + octokit (4.13.0) sawyer (~> 0.8.0, >= 0.5.3) - pathutil (0.16.1) + pathutil (0.16.2) forwardable-extended (~> 2.6) public_suffix (2.0.5) - rb-fsevent (0.10.2) + rb-fsevent (0.10.3) rb-inotify (0.9.10) ffi (>= 0.5.0, < 2) rouge (2.2.1) - ruby-enum (0.7.1) + ruby-enum (0.7.2) i18n - rubyzip (1.2.1) + ruby_dep (1.5.0) + rubyzip (1.2.2) safe_yaml (1.0.4) - sass (3.5.4) + sass (3.7.2) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) @@ -222,11 +232,11 @@ GEM terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) thread_safe (0.3.6) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.4) + typhoeus (1.3.1) + ethon (>= 0.9.0) + tzinfo (1.2.5) thread_safe (~> 0.1) - unicode-display_width (1.3.0) + unicode-display_width (1.4.0) PLATFORMS ruby diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 5f8dfce81df..e5e2121c862 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -2,7 +2,7 @@
diff --git a/docs/circle.yml b/docs/circle.yml index b462a52ae1a..3d3991852ee 100644 --- a/docs/circle.yml +++ b/docs/circle.yml @@ -1,7 +1,7 @@ machine: ruby: # see available versions here: https://circleci.com/docs/build-image-precise/#ruby - version: 2.2.3 + version: 2.3.7 test: override: - bundle exec jekyll build diff --git a/docs/develop/custom-rules/index.md b/docs/develop/custom-rules/index.md index 5e6166834e3..ca5b1003721 100644 --- a/docs/develop/custom-rules/index.md +++ b/docs/develop/custom-rules/index.md @@ -18,8 +18,8 @@ __Important conventions__: Now, let us first write the rule in TypeScript: ```typescript -import * as ts from "typescript"; import * as Lint from "tslint"; +import * as ts from "typescript"; export class Rule extends Lint.Rules.AbstractRule { public static FAILURE_STRING = "import statement forbidden"; diff --git a/docs/usage/configuration/index.md b/docs/usage/configuration/index.md index 0aa088af90c..39a4679684f 100644 --- a/docs/usage/configuration/index.md +++ b/docs/usage/configuration/index.md @@ -11,29 +11,31 @@ configure which rules get run and each of their options. `tslint.json` or `tslint.yaml` files can have the following fields specified: -* `extends?: string | string[]`: -The name of a built-in configuration preset (see built-in presets below), or a path or -array of paths to other configuration files which are extended by this configuration. -This value is handled using node module resolution semantics. -For example, a value of `"tslint-config"` would tell TSLint to try and load the main file of a module -named "tslint-config" as a configuration file. Specific files inside node modules can also be -specified, eg. `"tslint-config/path/to/submodule"`. Relative paths to JSON files or JS modules -are also supported, e.g. `"./tslint-config"`. -* `rulesDirectory?: string | string[]`: -A path to a directory or an array of paths to directories of [custom rules][2]. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory. We fallback to use relative or absolute paths, if the module can't be resolved. If you want to avoid module resolution you can directly use a relative or absolute path (e.g. with `./`). -* `rules?: { [name: string]: RuleSetting }`: A map of rule names to their configuration settings. - - These rules are applied to `.ts` and `.tsx` files. - - Each rule is associated with an object containing: - - `options?: any`: An array of values that are specific to a rule. - - `severity?: "default" | "error" | "warning" | "off"`: Severity level. Level "error" will cause exit code 2. - - A boolean value may be specified instead of the above object, and is equivalent to setting no options with default severity. - - Any rules specified in this block will override those configured in any base configuration being extended. - - [Check out the full rules list here][3]. -* `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all valid active rules from rules. These rules are applied to `.js` and `.jsx` files. -* `defaultSeverity?: "error" | "warning" | "off"`: The severity level that is applied to rules in this config file as well as rules in any inherited config files which have their severity set to "default". If undefined, "error" is used as the defaultSeverity. -* `linterOptions?: { exclude?: string[] }`: - - `exclude: string[]`: An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in. - - `format: string`: Default [lint formatter][4] +- `extends?: string | string[]`: + The name of a built-in configuration preset (see built-in presets below), or a path or + array of paths to other configuration files which are extended by this configuration. + This value is handled using node module resolution semantics. + For example, a value of `"tslint-config"` would tell TSLint to try and load the main file of a module + named "tslint-config" as a configuration file. Specific files inside node modules can also be + specified, eg. `"tslint-config/path/to/submodule"`. Relative paths to JSON files or JS modules + are also supported, e.g. `"./tslint-config"`. +- `rulesDirectory?: string | string[]`: + A path to a directory or an array of paths to directories of [custom rules][2]. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory. We fallback to use relative or absolute paths, if the module can't be resolved. If you want to avoid module resolution you can directly use a relative or absolute path (e.g. with `./`). +- `rules?: { [name: string]: RuleSetting }`: A map of rule names to their configuration settings. + - These rules are applied to `.ts` and `.tsx` files. + - Each rule is associated with an object containing: + - `options?: any`: An array of values that are specific to a rule. + - `severity?: "default" | "error" | "warning" | "off"`: Severity level. Level "error" will cause exit code 2. + - Legacy: An array may be specified instead of the above object, and is equivalent to setting the rule with the default severity if the first value in the array is `true`, with configuration parameters in the remainder of the array. + - `"no-empty": [true, "allow-empty-catch"]` is strictly equivalent to `"no-empty": { "options": ['allow-empty-catch'], "severity": 'default' }` + - Legacy: A boolean value may be specified instead of the above object, and is equivalent to setting no options with default severity. + - Any rules specified in this block will override those configured in any base configuration being extended. + - [Check out the full rules list here][3]. +- `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all valid active rules from rules. These rules are applied to `.js` and `.jsx` files. +- `defaultSeverity?: "error" | "warning" | "off"`: The severity level that is applied to rules in this config file as well as rules in any inherited config files which have their severity set to "default". If undefined, "error" is used as the defaultSeverity. +- `linterOptions?: { exclude?: string[] }`: + - `exclude: string[]`: An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in. + - `format: string`: Default [lint formatter][4] `tslint.json` configuration files may have JavaScript-style `// single-line` and `/* multi-line */` comments in them (even though this is technically invalid JSON). If this confuses your syntax highlighter, you may want to switch it to JavaScript format. @@ -54,14 +56,7 @@ An example `tslint.json` file might look like this: "no-consecutive-blank-lines": false, "no-console": { "severity": "warning", - "options": [ - "debug", - "info", - "log", - "time", - "timeEnd", - "trace" - ] + "options": ["debug", "info", "log", "time", "timeEnd", "trace"] } }, "jsRules": { @@ -111,11 +106,11 @@ The severity level of each rule can be configured to `default`, `error`, `warnin TSLint ships with a handful of built-in configurations presets. You may inspect their source [here](https://github.com/palantir/tslint/tree/master/src/configs). -__`tslint:recommended`__ is a stable, somewhat opinionated set of rules which we encourage for general TypeScript programming. This configuration follows semver, so it will _not_ have breaking changes across minor or patch releases. +**`tslint:recommended`** is a stable, somewhat opinionated set of rules which we encourage for general TypeScript programming. This configuration follows semver, so it will _not_ have breaking changes across minor or patch releases. -__`tslint:latest`__ extends `tslint:recommended` and is continuously updated to include configuration for the latest rules in every TSLint release. Using this config may introduce breaking changes across minor releases as new rules are enabled which cause lint failures in your code. When TSLint reaches a major version bump, `tslint:recommended` will be updated to be identical to `tslint:latest`. +**`tslint:latest`** extends `tslint:recommended` and is continuously updated to include configuration for the latest rules in every TSLint release. Using this config may introduce breaking changes across minor releases as new rules are enabled which cause lint failures in your code. When TSLint reaches a major version bump, `tslint:recommended` will be updated to be identical to `tslint:latest`. -__`tslint:all`__ turns on all rules to their strictest settings. This will use type checking, so it must be combined with the `--project` option. +**`tslint:all`** turns on all rules to their strictest settings. This will use type checking, so it must be combined with the `--project` option. (Exceptions include rules such as [`"ban"`][rule-ban], [`"import-blacklist"`][rule-import-blacklist], and [`"file-header"`][rule-file-header], which have no sensible defaults, and deprecated rules.) ### Custom rules diff --git a/docs/usage/third-party-tools/index.md b/docs/usage/third-party-tools/index.md index c54c96d5616..0cacbdc2fe8 100644 --- a/docs/usage/third-party-tools/index.md +++ b/docs/usage/third-party-tools/index.md @@ -20,6 +20,8 @@ _Note: Most of these tools are not maintained by TSLint._ * [tslint.tmbundle][17] ([TextMate][18]) * [generator-tslint][19] * [Flycheck][20] ([Emacs][21]) +* [tslint-brunch][22] ([Brunch][23]) +* [Gitpod][24] [0]: https://github.com/palantir/grunt-tslint @@ -36,7 +38,7 @@ _Note: Most of these tools are not maintained by TSLint._ [11]: http://www.vim.org/ [12]: https://visualstudiogallery.msdn.microsoft.com/6edc26d4-47d8-4987-82ee-7c820d79be1d [13]: https://www.visualstudio.com/ -[14]: https://www.jetbrains.com/help/webstorm/2016.1/tslint.html +[14]: https://www.jetbrains.com/help/webstorm/tslint.html [15]: https://github.com/t-sauer/mocha-tslint [16]: https://mochajs.org/ [17]: https://github.com/natesilva/tslint.tmbundle @@ -44,3 +46,6 @@ _Note: Most of these tools are not maintained by TSLint._ [19]: https://github.com/greybax/generator-tslint [20]: http://www.flycheck.org/ [21]: https://www.gnu.org/software/emacs/ +[22]: https://www.npmjs.com/package/tslint-brunch +[23]: https://brunch.io/ +[24]: https://gitpod.io diff --git a/package.json b/package.json index 65b29cf2f81..e2cab5c8bc2 100644 --- a/package.json +++ b/package.json @@ -1,22 +1,12 @@ { "name": "tslint", - "version": "5.11.0", + "version": "5.12.1", "description": "An extensible static analysis linter for the TypeScript language", "bin": { "tslint": "./bin/tslint" }, "main": "./lib/index.js", "typings": "./lib/index.d.ts", - "repository": { - "type": "git", - "url": "https://github.com/palantir/tslint.git" - }, - "keywords": [ - "cli", - "typescript", - "linter" - ], - "homepage": "https://palantir.github.io/tslint", "scripts": { "clean": "npm-run-all -p clean:core clean:test", "clean:core": "rimraf lib", @@ -27,11 +17,8 @@ "compile:scripts": "tsc -p scripts", "compile:test": "tsc -p test", "lint": "npm-run-all -p lint:global lint:from-bin", - "lint:global": "tslint --project test/tsconfig.json --format stylish", - "lint:from-bin": "node bin/tslint --project test/tsconfig.json --format stylish", - "precommit": "npm-run-all precommit:prettier", - "precommit:prettier": "pretty-quick --staged", - "prettier": "prettier --write './**/*.{js,ts,css,scss,md,yml}' --ignore-path ./.prettierignore", + "lint:global": "tslint --project test/tsconfig.json --format codeFrame", + "lint:from-bin": "node bin/tslint --project test/tsconfig.json --format codeFrame", "publish:local": "./scripts/npmPublish.sh", "test": "npm-run-all test:pre -p test:mocha test:rules", "test:pre": "cd ./test/config && npm install --no-save", @@ -55,7 +42,7 @@ "tsutils": "^2.27.2" }, "peerDependencies": { - "typescript": ">=2.1.0 || >=2.1.0-dev || >=2.2.0-dev || >=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev" + "typescript": ">=2.1.0 || >=2.1.0-dev || >=2.2.0-dev || >=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev || >=3.0.0-dev || >= 3.1.0-dev || >= 3.2.0-dev" }, "devDependencies": { "@types/babel-code-frame": "^6.20.0", @@ -72,21 +59,31 @@ "chai": "^3.5.0", "github": "^8.2.1", "husky": "^0.14.3", - "json-stringify-pretty-compact": "^1.0.3", + "json-stringify-pretty-compact": "^1.2.0", "mocha": "^3.2.0", "npm-run-all": "^4.0.2", "nyc": "^10.2.0", "prettier": "1.14.3", - "pretty-quick": "^1.6.0", "rimraf": "^2.5.4", "ts-node": "^3.3.0", - "tslint": "^5.8.0", - "tslint-config-prettier": "^1.13.0", + "tslint": "~5.12.0", + "tslint-config-prettier": "^1.15.0", + "tslint-plugin-prettier": "^2.0.1", "tslint-test-config-non-relative": "file:test/external/tslint-test-config-non-relative", - "typescript": "~2.9.2" + "typescript": "~3.1.6" }, - "license": "Apache-2.0", "engines": { "node": ">=4.8.0" - } + }, + "homepage": "https://palantir.github.io/tslint", + "repository": { + "type": "git", + "url": "https://github.com/palantir/tslint.git" + }, + "keywords": [ + "cli", + "typescript", + "linter" + ], + "license": "Apache-2.0" } diff --git a/scripts/buildDocs.ts b/scripts/buildDocs.ts index d944a01b05b..f34b2765877 100644 --- a/scripts/buildDocs.ts +++ b/scripts/buildDocs.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 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. diff --git a/scripts/custom-typings.d.ts b/scripts/custom-typings.d.ts deleted file mode 100644 index 65044950213..00000000000 --- a/scripts/custom-typings.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -declare module "json-stringify-pretty-compact" { - function stringify(x: any): string; - export = stringify; -} diff --git a/src/configs/all.ts b/src/configs/all.ts index f61d9cb6d6a..a5658c6382c 100644 --- a/src/configs/all.ts +++ b/src/configs/all.ts @@ -40,19 +40,20 @@ export const rules = { ], }, "ban-ts-ignore": true, - "member-access": [true, "check-accessor", "check-constructor", "check-parameter-property"], - "member-ordering": [ - true, - { + "member-access": { + options: ["check-accessor", "check-constructor", "check-parameter-property"], + }, + "member-ordering": { + options: { order: "statics-first", alphabetize: true, }, - ], + }, "no-any": true, "no-empty-interface": true, "no-import-side-effect": true, // Technically this is not the strictest setting, but don't want to conflict with "typedef" - "no-inferrable-types": [true, "ignore-params"], + "no-inferrable-types": { options: ["ignore-params"] }, "no-internal-module": true, "no-magic-numbers": true, "no-namespace": true, @@ -64,33 +65,35 @@ export const rules = { "prefer-for-of": true, "prefer-readonly": true, "promise-function-async": true, - typedef: [ - true, - "call-signature", - "arrow-call-signature", - "parameter", - "arrow-parameter", - "property-declaration", - "variable-declaration", - "member-variable-declaration", - ], - "typedef-whitespace": [ - true, - { - "call-signature": "nospace", - "index-signature": "nospace", - parameter: "nospace", - "property-declaration": "nospace", - "variable-declaration": "nospace", - }, - { - "call-signature": "onespace", - "index-signature": "onespace", - parameter: "onespace", - "property-declaration": "onespace", - "variable-declaration": "onespace", - }, - ], + typedef: { + options: [ + "call-signature", + "arrow-call-signature", + "parameter", + "arrow-parameter", + "property-declaration", + "variable-declaration", + "member-variable-declaration", + ], + }, + "typedef-whitespace": { + options: [ + { + "call-signature": "nospace", + "index-signature": "nospace", + parameter: "nospace", + "property-declaration": "nospace", + "variable-declaration": "nospace", + }, + { + "call-signature": "onespace", + "index-signature": "onespace", + parameter: "onespace", + "property-declaration": "onespace", + "variable-declaration": "onespace", + }, + ], + }, "unified-signatures": true, // Functionality @@ -99,6 +102,7 @@ export const rules = { "ban-comma-operator": true, curly: true, forin: true, + "function-constructor": true, // "import-blacklist": no sensible default "label-position": true, "no-arg": true, @@ -109,7 +113,7 @@ export const rules = { "no-debugger": true, "no-duplicate-super": true, "no-duplicate-switch-case": true, - "no-duplicate-variable": [true, "check-parameters"], + "no-duplicate-variable": { options: ["check-parameters"] }, "no-dynamic-delete": true, "no-empty": true, "no-eval": true, @@ -129,7 +133,7 @@ export const rules = { "no-sparse-arrays": true, "no-submodule-imports": true, "no-unbound-method": true, - "no-unnecessary-class": [true, "allow-empty-class"], + "no-unnecessary-class": { options: ["allow-empty-class"] }, "no-unsafe-any": true, "no-unsafe-finally": true, "no-unused-expression": true, @@ -144,6 +148,7 @@ export const rules = { "strict-type-predicates": true, "switch-default": true, "triple-equals": true, + "unnecessary-constructor": true, "use-default-type-parameter": true, "use-isnan": true, @@ -151,12 +156,15 @@ export const rules = { "cyclomatic-complexity": true, eofline: true, - indent: [true, "spaces"], - "linebreak-style": [true, "LF"], - "max-classes-per-file": [true, 1], - "max-file-line-count": [true, 1000], - "max-line-length": [true, 120], + indent: { options: ["spaces"] }, + "linebreak-style": { options: "LF" }, + "max-classes-per-file": { options: 1 }, + "max-file-line-count": { options: 1000 }, + "max-line-length": { + options: { limit: 120 }, + }, "no-default-export": true, + "no-default-import": true, "no-duplicate-imports": true, "no-irregular-whitespace": true, "no-mergeable-namespace": true, @@ -165,36 +173,36 @@ export const rules = { "no-trailing-whitespace": true, "object-literal-sort-keys": true, "prefer-const": true, - "trailing-comma": [ - true, - { + "trailing-comma": { + options: { esSpecCompliant: true, multiline: "always", singleline: "never", }, - ], + }, // Style - align: [true, "parameters", "arguments", "statements", "elements", "members"], - "array-type": [true, "array-simple"], + align: { + options: ["parameters", "arguments", "statements", "elements", "members"], + }, + "array-type": { options: "array-simple" }, "arrow-parens": true, - "arrow-return-shorthand": [true, "multiline"], + "arrow-return-shorthand": { options: "multiline" }, "binary-expression-operand-order": true, "callable-types": true, "class-name": true, - "comment-format": [true, "check-space", "check-uppercase"], - "comment-type": [true, "singleline", "multiline", "doc", "directive"], + "comment-format": { options: ["check-space", "check-uppercase"] }, + "comment-type": { options: ["singleline", "multiline", "doc", "directive"] }, "completed-docs": true, - // "file-header": No sensible default deprecation: true, encoding: true, - "file-name-casing": [true, "camel-case"], + "file-name-casing": { options: "camel-case" }, "import-spacing": true, "increment-decrement": true, "interface-name": true, "interface-over-type-literal": true, - "jsdoc-format": [true, "check-multiline-start"], + "jsdoc-format": { options: "check-multiline-start" }, "match-default-export-name": true, "new-parens": true, "newline-before-return": true, @@ -210,61 +218,65 @@ export const rules = { "no-unnecessary-qualifier": true, "no-unnecessary-type-assertion": true, "number-literal-format": true, - "object-literal-key-quotes": [true, "consistent-as-needed"], + "object-literal-key-quotes": { options: "consistent-as-needed" }, "object-literal-shorthand": true, - "one-line": [ - true, - "check-catch", - "check-else", - "check-finally", - "check-open-brace", - "check-whitespace", - ], + "one-line": { + options: [ + "check-catch", + "check-else", + "check-finally", + "check-open-brace", + "check-whitespace", + ], + }, "one-variable-per-declaration": true, - "ordered-imports": [ - true, - { + "ordered-imports": { + options: { + "grouped-imports": true, "import-sources-order": "case-insensitive", "named-imports-order": "case-insensitive", "module-source-path": "full", }, - ], + }, "prefer-function-over-method": true, "prefer-method-signature": true, "prefer-object-spread": true, "prefer-switch": true, "prefer-template": true, "prefer-while": true, - quotemark: [true, "double", "avoid-escape", "avoid-template"], + quotemark: { + options: ["double", "avoid-escape", "avoid-template"], + }, "return-undefined": true, - semicolon: [true, "always"], - "space-before-function-paren": [ - true, - { + semicolon: { options: ["always"] }, + "space-before-function-paren": { + options: { anonymous: "never", asyncArrow: "always", constructor: "never", method: "never", named: "never", }, - ], - "space-within-parens": [true, 0], + }, + "space-within-parens": { options: 0 }, "switch-final-break": true, "type-literal-delimiter": true, - "variable-name": [true, "ban-keywords", "check-format"], - whitespace: [ - true, - "check-branch", - "check-decl", - "check-operator", - "check-module", - "check-separator", - "check-type", - "check-typecast", - "check-preblock", - "check-type-operator", - "check-rest-spread", - ], + "unnecessary-bind": true, + "variable-name": { options: ["ban-keywords", "check-format"] }, + whitespace: { + options: [ + "check-branch", + "check-decl", + "check-operator", + "check-module", + "check-separator", + "check-type", + "check-typecast", + "check-preblock", + "check-type-operator", + "check-rest-spread", + ], + }, }; export const RULES_EXCLUDED_FROM_ALL_CONFIG = [ diff --git a/src/configs/latest.ts b/src/configs/latest.ts index 341334ddf38..eae3fa67fb0 100644 --- a/src/configs/latest.ts +++ b/src/configs/latest.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -33,14 +33,14 @@ export const rules = { "prefer-object-spread": true, // added in v5.4 - "no-duplicate-variable": [true, "check-parameters"], + "no-duplicate-variable": { options: "check-parameters" }, // added in v5.5 "no-this-assignment": true, // added in v5.6 "no-duplicate-imports": true, - "space-within-parens": [true, 0], + "space-within-parens": { options: 0 }, "no-submodule-imports": true, // added in v5.7 @@ -59,12 +59,14 @@ export const rules = { // added in v5.8 "ban-comma-operator": true, - "jsdoc-format": { - options: "check-multiline-start", - }, + "jsdoc-format": { options: "check-multiline-start" }, "no-duplicate-switch-case": true, "no-implicit-dependencies": true, "no-return-await": true, + + // added in v5.12 + "function-constructor": true, + "unnecessary-bind": true, }; // tslint:enable object-literal-sort-keys diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts index b9e81ec6fd4..a692d17e862 100644 --- a/src/configs/recommended.ts +++ b/src/configs/recommended.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -57,12 +57,8 @@ export const rules = { "interface-over-type-literal": true, "jsdoc-format": true, "label-position": true, - "max-classes-per-file": { - options: [1], - }, - "max-line-length": { - options: [120], - }, + "max-classes-per-file": { options: 1 }, + "max-line-length": { options: 120 }, "member-access": true, "member-ordering": { options: { @@ -98,13 +94,10 @@ export const rules = { "no-unnecessary-initializer": true, "no-unsafe-finally": true, "no-unused-expression": true, - // disable this rule as it is very heavy performance-wise and not that useful - "no-use-before-declare": false, + "no-use-before-declare": false, // disabled because it is very heavy performance-wise and not that useful "no-var-keyword": true, "no-var-requires": true, - "object-literal-key-quotes": { - options: ["consistent-as-needed"], - }, + "object-literal-key-quotes": { options: "consistent-as-needed" }, "object-literal-shorthand": true, "object-literal-sort-keys": true, "one-line": { @@ -116,9 +109,7 @@ export const rules = { "check-whitespace", ], }, - "one-variable-per-declaration": { - options: ["ignore-for-loop"], - }, + "one-variable-per-declaration": { options: ["ignore-for-loop"] }, "only-arrow-functions": { options: ["allow-declarations", "allow-named-functions"], }, @@ -135,9 +126,7 @@ export const rules = { options: ["double", "avoid-escape"], }, radix: true, - semicolon: { - options: ["always"], - }, + semicolon: { options: ["always"] }, "space-before-function-paren": { options: { anonymous: "never", @@ -154,9 +143,7 @@ export const rules = { singleline: "never", }, }, - "triple-equals": { - options: ["allow-null-check"], - }, + "triple-equals": { options: ["allow-null-check"] }, typedef: false, "typedef-whitespace": { options: [ @@ -241,16 +228,12 @@ export const jsRules = { "check-whitespace", ], }, - "one-variable-per-declaration": { - options: ["ignore-for-loop"], - }, + "one-variable-per-declaration": { options: ["ignore-for-loop"] }, quotemark: { options: ["double", "avoid-escape"], }, radix: true, - semicolon: { - options: ["always"], - }, + semicolon: { options: ["always"] }, "space-before-function-paren": { options: { anonymous: "never", @@ -266,9 +249,7 @@ export const jsRules = { singleline: "never", }, }, - "triple-equals": { - options: ["allow-null-check"], - }, + "triple-equals": { options: ["allow-null-check"] }, "use-isnan": true, "variable-name": { options: ["ban-keywords", "check-format", "allow-pascal-case"], diff --git a/src/configuration.ts b/src/configuration.ts index 457de0f4556..fcb32b0db31 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -20,8 +20,8 @@ import * as yaml from "js-yaml"; import { Minimatch } from "minimatch"; import * as os from "os"; import * as path from "path"; -import { FatalError, showWarningOnce } from "./error"; +import { FatalError, showWarningOnce } from "./error"; import { IOptions, RuleSeverity } from "./language/rule/rule"; import { findRule } from "./ruleLoader"; import { arrayify, hasOwnProperty, stripComments, tryResolvePackage } from "./utils"; diff --git a/src/enableDisableRules.ts b/src/enableDisableRules.ts index 7b30ca2ae66..fd25aef0b2e 100644 --- a/src/enableDisableRules.ts +++ b/src/enableDisableRules.ts @@ -19,6 +19,7 @@ import * as utils from "tsutils"; import * as ts from "typescript"; + import { RuleFailure } from "./language/rule/rule"; /** diff --git a/src/error.ts b/src/error.ts index 3b120bec45f..0054f9f24ab 100644 --- a/src/error.ts +++ b/src/error.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. diff --git a/src/formatterLoader.ts b/src/formatterLoader.ts index 9bf85c907ec..951b145ddda 100644 --- a/src/formatterLoader.ts +++ b/src/formatterLoader.ts @@ -17,6 +17,7 @@ import * as fs from "fs"; import * as path from "path"; + import { FormatterConstructor } from "./index"; import { camelize, tryResolvePackage } from "./utils"; diff --git a/src/formatters/checkstyleFormatter.ts b/src/formatters/checkstyleFormatter.ts index 260cc20fee3..36c224fc970 100644 --- a/src/formatters/checkstyleFormatter.ts +++ b/src/formatters/checkstyleFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/codeFrameFormatter.ts b/src/formatters/codeFrameFormatter.ts index 4f5d423fb5c..e1f490a873a 100644 --- a/src/formatters/codeFrameFormatter.ts +++ b/src/formatters/codeFrameFormatter.ts @@ -15,13 +15,12 @@ * limitations under the License. */ -import { AbstractFormatter } from "../language/formatter/abstractFormatter"; -import { IFormatterMetadata } from "../language/formatter/formatter"; -import { RuleFailure } from "../language/rule/rule"; - import codeFrame = require("babel-code-frame"); import chalk from "chalk"; +import { AbstractFormatter } from "../language/formatter/abstractFormatter"; +import { IFormatterMetadata } from "../language/formatter/formatter"; +import { RuleFailure } from "../language/rule/rule"; import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/jsonFormatter.ts b/src/formatters/jsonFormatter.ts index 74715c775df..e259ccdf545 100644 --- a/src/formatters/jsonFormatter.ts +++ b/src/formatters/jsonFormatter.ts @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/junitFormatter.ts b/src/formatters/junitFormatter.ts index 4f3b5151839..b0ccf13b663 100644 --- a/src/formatters/junitFormatter.ts +++ b/src/formatters/junitFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { @@ -32,8 +31,8 @@ export class Formatter extends AbstractFormatter { - - Missing semicolon + + Missing semicolon Line 1, Column 14 @@ -64,9 +63,12 @@ export class Formatter extends AbstractFormatter { output += ``; } - output += ``; - output += `${message}`; + output += ``; + output += `${message} `; + output += `Line ${lineAndCharacter.line + 1}, `; + output += `Column ${lineAndCharacter.character + 1}`; + output += ``; output += ""; } if (previousFilename !== null) { diff --git a/src/formatters/msbuildFormatter.ts b/src/formatters/msbuildFormatter.ts index 2fea7a1a2f5..b5811b42eb5 100644 --- a/src/formatters/msbuildFormatter.ts +++ b/src/formatters/msbuildFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. diff --git a/src/formatters/pmdFormatter.ts b/src/formatters/pmdFormatter.ts index 9d6f61dab5d..ee9f961830f 100644 --- a/src/formatters/pmdFormatter.ts +++ b/src/formatters/pmdFormatter.ts @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/stylishFormatter.ts b/src/formatters/stylishFormatter.ts index c323b5b3ac4..7b35ebd19eb 100644 --- a/src/formatters/stylishFormatter.ts +++ b/src/formatters/stylishFormatter.ts @@ -15,12 +15,11 @@ * limitations under the License. */ +import chalk from "chalk"; + import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - -import chalk from "chalk"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/tapFormatter.ts b/src/formatters/tapFormatter.ts index e1ef5b8874d..e588562c6d9 100644 --- a/src/formatters/tapFormatter.ts +++ b/src/formatters/tapFormatter.ts @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/formatters/vsoFormatter.ts b/src/formatters/vsoFormatter.ts index 82fc633d255..f9ab02aca2e 100644 --- a/src/formatters/vsoFormatter.ts +++ b/src/formatters/vsoFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -18,7 +18,6 @@ import { AbstractFormatter } from "../language/formatter/abstractFormatter"; import { IFormatterMetadata } from "../language/formatter/formatter"; import { RuleFailure } from "../language/rule/rule"; - import * as Utils from "../utils"; export class Formatter extends AbstractFormatter { diff --git a/src/language/formatter/abstractFormatter.ts b/src/language/formatter/abstractFormatter.ts index d9de37a7c46..28b262714fb 100644 --- a/src/language/formatter/abstractFormatter.ts +++ b/src/language/formatter/abstractFormatter.ts @@ -16,6 +16,7 @@ */ import { RuleFailure } from "../rule/rule"; + import { IFormatter, IFormatterMetadata } from "./formatter"; export abstract class AbstractFormatter implements IFormatter { diff --git a/src/language/formatter/formatter.ts b/src/language/formatter/formatter.ts index 24a0fde1ddf..a13a92cd2fa 100644 --- a/src/language/formatter/formatter.ts +++ b/src/language/formatter/formatter.ts @@ -46,7 +46,12 @@ export interface IFormatterMetadata { export type ConsumerType = "human" | "machine"; +// See https://github.com/palantir/tslint/issues/4364 +// TODO: Enable the `callable-types` rule below. Currently, it +// produces a lint error in several locations complaining about the +// `no-inferred-empty-object-type` rule. export interface FormatterConstructor { + // tslint:disable-next-line:callable-types new (): IFormatter; } diff --git a/src/language/rule/abstractRule.ts b/src/language/rule/abstractRule.ts index c44590d23e6..a8e96e5acd6 100644 --- a/src/language/rule/abstractRule.ts +++ b/src/language/rule/abstractRule.ts @@ -18,15 +18,16 @@ import * as ts from "typescript"; import { IWalker, WalkContext } from "../walker"; + import { IOptions, IRule, IRuleMetadata, RuleFailure, RuleSeverity } from "./rule"; export type NoInfer = T & { [K in keyof T]: T[K] }; export abstract class AbstractRule implements IRule { public static metadata: IRuleMetadata; + public ruleName: string; protected readonly ruleArguments: any[]; protected readonly ruleSeverity: RuleSeverity; - public ruleName: string; constructor(private readonly options: IOptions) { this.ruleName = options.ruleName; diff --git a/src/language/rule/rule.ts b/src/language/rule/rule.ts index f6af7d113e7..960bdb774ca 100644 --- a/src/language/rule/rule.ts +++ b/src/language/rule/rule.ts @@ -262,12 +262,6 @@ export type Fix = Replacement | Replacement[]; export type FixJson = ReplacementJson | ReplacementJson[]; export class RuleFailure { - private readonly fileName: string; - private readonly startPosition: RuleFailurePosition; - private readonly endPosition: RuleFailurePosition; - private readonly rawLines: string; - private ruleSeverity: RuleSeverity; - public static compare(a: RuleFailure, b: RuleFailure): number { if (a.fileName !== b.fileName) { return a.fileName < b.fileName ? -1 : 1; @@ -275,6 +269,12 @@ export class RuleFailure { return a.startPosition.getPosition() - b.startPosition.getPosition(); } + private readonly fileName: string; + private readonly startPosition: RuleFailurePosition; + private readonly endPosition: RuleFailurePosition; + private readonly rawLines: string; + private ruleSeverity: RuleSeverity; + constructor( private readonly sourceFile: ts.SourceFile, start: number, diff --git a/src/language/rule/typedRule.ts b/src/language/rule/typedRule.ts index 289987424ff..ab3fcb3197c 100644 --- a/src/language/rule/typedRule.ts +++ b/src/language/rule/typedRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -18,6 +18,7 @@ import * as ts from "typescript"; import { showWarningOnce } from "../../error"; + import { AbstractRule } from "./abstractRule"; import { ITypedRule, RuleFailure } from "./rule"; diff --git a/src/language/utils.ts b/src/language/utils.ts index 71fe23c91da..9160d82b508 100644 --- a/src/language/utils.ts +++ b/src/language/utils.ts @@ -74,7 +74,7 @@ export function isBlockScopedVariable( node: ts.VariableDeclaration | ts.VariableStatement, ): boolean { if (node.kind === ts.SyntaxKind.VariableDeclaration) { - const parent = node.parent!; + const parent = node.parent; return ( parent.kind === ts.SyntaxKind.CatchClause || isBlockScopedVariableDeclarationList(parent) @@ -95,7 +95,7 @@ export function isBlockScopedBindingElement(node: ts.BindingElement): boolean { export function getBindingElementVariableDeclaration( node: ts.BindingElement, ): ts.VariableDeclaration | null { - let currentParent = node.parent! as ts.Node; + let currentParent = node.parent as ts.Node; while (currentParent.kind !== ts.SyntaxKind.VariableDeclaration) { if (currentParent.parent === undefined) { return null; // function parameter, no variable declaration @@ -177,7 +177,10 @@ export function isCombinedNodeFlagSet(node: ts.Node, flagToCheck: ts.NodeFlags): * * @deprecated no longer used */ -export function isCombinedModifierFlagSet(node: ts.Node, flagToCheck: ts.ModifierFlags): boolean { +export function isCombinedModifierFlagSet( + node: ts.Declaration, + flagToCheck: ts.ModifierFlags, +): boolean { // tslint:disable-next-line:no-bitwise return (ts.getCombinedModifierFlags(node) & flagToCheck) !== 0; } @@ -378,7 +381,7 @@ export function forEachToken( fullText, token.kind, { tokenStart, fullStart: token.pos, end: token.end }, - token.parent!, + token.parent, ); } } @@ -396,7 +399,7 @@ function createTriviaHandler(sourceFile: ts.SourceFile, cb: ForEachTokenCallback * This includes trailing trivia of the last token and the leading trivia of the current token */ function handleTrivia(start: number, end: number, token: ts.Node) { - const parent = token.parent!; + const parent = token.parent; // prevent false positives by not scanning inside JsxText if (!canHaveLeadingTrivia(token.kind, parent)) { return; @@ -471,7 +474,7 @@ function canHaveLeadingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boolea // before a JsxExpression inside a JsxElement's body can only be other JsxChild, but no trivia return ( parent.kind !== ts.SyntaxKind.JsxExpression || - parent.parent!.kind !== ts.SyntaxKind.JsxElement + parent.parent.kind !== ts.SyntaxKind.JsxElement ); case ts.SyntaxKind.LessThanToken: @@ -481,7 +484,7 @@ function canHaveLeadingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boolea case ts.SyntaxKind.JsxOpeningElement: case ts.SyntaxKind.JsxSelfClosingElement: // there can only be leading trivia if we are at the end of the top level element - return parent.parent!.parent!.kind !== ts.SyntaxKind.JsxElement; + return parent.parent.parent.kind !== ts.SyntaxKind.JsxElement; default: return true; } @@ -502,7 +505,7 @@ function canHaveTrailingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boole // after a JsxExpression inside a JsxElement's body can only be other JsxChild, but no trivia return ( parent.kind !== ts.SyntaxKind.JsxExpression || - parent.parent!.kind !== ts.SyntaxKind.JsxElement + parent.parent.kind !== ts.SyntaxKind.JsxElement ); case ts.SyntaxKind.GreaterThanToken: @@ -512,7 +515,7 @@ function canHaveTrailingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boole case ts.SyntaxKind.JsxClosingElement: case ts.SyntaxKind.JsxSelfClosingElement: // there can only be trailing trivia if we are at the end of the top level element - return parent.parent!.parent!.kind !== ts.SyntaxKind.JsxElement; + return parent.parent.parent.kind !== ts.SyntaxKind.JsxElement; default: return true; diff --git a/src/language/walker/blockScopeAwareRuleWalker.ts b/src/language/walker/blockScopeAwareRuleWalker.ts index dd03e30a5ec..34e2ee9c827 100644 --- a/src/language/walker/blockScopeAwareRuleWalker.ts +++ b/src/language/walker/blockScopeAwareRuleWalker.ts @@ -19,6 +19,7 @@ import * as ts from "typescript"; import { IOptions } from "../rule/rule"; import { isBlockScopeBoundary } from "../utils"; + import { ScopeAwareRuleWalker } from "./scopeAwareRuleWalker"; // tslint:disable:deprecation (extends deprecated class and uses deprecated utils - doesn't matter because it's deprecated, too) diff --git a/src/language/walker/programAwareRuleWalker.ts b/src/language/walker/programAwareRuleWalker.ts index c5934102257..2e2342c1ef5 100644 --- a/src/language/walker/programAwareRuleWalker.ts +++ b/src/language/walker/programAwareRuleWalker.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -18,6 +18,7 @@ import * as ts from "typescript"; import { IOptions } from "../rule/rule"; + import { RuleWalker } from "./ruleWalker"; export class ProgramAwareRuleWalker extends RuleWalker { diff --git a/src/language/walker/ruleWalker.ts b/src/language/walker/ruleWalker.ts index 3e3b95347a0..90685899da2 100644 --- a/src/language/walker/ruleWalker.ts +++ b/src/language/walker/ruleWalker.ts @@ -18,6 +18,7 @@ import * as ts from "typescript"; import { Fix, IOptions, Replacement, RuleFailure } from "../rule/rule"; + import { SyntaxWalker } from "./syntaxWalker"; import { IWalker } from "./walker"; diff --git a/src/language/walker/scopeAwareRuleWalker.ts b/src/language/walker/scopeAwareRuleWalker.ts index 48d8b325d5a..27c17e91ecf 100644 --- a/src/language/walker/scopeAwareRuleWalker.ts +++ b/src/language/walker/scopeAwareRuleWalker.ts @@ -19,6 +19,7 @@ import * as ts from "typescript"; import { IOptions } from "../rule/rule"; import { isScopeBoundary } from "../utils"; + import { RuleWalker } from "./ruleWalker"; /** diff --git a/src/language/walker/walker.ts b/src/language/walker/walker.ts index e25d16fb741..1b1b3b97693 100644 --- a/src/language/walker/walker.ts +++ b/src/language/walker/walker.ts @@ -18,6 +18,7 @@ import * as ts from "typescript"; import { RuleFailure } from "../rule/rule"; + import { WalkContext } from "./walkContext"; export interface IWalker { diff --git a/src/linter.ts b/src/linter.ts index e836dae216a..42d5b8e00f6 100644 --- a/src/linter.ts +++ b/src/linter.ts @@ -30,7 +30,7 @@ import { loadConfigurationFromPath, } from "./configuration"; import { removeDisabledFailures } from "./enableDisableRules"; -import { FatalError, isError, showRuleCrashWarning } from "./error"; +import { FatalError, isError, showRuleCrashWarning, showWarningOnce } from "./error"; import { findFormatter } from "./formatterLoader"; import { ILinterOptions, LintResult } from "./index"; import { IRule, isTypedRule, Replacement, RuleFailure, RuleSeverity } from "./language/rule/rule"; @@ -42,16 +42,13 @@ import { arrayify, dedent, flatMap, mapDefined } from "./utils"; * Linter that can lint multiple files in consecutive runs. */ export class Linter { - public static VERSION = "5.11.0"; + public static VERSION = "5.12.1"; public static findConfiguration = findConfiguration; public static findConfigurationPath = findConfigurationPath; public static getRulesDirectories = getRulesDirectories; public static loadConfigurationFromPath = loadConfigurationFromPath; - private failures: RuleFailure[] = []; - private fixes: RuleFailure[] = []; - /** * Creates a TypeScript program object from a tsconfig.json file path and optional project directory. */ @@ -104,18 +101,24 @@ export class Linter { /** * Returns a list of source file names from a TypeScript program. This includes all referenced - * files and excludes declaration (".d.ts") files. + * files and excludes declaration (".d.ts") files, as well as JSON files, to avoid problems with + * `resolveJsonModule`. */ public static getFileNames(program: ts.Program): string[] { return mapDefined( program.getSourceFiles(), file => - file.fileName.endsWith(".d.ts") || program.isSourceFileFromExternalLibrary(file) + file.fileName.endsWith(".d.ts") || + file.fileName.endsWith(".json") || + program.isSourceFileFromExternalLibrary(file) ? undefined : file.fileName, ); } + private failures: RuleFailure[] = []; + private fixes: RuleFailure[] = []; + constructor(private readonly options: ILinterOptions, private program?: ts.Program) { if (typeof options !== "object") { throw new Error(`Unknown Linter options type: ${typeof options}`); @@ -139,6 +142,11 @@ export class Linter { const sourceFile = this.getSourceFile(fileName, source); const isJs = /\.jsx?$/i.test(fileName); const enabledRules = this.getEnabledRules(configuration, isJs); + if (enabledRules.length === 0) { + showWarningOnce( + `Tried to lint ${fileName} but found no valid, enabled rules for this file type and file path in the resolved configuration.`, + ); + } let fileFailures = this.getAllFailures(sourceFile, enabledRules); if (fileFailures.length === 0) { diff --git a/src/ruleLoader.ts b/src/ruleLoader.ts index 92ae0ce69dc..b4aa0803d8d 100644 --- a/src/ruleLoader.ts +++ b/src/ruleLoader.ts @@ -79,10 +79,7 @@ export function loadRules( showWarningOnce(warning); } - if (rules.length === 0) { - const fileType = isJs ? "JavaScript" : "TypeScript"; - showWarningOnce(`No valid rules have been specified for ${fileType} files`); - } + return rules; } diff --git a/src/rules/arrayTypeRule.ts b/src/rules/arrayTypeRule.ts index cbf525555a1..dcc7dfa06f6 100644 --- a/src/rules/arrayTypeRule.ts +++ b/src/rules/arrayTypeRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 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. @@ -85,7 +85,7 @@ function walk(ctx: Lint.WalkContext