chore: Replace Flowtype with Typescript #3
Merged
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
Setting up the repo to run with Typescript instead of Flowtype. This required changing the initial code, updating Jest & updating ESLint. Also: - Move eslint configuration into its own `.eslintrc.json` - Removing Babel as its replaced by Typescript (except `babel-eslint` which is needed by `eslint-config-eventbrite`)
rwholey-eb
reviewed
Feb 21, 2018
|
|
||
| # Target files | ||
| lib/ | ||
| dist/ |
There was a problem hiding this comment.
should we add **/.DS_Store ? Those files always show up for me
There was a problem hiding this comment.
Really? I've never seen those. I guess the first person to run into can add it. I don't have any to verify that it's working
config/jest-preprocess-typescript.js
Outdated
|
|
||
| module.exports = { | ||
| process(src, path) { | ||
| if (path.endsWith(".ts")) { |
There was a problem hiding this comment.
i might use, path.extname but i think it will be the same
https://nodejs.org/dist/latest-v8.x/docs/api/path.html#path_path_extname_path
There was a problem hiding this comment.
Oh I like that! The official Jest-Typescript example did this. 🤦♂️
| "format": "prettier-eslint --write", | ||
| "lint": "eslint src", | ||
| "lint": "eslint --cache --max-warnings 0 --ext .ts,.js src", |
kaylie-alexa
approved these changes
Feb 21, 2018
.npmignore
Outdated
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
There was a problem hiding this comment.
*.log should capture all three below, no?
There was a problem hiding this comment.
Yeah that sounds about right...
BenAtEventbrite
pushed a commit
that referenced
this pull request
Feb 22, 2018
#3 Replaced Flow w/ Typescript and as a result removed Babel because TypeScript both transpiles and type checks. However this makes us miss out on a lot of the plugins that are a part of the Babel community. Babel 7 adds support for Typescript. Use babel 7 to build assets instead of tsc. The tsc command is still used for static type checking. Note that the babel typescript plugin will transpile code regardless of its typecheck correctyness. tsc is also still used to generate the declaration files, since it looks as though the babel-typescript-plugin does not support creating those at this time. However there's a "create declaration only" flag that is convenient for this. I've excluded the .spec files from the babel build, so now they won't appear in lib. I didn't move the ignore declaration into the .babelrc because I can imagine a situation where we might want to use a cool feature in our test suite that babel can transpile for is (even though node 8 gets us there at the moment). However there's never a need to have the transpiled versions in our lib. Lastly, we can now support async await etc with the additions of lib -- es2015 and dom which I think will be especially useful in our tests because most of our exports will likely be functions that return promises. PS: i'm not tied to the tests, i just want to prove that they work! I'm happy to remove them, as we definitely should in the future, thought it might be nice while we're building the foundation though. Fixes #4
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Setting up the repo to run with Typescript instead of Flowtype. This required changing the initial code, updating Jest & updating ESLint.
Also:
.eslintrc.jsonbabel-eslintwhich is needed byeslint-config-eventbrite)(Filed #4 to upgrade to Babel 7 and use Babel + TypeScript)