Como rodar TypeScript nativamente no Node.js com TSX

Lucas Santos - Oct 20 '23 - - Dev Community

Quem nunca se perguntou como é possível que runtimes como o Deno consigam executar TypeScript nativamente? Quando isso vai chegar no Node? Quando a gente vai poder rodar TypeScript nativo em qualquer lugar?!

Bom, enquanto a ideia de rodar nativamente TS, sem um processo de compilação, ainda é distante, a gente consegue sim rodar arquivos TypeScript diretamente no Node.js sem nenhum passo de compilação, esses são os chamados loaders

Loaders

Os loaders são funções que atuam como ganchos entre a leitura de um módulo e e a execução do mesmo, por exemplo, muita gente está acostumada a usar o ts-node ou o ts-node-dev.

Ambos esses pacotes são loaders, eles recebem os arquivos que serão carregados pelo runtime e podem realizar ações sobre eles, no nosso caso, a ação é compilar o arquivo de TypeScript para JavaScript.

Você pode ver mais sobre essa funcionalidade na documentação oficial, inclusive, usando o próprio exemplo da transpilação.

Um loader então pode escolher qual é o arquivo que ele vai trabalhar, no nosso caso o .ts, e ai realizar uma ação sobre ele que, no caso, vai ser transpilar para JavaScript e mandar para o Node avaliar o código.

TSX

O TSX é a versão mais nova e melhorada do nosso ts-node, usando ESBuild para transpilar os arquivos de TS para JS muito rápido.

A parte mais interessante é que o TSX foi desenvolvido para ser um substituto completo do Node, então você pode realmente usar o TSX como um REPL de TypeScript, se você instalar ele globalmente com npm i -g tsx, é só rodar tsx no seu terminal e você pode escrever TSX nativamente.

Mas, o que é mais legal, é que você pode carregar o TSX para todos os arquivos TypeScript usando --loader tsx na hora de executar o seu arquivo. Por exemplo, vamos imaginar que temos esse arquivo chamado index.ts:

export function main(a: number, b: number) {
    console.log(a**b)
}

main(5,5)
Enter fullscreen mode Exit fullscreen mode

Se rodarmos o comando tsx index.ts, vamos ter um output 3125, mesmo sem ter nenhum projeto definido.

O tsx também tem um modo watch que pode ser executado com tsx watch <arquivo>, para ficar observando as alterações de um arquivo.

TSX como loader

Executar um arquivo (ou todos os seus arquivos) através de um loader é tão simples quanto criar um script start no seu package.json com o seguinte conteúdo:

node --loader tsx index.ts
Enter fullscreen mode Exit fullscreen mode

E executar como npm start.

Usar o TSX como loader não permite que ele seja usado com qualquer outra opção, como o watch

Estendendo a funcionalidade

Uma das coisas que podemos fazer desde a versão 20.6 do Node é carregar diretamente arquivos de configuração de ambiente presentes em arquivos .env. Mas como a gente pode usar tanto o loader como os arquivos de configuração?

O Node também lê uma variável de ambiente chamada NODE_OPTIONS que permite que você passe por string todas as opções que o Node vai receber, por exemplo NODE_OPTIONS='--loader tsx'.

Uma vez que não podemos passar a opção --env-file .env como uma das opções do NODE_OPTIONS, podemos carregar o loader a partir dela e passar o arquivo de configuração no comando principal:

NODE_OPTIONS='--loader=tsx' node --env-file=.env index.ts
Enter fullscreen mode Exit fullscreen mode

Experimente executar esse comando por ai nos seus projetos para facilitar o desenvolvimento!

Importante: Carregar arquivos TS diretamente do disco e realizar a compilação com loaders é bem mais lento do que transpilar primeiro e passar os arquivos JavaScript direto, por isso é recomendável que você faça isso apenas para ambientes de desenvolvimento.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .