Fixed typescript props bug and added typescript compile to linting process #1485
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
mariano-formidable
force-pushed
the
fix/typescript-defs
branch
from
b916476
to
42e3db4
Compare
| ) | ||
| }, | ||
| format: { | ||
| default: 'prettier --write "./**/*.{js,jsx,json,ts,tsx}"', | ||
| ci: 'prettier --list-different "./**/*.{js,jsx,json,ts,tsx}"' | ||
| }, | ||
| check: { | ||
| ci: npsUtils.series.nps("format.ci", "lint", "test.ci"), | ||
| ci: npsUtils.series.nps("format.ci", "lint", "karma.ci"), |
There was a problem hiding this comment.
The lint process for typescript involves running build-package-libs, which test.ci also did, so I removed test.ci and replaced it with karma.ci since the packages will already be built for karma.
Let me know if this doesn't make sense or might produce some other problems, I just didn't want build-package-libs to run twice during ci if we didn't need it.
mariano-formidable
force-pushed
the
fix/typescript-defs
branch
from
934fb0d
to
42e3db4
Compare
mariano-formidable
changed the title
|
@mariano-formidable ci logs for these changes all look good. Thank you for this fix! |
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.
This PR fixes a small bug I found in the typescript definitions that wasn't caught by
eslint.After some googling, I realized that
typescript-eslintdoes not catch very specific typescript errors (like interface errors, or type mis-match errors). So the best way to ensure that all the typescript code (and definition files) are correct is to usetscto compile the typescript files in the project.tscwill catch any type errors thattypescript-eslintmisses.So, I added
lint.tsto our linting pipeline. It will simply build the typescript files (with no output generated thanks to thenoEmitflag) and report any build errors. This caught the bug in our definitions, so I was able to fix it and re-lint and voila things are working!Note: The bug was that
VictoryCommonPropsand another interface both defined the same propcategories(it was a mistake I introduced when fleshing out the demos). This isn't a breaking bug, just an annoying warning about duplicate definitions.