Merge branch 'master' into feature/opt-in-flag-convert-disable-comments

Author: KingDarBoja

.eslintrc.js

@@ -26,9 +26,13 @@ module.exports = {
         "@typescript-eslint/no-parameter-properties": "off",
         "@typescript-eslint/no-type-alias": "off",
         "@typescript-eslint/no-unnecessary-condition": "off",
+        "@typescript-eslint/no-untyped-public-signature": "off",
         "@typescript-eslint/no-use-before-define": "off",
         "@typescript-eslint/require-await": "off",
+        "@typescript-eslint/restrict-template-expressions": "off",
+        "@typescript-eslint/return-await": "off",
         "@typescript-eslint/strict-boolean-expressions": "off",
         "@typescript-eslint/typedef": "off",
+        "no-else-return": "error",
     },
 };

README.md

@@ -8,7 +8,7 @@
 [![Join the chat at https://gitter.im/tslint-to-eslint-config/community](https://img.shields.io/badge/chat-gitter-informational.svg)](https://gitter.im/tslint-to-eslint-config/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Code Style: Prettier](https://img.shields.io/badge/speed-blazingly_fast-blueviolet.svg)](https://prettier.io)
 
-Converts your TSLint configuration to the closest possible ESLint equivalent.
+Converts your TSLint configuration to the closest reasonable ESLint equivalent.
 
 👉 Did you know [TSLint is being deprecated this year](https://github.com/palantir/tslint/issues/4534)?
 Hooray!
@@ -39,6 +39,7 @@ TSLint rules without ESLint equivalents will be wrapped with [eslint-plugin-tsli
 Each of these flags is optional:
 
 -   **[`config`](#config)**: Path to print the generated ESLint configuration file to.
+-   **[`editor`](#editor)**: Path to an editor configuration file to convert linter settings within.
 -   **[`eslint`](#eslint)**: Path to an ESLint configuration file to read settings from.
 -   **[`package`](#package)**: Path to a package.json file to read dependencies from.
 -   **[`tslint`](#tslint)**: Path to a TSLint configuration file to read settings from.
@@ -59,6 +60,17 @@ The file extension of this path will be used to determine the format of the crea
 -   `.js` file paths will be written `module.exports = ...` JavaScript
 -   Other file paths will default to JSON
 
+#### `editor`
+
+```shell
+npx tslint-to-eslint-config --editor ./path/to/.vscode/settings.json
+```
+
+_Default: `.vscode/settings.json`_
+
+Path to an editor configuration file to convert settings settings within.
+Any VS Code style editor settings for TSLint will be converted to their ESLint equivalents.
+
 #### `eslint`
 
 ```shell

babel.config.js

@@ -1,3 +1,7 @@
 module.exports = {
     presets: [["@babel/preset-env", { targets: { node: "current" } }], "@babel/preset-typescript"],
+    plugins: [
+        "@babel/plugin-proposal-nullish-coalescing-operator",
+        "@babel/plugin-proposal-optional-chaining",
+    ],
 };

bin/tslint-to-eslint-config

@@ -4,15 +4,16 @@
 
 1.  CLI usage starts in `bin/tslint-to-eslint-config`, which immediately calls `src/cli/main.ts`.
 2.  CLI settings are parsed and read in `src/cli/runCli.ts`.
-3.  Application logic is run by `src/conversion/convertConfig.ts`.
+3.  Linter configuration conversion is run by `src/conversion/convertConfig.ts`.
+4.  Editor configuration conversion is run by `src/conversion/convertEditorConfig.ts`.
 
-## Configuration Conversion
+## Linter Configuration Conversion
 
 Within `src/conversion/convertConfig.ts`, the following steps occur:
 
 1. Existing configurations are read from disk
 2. TSLint rules are converted into their ESLint configurations
-3. ESLint configurations are simplified based on extended ESLint presets
+3. ESLint configurations are simplified based on extended ESLint and TSLint presets
 4. The simplified configuration is written to the output config file
 5. A summary of the results is printed to the user's console
 
@@ -46,3 +47,8 @@ It's possible that one ESLint rule will be output by multiple converters.
 These are located in `src/rules/mergers/`, and keyed under their names by the map in `src/rules/mergers.ts`.
 
 For example, `@typescript-eslint/ban-types` spreads both arguments' `types` members into one large `types` object.
+
+## Editor Configuration Conversion
+
+Editor lint configurations are converted by `src/editorSettings/convertEditorSettings.ts`.
+Any setting that matches a known built-in TSLint setting will be replaced with the ESLint equivalent.

docs/Architecture.md

@@ -4,7 +4,8 @@ module.exports = {
         "!./src/**/*.d.ts",
         "!./src/**/*.stubs.ts",
         "!./src/adapters/*.ts",
-        "!./src/rules/converters.ts",
+        "!./src/rules/rulesConverters.ts",
+        "!./src/editorSettings/editorSettingsConverters.ts",
         "!./src/rules/mergers.ts",
         "!./src/cli/main.ts",
     ],