This repository has been archived by the owner on May 22, 2024. It is now read-only.
feat: add support for TypeScript to NFT #1515
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
⏱ Benchmark resultsComparing with f345c7c largeDepsEsbuild: 2.7s⬇️ 25.29% decrease vs. f345c7c Legend
largeDepsNft: 8.7s⬇️ 28.84% decrease vs. f345c7c Legend
largeDepsZisi: 16.6s⬇️ 29.44% decrease vs. f345c7c Legend
|
lukasholzer
reviewed
Aug 1, 2023
| @@ -109,6 +118,19 @@ const traceFilesAndTranspile = async function ({ | |||
| ignore: getIgnoreFunction(config), | |||
| readFile: async (path: string) => { | |||
| try { | |||
| if (extname(path) === '.ts') { | |||
There was a problem hiding this comment.
whats about .mts or .ctsif working in ESM or commonjs scopes?
Maybe some \.(c|m)?ts$ regex?
There was a problem hiding this comment.
👍🏻 I'll do this as a follow-up.
| @@ -109,6 +118,19 @@ const traceFilesAndTranspile = async function ({ | |||
| ignore: getIgnoreFunction(config), | |||
| readFile: async (path: string) => { | |||
| try { | |||
| if (extname(path) === '.ts') { | |||
| const transpiledSource = await transpile({ config, name, path }) | |||
There was a problem hiding this comment.
I assume config is the tsconfig?
There was a problem hiding this comment.
No, config is the config block for the function that comes from both netlify.toml and the in-source configuration.
| return { | ||
| aliases: tsAliases, | ||
| mainFile: getPathWithExtension(mainFile, '.js'), | ||
| moduleFormat: MODULE_FORMAT.ESM, |
There was a problem hiding this comment.
is only esm supported? or shouldn't this be read from the tsconfig settings?
There was a problem hiding this comment.
We're making the v2 API ESM only, so I think hardcoding that setting here is fine.
There was a problem hiding this comment.
Although, it might still be useful for people wanting to use NFT with TypeScript on v1 functions, for some reason. I'll create an issue to do this as a follow-up.
| @@ -34,6 +36,8 @@ const bundle: BundleFunction = async ({ | |||
| includedFilesBasePath || basePath, | |||
| ) | |||
| const { | |||
| aliases, | |||
| mainFile: normalizedMainFile, | |||
There was a problem hiding this comment.
can you elaborate on what normalizedMainFile is? Is it a normalized path to the bundle entry file?
There was a problem hiding this comment.
The mainFile property refers to both the path of a function's entry file, as found in a Netlify project, and to the path of the entry file inside the generated bundle.
Most times this file name is the same, because we find function.js and generate function.js. But when transpiling, we need to rewrite function.ts as function.js, and that's what normalizedMainFile refers to.
Although we use it in a bunch of places, I realise it's not a great name, so perhaps we could make that a bit clearer. Do you have any suggestions?
lukasholzer
approved these changes
Aug 1, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Currently, TypeScript files are only supported when the bundler is set to esbuild. This PR adds support for TypeScript when using NFT as the bundler.
With that, we also change the upcoming functions API v2 to use NFT by default, instead of esbuild (2779f30).