Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

tslint-to-eslint-config

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

tslint-to-eslint-config - npm Package Compare versions

Comparing version 0.1.8 to 0.1.9

docs/Dependencies.md

src/adapters/childProcessExec.d.ts

src/adapters/childProcessExec.js

src/adapters/exec.d.ts

src/adapters/exec.js

src/adapters/exec.stubs.d.ts

src/adapters/fileSystem.d.ts

src/adapters/fileSystem.js

src/adapters/fsFileSystem.d.ts

src/adapters/fsFileSystem.js

src/adapters/importer.d.ts

src/adapters/importer.js

src/adapters/logger.d.ts

src/adapters/logger.js

src/adapters/logger.stubs.d.ts

src/adapters/processLogger.d.ts

src/adapters/processLogger.js

src/binding.d.ts

src/binding.js

src/cli/main.d.ts

src/cli/main.js

src/cli/runCli.d.ts

src/cli/runCli.js

src/conversion/conversionResults.stubs.d.ts

src/conversion/convertConfig.d.ts

src/conversion/convertConfig.js

src/creation/eslint/createEnv.d.ts

src/creation/eslint/createEnv.js

src/creation/formatConvertedRules.d.ts

src/creation/formatConvertedRules.js

src/creation/formatMissingRules.d.ts

src/creation/formatMissingRules.js

src/creation/formatting/formatOutput.d.ts

src/creation/formatting/formatOutput.js

src/creation/formatting/formatters/formatJsonOutput.d.ts

src/creation/formatting/formatters/formatJsonOutput.js

src/creation/formatting/formatters/formatJsOutput.d.ts

src/creation/formatting/formatters/formatJsOutput.js

src/creation/simplification/collectExtensions.js

src/creation/simplification/importer.js

src/creation/simplification/removeExtendsDuplicatedRules.d.ts

src/creation/simplification/removeExtendsDuplicatedRules.js

src/creation/simplification/removePluginDuplicatedRules.js

src/creation/simplification/resolveExtensionNames.d.ts

src/creation/simplification/resolveExtensionNames.js

src/creation/simplification/retrieveExtendsValues.d.ts

src/creation/simplification/retrieveExtendsValues.js

src/creation/simplification/ruleValuesAreTheSame.js

src/creation/simplification/simplifyPackageRules.d.ts

src/creation/simplification/simplifyPackageRules.js

src/creation/writeConversionResults.d.ts

src/creation/writeConversionResults.js

src/errors/configurationError.d.ts

src/errors/configurationError.js

src/errors/conversionError.d.ts

src/errors/conversionError.js

src/input/findConfiguration.d.ts

src/input/findConfiguration.js

src/input/findESLintConfiguration.d.ts

src/input/findESLintConfiguration.js

src/input/findOriginalConfigurations.d.ts

src/input/findOriginalConfigurations.js

src/input/findPackagesConfiguration.d.ts

src/input/findPackagesConfiguration.js

src/input/findTSLintConfiguration.d.ts

src/input/findTSLintConfiguration.js

src/input/findTypeScriptConfiguration.d.ts

src/input/findTypeScriptConfiguration.js

src/reporting/reportConversionResults.d.ts

src/reporting/reportConversionResults.js

src/rules/conversionError.d.ts

src/rules/conversionError.js

src/rules/converter.d.ts

src/rules/converter.js

src/rules/converters.d.ts

src/rules/converters.js

src/rules/converters/adjacent-overload-signatures.js

src/rules/converters/array-type.js

src/rules/converters/arrow-parens.js

src/rules/converters/arrow-return-shorthand.js

src/rules/converters/await-promise.js

src/rules/converters/ban-comma-operator.js

src/rules/converters/ban-ts-ignore.js

src/rules/converters/ban-types.js

src/rules/converters/binary-expression-operand-order.js

src/rules/converters/callable-types.js

src/rules/converters/class-name.js

src/rules/converters/curly.js

src/rules/converters/cyclomatic-complexity.js

src/rules/converters/eofline.js

src/rules/converters/forin.js

src/rules/converters/function-constructor.js

src/rules/converters/increment-decrement.js

src/rules/converters/indent.js

src/rules/converters/interface-name.js

src/rules/converters/interface-over-type-literal.js

src/rules/converters/label-position.js

src/rules/converters/linebreak-style.js

src/rules/converters/max-classes-per-file.js

src/rules/converters/max-file-line-count.js

src/rules/converters/max-func-body-length.js

src/rules/converters/max-line-length.js

src/rules/converters/member-access.js

src/rules/converters/member-ordering.js

src/rules/converters/new-parens.js

src/rules/converters/newline-before-return.js

src/rules/converters/newline-per-chained-call.js

src/rules/converters/no-angle-bracket-type-assertion.js

src/rules/converters/no-arg.js

src/rules/converters/no-banned-terms.js

src/rules/converters/no-bitwise.js

src/rules/converters/no-conditional-asignment.js

src/rules/converters/no-conditional-assignment.js

src/rules/converters/no-consecutive-blank-lines.js

src/rules/converters/no-console.js

src/rules/converters/no-constant-condition.js

src/rules/converters/no-construct.js

src/rules/converters/no-control-regex.js

src/rules/converters/no-debugger.js

src/rules/converters/no-duplicate-super.js

src/rules/converters/no-duplicate-switch-case.js

src/rules/converters/no-empty-interface.js

src/rules/converters/no-empty.js

src/rules/converters/no-eval.js

src/rules/converters/no-explicit-any.js

src/rules/converters/no-for-in-array.js

src/rules/converters/no-function-expression.js

src/rules/converters/no-inferrable-types.js

src/rules/converters/no-internal-module.js

src/rules/converters/no-invalid-regexp.js

src/rules/converters/no-invalid-template-strings.js

src/rules/converters/no-invalid-this.js

src/rules/converters/no-irregular-whitespace.js

src/rules/converters/no-magic-numbers.js

src/rules/converters/no-misused-new.js

src/rules/converters/no-multiline-string.js

src/rules/converters/no-multiline-strings.js

src/rules/converters/no-namespace.js

src/rules/converters/no-non-null-assertion.js

src/rules/converters/no-object-literal-type-assertion.js

src/rules/converters/no-octal-literal.js

src/rules/converters/no-parameter-properties.js

src/rules/converters/no-parameter-reassignment.js

src/rules/converters/no-reference.js

src/rules/converters/no-regex-spaces.js

src/rules/converters/no-require-imports.js

src/rules/converters/no-return-await.js

src/rules/converters/no-sparse-arrays.js

src/rules/converters/no-string-literal.js

src/rules/converters/no-string-throw.js

src/rules/converters/no-switch-case-fall-through.js

src/rules/converters/no-this-assignment.js

src/rules/converters/no-unbound-method.js

src/rules/converters/no-unnecessary-class.js

src/rules/converters/no-unnecessary-initializer.js

src/rules/converters/no-unnecessary-qualifier.js

src/rules/converters/no-unnecessary-semicolons.js

src/rules/converters/no-unnecessary-type-assertion.js

src/rules/converters/no-unsafe-finally.js

src/rules/converters/no-use-before-declare.js

src/rules/converters/no-var-keyword.js

src/rules/converters/no-var-requires.js

src/rules/converters/object-literal-key-quotes.js

src/rules/converters/object-literal-shorthand.js

src/rules/converters/one-variable-per-declaration.js

src/rules/converters/prefer-const.js

src/rules/converters/prefer-for-of.js

src/rules/converters/prefer-function-over-method.js

src/rules/converters/prefer-object-spread.js

src/rules/converters/prefer-template.js

src/rules/converters/promise-function-async.js

src/rules/converters/radix.js

src/rules/converters/restrict-plus-operands.js

src/rules/converters/space-before-function-paren.js

src/rules/converters/switch-default.js

src/rules/converters/type-annotation-spacing.js

src/rules/converters/type-literal-delimiter.js

src/rules/converters/typedef-whitespace.js

src/rules/converters/typeof-compare.js

