fix(types): emit and publish type definitions to npm #243
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 52b9233:
|
etienne-martin
changed the title
etienne-martin
changed the title
etienne-martin
changed the title
There was a problem hiding this comment.
Thanks for your work @etienne-martin !
I made a small change to separate the tsconfig file in two different configurations (one for type checking and one for declaration file generation) so we keep the original behavior for the yarn type-check command.
Beside that it seems good to me 🙂
|
Great, thank you! |
eunjae-lee
changed the title
There was a problem hiding this comment.
@etienne-martin Thank you for your contribution 🎉
For the record, I've run yarn lint && yarn test && yarn type-check && yarn build on my computer, since the community PRs are not run by CircleCI.
| // shim for node modules in React Native | ||
| // see https://github.com/facebook/react-native/issues/5079 | ||
| type empty = {}; | ||
| export default empty; |
There was a problem hiding this comment.
do these not get generated by the tsc, instead, what if we gitignore it?
There was a problem hiding this comment.
They don't because index-node.cjs.js, index-browser.cjs.js and empty-module.cjs.js live outside of the ./lib folder and are plain JavaScript files.
There was a problem hiding this comment.
The package.json points to these entry files, and TypeScript will look for the equivalent but with the .d.ts extension.
There was a problem hiding this comment.
Ideally I'd get rid of those files sitting at the root of the project and point the package.json to the entry points in the ./dist folder but I didn't want to change everything.
There was a problem hiding this comment.
I mean that tsc generates these files at publish time, why do they need to be committed on git?
There was a problem hiding this comment.
and are plain JavaScript files.
I see now, makes sense! in the future they should be moved to ts
There was a problem hiding this comment.
Got it. I will work on it next time.
There was a problem hiding this comment.
Another thing is, I'd use the ts-expect package against the build output to test that the types are emitted properly. That would ensure that the chain package.json --> enty-*.js --> entry-*.d.ts is working properly.
Because right now, there are unit test for the source code, but there's nothing that checks that the build output is in good health.
There was a problem hiding this comment.
Wasn't aware of that. Thanks for the information. I will check it out :)
Related to this issue: #9
./distfolder usingtsc.npm publishornpm pack.