Javascript

Como instalar o TypeScript

Neste artigo veremos como instalar o TypeScript, conhecer o arquivo tsconfig, executar nosso primeiro código no Node.js e no navegador.

cerca de 1 mês atrás

O TypeScript é um superset para o Javascript, com isso ele traz uma série de recursos interessantes como tipagem estática, interfaces, generics, entre outras. Além de trazer mais praticidade no uso de orientação a objetos, com esses recursos, o seu editor (como o VS Code) fica mais eficiente, com um autocomplete mais inteligente, exibe erros em tempo de compilação, como consequência, no final das contas você terá como resultado um código mais claro e confiável.

Aqui na TreinaWeb temos um artigo completo sobre o TypeScript, aconselho a leitura caso você não tenha conhecimento sobre essa incrível ferramenta.

JavaScript - Fundamentos
Curso JavaScript - Fundamentos
Conhecer o curso

Agora vamos efetuar a instalação do TypeScript.

Como instalar o TypeScript

Primeiramente precisamos ter instalado o Node em nosso ambiente. Para fazer a instalação você pode seguir nosso artigo de instalação do Node.js no Windows, Mac e Linux.

Após a instalação vamos criar um projeto chamado ts, e então, aplicar o comando no terminal dentro do diretório do projeto:

npm init

Este comando irá criar o arquivo package.json, que será útil para as configurações do nosso projeto e verificar as dependências que estamos utilizando. Ao digitar o comando irá surgir algumas perguntas, podemos pular (enter) todas.

Ótimo! Agora vamos para a instalação efetivamente do TypeScript, para isto basta aplicar o comando:

npm install typescript

O arquivo package.json ficará da seguinte forma:

{
  "name": "ts",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \\"Error: no test specified\\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "typescript": "^4.4.2"
  }
}

Perceba que o arquivo package.json já exibe o pacote do TypeScript como dependência.

Agora podemos iniciar as configurações do TypeScript, para isso vamos aplicar o comando:

npx tsc --init

Desta forma irá gerar o arquivo tsconfig.json, que será responsável pelas configurações do TypeScript, algo similar ao código abaixo:

{
  "compilerOptions": {
    /* Visit  to read more about this file */

    /* Projects */
    // "incremental": true,                              /* Enable incremental compilation */
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "es5",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */

    /* Modules */
    "module": "ESNext",                                /* Specify what module code is generated. */
    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    // "resolveJsonModule": true,                        /* Enable importing .json files */
    // "noResolve": true,                                /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

    /* Emit */
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
    // "removeComments": true,                           /* Disable emitting comments. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */

    /* Type Checking */
    "strict": true,                                      /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

    /* Completeness */
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
}

Neste arquivo terá uma série de parâmetros, todos de uma forma bem didática mostrando quais opções e o que pode ser alterado.

Para fins do exemplo, vamos alterar o parâmetro "modules": "commonjs" para "modules": "ESNext", aqui estamos avisando ao TypeScript para usar o padrão do EcmaScript mais atual. Também vamos deixar ativado o parâmetro "outDir": "./dist", que será o diretório onde o TypeScript irá gerar o código JavaScript, lembrando que o TypeScript, no final das contas, gera um código JavaScript.

Podemos neste momento criar o primeiro código TypeScript.

Node.js - Fundamentos
Curso Node.js - Fundamentos
Conhecer o curso

Criando primeiro código TypeScript

Vamos criar um arquivo app.ts na raiz de nosso projeto com seguinte código:

let idade: number = 15;
let nome: string = 'Paula';

console.log(`nome: ${nome}, idade: ${idade}`);

Veja que já declaramos algumas variáveis passando o seu tipo, não se preocupe com a sintaxe do TypeScript nesse momento, a ideia neste exemplo é verificar se nosso ambiente está ok, para isso vamos executar o seguinte comando:

npx tsc

O tsc é o executável do TypeScript, que irá gerar o código JavaScript de acordo com as configurações que colocamos nos parâmetros do arquivo tsconfig.json. Como configuramos anteriormente, o TypeScript irá criar o diretório dist e gerar o arquivo app.js dentro do mesmo, com essa estrutura:

O código gerado ficará da seguinte forma:

"use strict";
var idade = 15;
var nome = 'Paula';
console.log("nome: " + nome + ", idade: " + idade);

Perceba a diferença, no código gerado não temos mais os tipos das variáveis, no console.log(), as variáveis estão concatenadas e não mais interpoladas conforme escrito no código original utilizando TypeScript.

Podemos testar e executar o código JavaScript gerado, vamos usar o comando:

node ./dist/app.js

O resultado será:

nome: Paula, idade: 15

Executando no Navegador

Como o TypeScript gera um código JavaScript, nada impede de executar essa saída em um navegador. Para isso, vamos criar um arquivo na raiz do nosso projeto com o nome index.html, com uma estrutura básica importando o arquivo JavaScript, da seguinte forma:

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <title>Trabalhando com TypeScript</title>
    </head>
    <body>
        <script src="dist/app.js"></script>
    </body>
</html>

Obs: No VS Code basta digitar “!” e selecionar a primeira opção do autocomplete que ele irá gerar a base de uma página HTML automaticamente.

Perceba que importamos o arquivo JavaScript logo antes da tag de fechamento body. Nesse momento vamos entrar na nossa página index.html pelo navegador e abrir o DevTools, na aba console será exibido o seguinte resultado:

Exatamente o que fizemos em nosso arquivo TypeScript e que foi transpilado para JavaScript.

Conclusão

TypeScript - Primeiros Passos
Curso TypeScript - Primeiros Passos
Conhecer o curso

Neste artigo aprendemos a instalar e configurar o ambiente para iniciar o desenvolvimento de uma aplicação utilizando TypeScript. Você pode acessar a documentação para sanar qualquer dúvida.

Também entendemos a importância do arquivo tsconfig.json e como o TypeScript gera um código JavaScript, logo, nos próximos artigos, vamos ver sobre declaração de variáveis, tipagem, entre outros recursos que o TypeScript pode nos ajudar :D

Autor(a) do artigo

Wesley Gado
Wesley Gado

Formado em Análise e Desenvolvimento de Sistemas pelo Instituto Federal de São Paulo, atuou em projetos como desenvolvedor Front-End. Nas horas vagas grava Podcast e arrisca uns três acordes no violão.

Todos os artigos

Artigos relacionados Ver todos