[Anderson Paraibano]

RESOLVIDO – Typescript, paths aliases com pasta fora da raiz do meu projeto, Node.js

Introdução:
O desenvolvimento de aplicativos e sistemas em Node.js tem se tornado cada vez mais popular, e o Typescript se tornou uma escolha comum para muitos desenvolvedores devido aos seus recursos avançados de tipagem estática e aumento da produtividade. Uma das funcionalidades interessantes oferecidas pelo Typescript é a capacidade de criar aliases de caminho (paths aliases) para importar módulos de forma mais conveniente e legível. No entanto, pode surgir um desafio quando se deseja configurar aliases para pastas que estão fora da raiz do projeto. Neste artigo, exploraremos como resolver esse problema no ambiente do Node.js com Typescript.

Configurando o ambiente:
Antes de começar, é necessário ter o Node.js e o Typescript instalados em sua máquina. Certifique-se de ter uma estrutura de projeto básica do Typescript configurada e um arquivo de configuração tsconfig.json.

Criando o arquivo tsconfig-paths.json:
Normalmente, o arquivo de configuração tsconfig.json é usado para configurar as opções do Typescript, mas para definir aliases de caminho fora da raiz do projeto, precisamos criar um novo arquivo chamado tsconfig-paths.json. Este arquivo conterá a configuração para os aliases de caminho.
json
Copy code
{
“compilerOptions”: {
“baseUrl”: “.”,
“paths”: {
“@shared/*”: [“../shared/*”]
}
}
}
No exemplo acima, definimos um alias de caminho chamado “@shared” que aponta para a pasta “../shared” que está localizada fora da raiz do projeto.

Atualizando o arquivo tsconfig.json:
Agora, precisamos atualizar o arquivo tsconfig.json existente para incluir o novo arquivo de configuração tsconfig-paths.json. Adicione a seguinte linha na seção “extends” do arquivo tsconfig.json:
json
Copy code
“extends”: “./tsconfig-paths.json”
Dessa forma, estamos estendendo a configuração do Typescript para incluir as configurações de aliases de caminho definidas no arquivo tsconfig-paths.json.

Configurando o Node.js:
Para que o Node.js entenda e resolva os aliases de caminho definidos, precisamos fazer algumas configurações adicionais. Podemos usar a biblioteca “tsconfig-paths” para isso. Execute o seguinte comando para instalar a biblioteca:
shell
Copy code
npm install tsconfig-paths –save-dev
Modificando o script de execução no package.json:
No arquivo package.json, encontre o script de execução do Node.js e adicione a seguinte opção:
json
Copy code
“scripts”: {
“start”: “node -r tsconfig-paths/register dist/index.js”
}
A opção “-r tsconfig-paths/register” informa ao Node.js para usar a biblioteca “tsconfig-paths” e resolver corretamente os aliases de caminho definidos no arquivo tsconfig-paths.json.

Conclusão:
Neste artigo, discutimos como lidar com aliases de caminho no Typescript quando se tem pastas fora da raiz do projeto. Através da criação de um arquivo de configuração separado, a inclusão dessa configuração no arquivo principal tsconfig.json, a configuração adequada do ambiente Node.js e o uso da biblioteca “tsconfig-paths”, conseguimos resolver esse problema e permitir a utilização de aliases de caminho em nosso projeto.

Essa solução nos ajuda a manter um código mais limpo e legível, além de facilitar a reutilização de código compartilhado em diferentes partes do projeto. Com o uso efetivo de aliases de caminho, podemos melhorar a organização do projeto e evitar a necessidade de caminhos relativos longos e suscetíveis a erros.

Espero que este artigo tenha sido útil para você entender como resolver o desafio de configurar aliases de caminho com pastas fora da raiz do projeto no ambiente Node.js com Typescript. Experimente aplicar essas configurações em seu projeto e aproveite os benefícios de um código mais organizado e de fácil manutenção.

[Autor]

Posts