Improve README with TSLint migration info #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BurnedMarshal
requested review from
AleDore,
cloudify,
francescopersico and
gunzip
as code owners
6 tasks
gunzip
previously approved these changes
Jan 11, 2021
| @@ -8,8 +8,48 @@ This package provide the following ESLint custom rules for Typescript projects. | |||
|
|
|||
| This repository replace [italia-tslint-rules](https://github.com/pagopa/io-tslint-rules) after TSLint deprecation. | |||
|
|
|||
| The following TSLint rules (included inside `italia-tslint-rules`) are not supported for eslint at the moment and are missing in this package: | |||
| ``` | |||
| bool-param-default | |||
There was a problem hiding this comment.
This has been the list that I've produced working on #1.
The steps that I've followed was:
- Follow TSLint to ESLint migration guide on the project
io-backend - Running
npx tslint-to-eslint-configthat produces a list of TSLint rules not available for ESLint (77 rules) - Manually check each one for an alternative ESLint rules/plugins
- Verify each alternative ESLint rule/plugin on a testing file
The remaining was this list.
There was a problem hiding this comment.
great! can you add this comment to the readme?
There was a problem hiding this comment.
Fixed in b5a9a7c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
List of Changes
Add migration section inside README
Motivation and Context
To give more detailed information above migration from TSLint and
italia-tslint-rulesto ESLint a new section was added with this PR inside the README.The README now includes the list of rules present into
italia-tslint-rulesand missing inside@pagopa/eslint-config.How Has This Been Tested?
No tests needed.
Types of changes
Checklist:
Question:
Can we enable
eslinteven on.test.tsfiles? So we could have the same code style restrictions on tests.