src/rules/converters/unified-signatures.js

src/rules/converters/unnecessary-bind.js

src/rules/converters/unnecessary-constructor.js

src/rules/converters/use-isnan.js

src/rules/convertRule.d.ts

src/rules/convertRule.js

src/rules/convertRules.d.ts

src/rules/convertRules.js

src/rules/convertRuleSeverity.d.ts

src/rules/convertRuleSeverity.js

src/rules/formatRawTslintRule.d.ts

src/rules/formatRawTslintRule.js

src/rules/merger.d.ts

src/rules/merger.js

src/rules/mergers.d.ts

src/rules/mergers.js

src/rules/mergers/ban-types.js

src/rules/mergers/no-unnecessary-type-assertion.js

src/rules/types.d.ts

src/rules/types.js

src/types.d.ts

src/types.js

src/utils.d.ts

src/utils.js

test/createTestArgs.d.ts

test/createTestArgs.js

test/createTests.d.ts

test/createTests.js

test/expectFileContains.d.ts

test/expectFileContains.js

test/runEndToEndTests.d.ts

test/runEndToEndTests.js

.eslintrc.js

		@@ -6,3 +6,11 @@ module.exports = {
		},
		extends: ["airbnb-base", "eslint-config-prettier", "plugin:@typescript-eslint/recommended"],
		extends: ["airbnb-base", "eslint-config-prettier", "plugin:@typescript-eslint/all"],
		overrides: [
		{
		files: [".stubs.ts", ".test.ts"],
		rules: {
		"@typescript-eslint/promise-function-async": 0,
		},
		},
		],
		parser: "@typescript-eslint/parser",
		@@ -14,7 +22,13 @@ parserOptions: {
		rules: {
		"@typescript-eslint/consistent-type-definitions": ["error", "type"],
		"@typescript-eslint/explicit-function-return-type": 0,
		"@typescript-eslint/generic-type-naming": 0,
		"@typescript-eslint/indent": 0,
		"@typescript-eslint/no-explicit-any": 0,
		"@typescript-eslint/no-extra-parens": 0,
		"@typescript-eslint/no-magic-numbers": 0,
		"@typescript-eslint/no-parameter-properties": 0,
		"@typescript-eslint/no-type-alias": 0,
		"@typescript-eslint/no-use-before-define": 0,
		"@typescript-eslint/prefer-for-of": 1,
		"@typescript-eslint/prefer-interface": 0,
		@@ -21,0 +35,0 @@ "default-case": 0,

.github/CODE_OF_CONDUCT.md

@@ -0,0 +0,0 @@ # Contributor Covenant Code of Conduct

.github/ISSUE_TEMPLATE.md

@@ -0,0 +0,0 @@ <!--

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +0,0 @@ ---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +0,0 @@ ---

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +0,0 @@ <!--

.vscode/settings.json

@@ -0,0 +0,0 @@ {

babel.config.js

		module.exports = {
		presets: [["@babel/preset-env", { targets: { node: "current" } }], "@babel/preset-typescript"],
		};

docs/Architecture.md

		@@ -5,11 +5,45 @@ # Architecture

		- CLI usage starts in `bin/tslint-to-eslint-config`, which immediately calls `src/cli/main.ts`.
		- CLI settings are parsed and read in `src/cli/runCli.ts`.
		- Application logic is run by `src/conversion/convertConfig.ts`.
		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`.

		## Dependencies
		## Configuration Conversion

		Methods are created using a variant of [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_Injection).
		Any method with dependencies that should be stubbed out during tests, such as file system bindings, logging, or other methods,
		takes in a first argument of name `dependencies`.
		Its dependencies object is manually created in `src/cli/main.ts` and bound to the method with `bind`.
		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
		4. The simplified configuration is written to the output config file
		5. A summary of the results is printed to the user's console

		### Conversion Results

		The overall configuration generated by steps 2-3 and printed in 4-5 contains the following information:

		### Rule Converters

		Each TSLint rule should output at least one ESLint rule as the equivalent.
		"Converters" for TSLint rules are located in `src/rules/converters/`, and keyed under their names by the map in `src/rules/converters.ts`.

		Each converter for a TSLint rule takes an arguments object for the rule, and returns an array of objects containing:

		- `rules`: At least one equivalent ESLint rule and options
		- `notices`: Any extra info that should be printed after conversion
		- `plugins`: Any plugins that should now be installed if not already

		The `rules` output is an array of objects containing:

		- `ruleName`: Equivalent ESLint rule name that should be enabled
		- `ruleArguments`: Any arguments for that ESLint rule

		Multiple objects must be supported because some general-use TSLint rules can only be represented by two or more ESLint rules.
		For example, TSLint's `no-banned-terms` is represented by ESLint's `no-caller` and `no-eval`.

		### Rule Mergers

		It's possible that one ESLint rule will be output by multiple converters.
		"Mergers" for those ESLint rules should take in two configurations to the same rule and output the equivalent single configuration.
		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.

docs/Development.md

		@@ -22,5 +22,6 @@ # Development

		## More Reading
		## Further Reading

		- [Architecture](./Architecture.md)
		- [Testing](./Testing.md)
		- [Architecture](./Architecture.md): How the general app structure operates
		- [Dependencies](./Dependencies.md): How functions pass and receive static dependencies
		- [Testing](./Testing.md): Unit and end-to-end tests

docs/Testing.md

		@@ -21,1 +21,21 @@ # Testing
		- `src/*/.stubs.ts`

		See [Dependencies](./Dependencies.md) for how static dependencies are stubbed out in functions.
		That system is how functions can receive stubs and spies during unit tests.

		## End-to-End Tests

		```shell
		npm run test:end-to-end
		```

		End-to-end tests that execute the `bin/tslint-to-eslint` command and validate outputs are generated from the directories in `test/tests/`.
		Each directory there contains:

		- `.eslintrc.json`: `.gitignore`d output from the most recent test run
		- `expected.json`: Expected output ESLint configuration
		- `stderr.txt`: Any output written to the process `stderr`
		- `stdout.txt`: Any output written to the process `stdout`
		- `tslint.json`: Original TSLint configuration file to convert

		Within each directory, a test suite will execute `bin/tslint-to-eslint` and validate the outputs match what's on disk.

jest.config.js

@@ -0,0 +0,0 @@ module.exports = {

LICENSE.md

@@ -0,0 +0,0 @@ MIT License

package.json

		@@ -30,3 +30,3 @@ {
		"jest": "24.8.0",
		"lint-staged": "9.0.2",
		"lint-staged": "9.1.0",
		"prettier": "1.18.2",
		@@ -70,3 +70,3 @@ "strip-ansi": "5.2.0",
		},
		"version": "0.1.8"
		"version": "0.1.9"
		}

README.md

@@ -0,0 +0,0 @@ # tslint-to-eslint-config

renovate.json

@@ -0,0 +0,0 @@ {

test/createTestArgs.ts

@@ -0,0 +0,0 @@ import * as fs from "fs";

test/createTests.ts

@@ -0,0 +0,0 @@ import * as cp from "child_process";

test/expectFileContains.ts

@@ -0,0 +0,0 @@ import * as fs from "fs";

test/jest.config.js

@@ -0,0 +0,0 @@ module.exports = {

test/runEndToEndTests.ts

@@ -0,0 +0,0 @@ import * as fs from "fs";

test/tests/standalone tslint.json/.eslintrc.json

@@ -0,0 +0,0 @@ {

test/tests/standalone tslint.json/expected.json

@@ -0,0 +0,0 @@ {

test/tests/standalone tslint.json/stdout.txt

		✨ 17 rules replaced with their ESLint equivalents. ✨
		️👀 2 rules do not yet have ESLint equivalents; defaulting to eslint-plugin-tslint. 👀
		✅ All is well! ✅

test/tests/standalone tslint.json/tslint.json

@@ -0,0 +0,0 @@ {

tsconfig.json

@@ -0,0 +0,0 @@ {

.eslintrc.json

.circleci/config.yml