Skip to content

README.md

Latest commit

 

History

History
85 lines (69 loc) · 2.31 KB

README.md

File metadata and controls

85 lines (69 loc) · 2.31 KB
Raw

Set Up a New TypeScript Project

Initialize a node project

npm init --yes
mkdir -p ./src ./test ./docs
npm install --save-dev typescript ts-node

The semantic difference here is that dependencies are used in production — whatever your project would entail. On the other hand, devDependencies are a collection of the dependencies used during the development of your application: the modules that you need to use to build it but don't need when it's running.

ts-node is a TypeScript execution engine and REPL for Node.js. It JIT transforms TypeScript into JavaScript, enabling you to directly execute TypeScript on Node.js without precompiling. This is accomplished by hooking node's module loading APIs, enabling it to be used seamlessly alongside other Node.js tools and libraries.

Typescript

npm install --save-dev @types/node

This package contains type definitions for node (https://nodejs.org/). See https://www.npmjs.com/package/@types/node

npx tsc --init

Eslint

npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint

See https://typescript-eslint.io/getting-started/

touch .eslintrc.json

https://eslint.org/docs/latest/use/configure/configuration-files Here’s an example JSON configuration file that uses the typescript-eslint parser to support TypeScript syntax:

{
    "root": true,
    "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended"
    ],
    "parser": "@typescript-eslint/parser",
    "parserOptions": { "project": ["./tsconfig.json"] },
    "plugins": [
        "@typescript-eslint"
    ],
    "rules": {
        "@typescript-eslint/strict-boolean-expressions": [
            2,
            {
                "allowString" : false,
                "allowNumber" : false
            }
        ]
    },
    "ignorePatterns": ["src/**/*.test.ts", "src/frontend/generated/*"]
}

Test

Git

git init
echo 'node_modules
build
coverage
.idea' > ./.gitignore

Reference