Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wellpinho/love-rev2

Criar aplicação Node.js com Typescript
https://github.com/wellpinho/love-rev2

Last synced: 13 days ago
JSON representation

Criar aplicação Node.js com Typescript

Awesome Lists containing this project

README 

        
# Criar aplicação Node.js com Typescript

### Neste post veremos a preparação da aplicação backend que será desenvolvida ao longo do curso prático de criação de uma API de Vendas com Node.js, Typescript, TypeORM, Docker e muito mais.****



## Estrutura do projeto

![](documentacao/wireframe-projeto.png)



## Iniciar a aplicação Node.js com Typescript

``` yarn init -y ```



``` yarn add typescript ts-node-dev @types/node -D ```



- Fazer a instalação do Typescript na pasta do projeto, como uma dependência de desenvolvimento. Como o código final é convertido para javascript antes de ser disponibilizado online, só precisaremos do Typescript em ambiente de desenvolvimento.

``` yarn add typescript ts-node-dev @types/node -D ```



- Criar o arquivo "tsconfig.json" que conterá as configurações do Typescript, com o comando:

``` 

yarn tsc --init --rootDir src --outDir build \

--esModuleInterop --resolveJsonModule --lib es6 \

--module commonjs --allowJs true --noImplicitAny true

```

- Em resumo, os parâmetros passados são:



__rootDir__: É aqui que o TypeScript procura nosso código.



__outDir__: Onde o TypeScript coloca nosso código compilado.



__esModuleInterop__: Se estiver usando commonjs como sistema de módulo (recomendado para aplicativos Node), então esse parâmetro deve ser definido como true.



__resolveJsonModule__: Se usarmos JSON neste projeto, esta opção permite que o TypeScript o use.



__lib__: Esta opção adiciona tipos de ambiente ao nosso projeto, permitindo-nos contar com recursos de diferentes versões do Ecmascript, bibliotecas de teste e até mesmo a API DOM do navegador. Usaremos recursos es6 da linguagem.



__module__: commonjs é o sistema de módulo Node padrão.



__allowJs__: Se você estiver convertendo um projeto JavaScript antigo em TypeScript, esta opção permitirá que você inclua arquivos .js no projeto.



__noImplicitAny__: Em arquivos TypeScript, não permita que um tipo seja especificado inexplicitamente. Cada tipo precisa ter um tipo específico ou ser declarado explicitamente any.



- Nosso arquivo __tsconfig.json__ deve estar assim:

```

{

  "compilerOptions": {

    /* Visit https://aka.ms/tsconfig.json to read more about this file */



    /* Basic Options */

    // "incremental": true,                   /* Enable incremental compilation */

    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */

    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */

    "lib": ["es6"],                           /* Specify library files to be included in the compilation. */

    "allowJs": true,                          /* Allow javascript files to be compiled. */

    // "checkJs": true,                       /* Report errors in .js files. */

    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */

    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */

    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */

    // "sourceMap": true,                     /* Generates corresponding '.map' file. */

    // "outFile": "./",                       /* Concatenate and emit output to single file. */

    "outDir": "build",                        /* Redirect output structure to the directory. */

    "rootDir": "src",                         /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */

    // "composite": true,                     /* Enable project compilation */

    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */

    // "removeComments": true,                /* Do not emit comments to output. */

    // "noEmit": true,                        /* Do not emit outputs. */

    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */

    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */

    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */



    /* Strict Type-Checking Options */

    "strict": true,                           /* Enable all strict type-checking options. */

    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */

    // "strictNullChecks": true,              /* Enable strict null checks. */

    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */

    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */

    "strictPropertyInitialization": false,  /* Enable strict checking of property initialization in classes. */

    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */

    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */



    /* Additional Checks */

    // "noUnusedLocals": true,                /* Report errors on unused locals. */

    // "noUnusedParameters": true,            /* Report errors on unused parameters. */

    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */

    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */



    /* Module Resolution Options */

    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */

    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */

    "paths": {

      "@config/*": [

        "src/config/*"

      ],

      "@modules/*": [

        "src/modules/*"

      ],

      "@shared/*": [

        "src/shared/*"

      ]

    },                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */

    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */

    "typeRoots": [

      "@types",

      "./node_modules/@types"

    ],                       /* List of folders to include type definitions from. */

    // "types": [],                           /* Type declaration files to be included in compilation. */

    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */

    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */

    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */

    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */



    /* Source Map Options */

    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */

    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */

    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */

    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */



    /* Experimental Options */

    "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */

    "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */



    /* Advanced Options */

    "resolveJsonModule": true,                /* Include modules imported with '.json' extension */

    "skipLibCheck": true,                     /* Skip type checking of declaration files. */

    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */

  }

}

```



- Arquivo __.gitignore__

```

.idea/

.vscode/

node_modules/

build/

temp/

.env

coverage

ormconfig.json

dist



uploads/*

!uploads/.gitkeep

```



- Criar a pasta __uploads__ com o arquivo __.gitkeep__ dentro para que os arquivos carregados nessa pasta não sejam incluídos no controle de versão do Git.



Criar a pasta __src__ e o primeiro arquivo:

```

mkdir src



touch src/server.ts

```



- __Executar o servidor em desenvolvimento__



Usaremos a biblioteca __ts-node-dev__ para execução da aplicação em desenvolvimento.



Incluir o script para rodar o __ts-node-dev__ no arquivo __package.json__.

```     

  "dev": "ts-node-dev -r tsconfig-paths/register --inspect --transpile-only --ignore-watch node_modules src/shared/http/server.ts",

  "lint": "eslint . --ext .ts",

  "lint-fix": "eslint . --ext .ts --fix",

  "typeorm": "ts-node-dev ./node_modules/typeorm/cli.js", 

```



[Configurando EditorConfig](documentacao/EditorConfig.md)