Создание проекта npm с TypeScript

18 мая 2024 г.

Источник: тут.

  1. Инициализация проекта npm с TypeScript:

    npm init -y
  2. Установить TypeScript (как зависимость разработки):

    npm install typescript --save-dev
  3. Установить типы Nodejs:

    npm install @types/node --save-dev
  4. Сгенерировать конфигурацию проекта npm с TypeScript:

    npx tsc --init --rootDir src --outDir build \
    --esModuleInterop --resolveJsonModule --lib es6 \
    --module commonjs --allowJs true --noImplicitAny true

    или добавить конфигурацию в tsconfig.json:

    {
      "compilerOptions": {
        "target": "es5",
        "module": "commonjs",
        "lib": ["es6"],
        "allowJs": true,
        "outDir": "build",
        "rootDir": "src",
        "strict": true,
        "noImplicitAny": true,
        "esModuleInterop": true,
        "resolveJsonModule": true
      }
    }
  5. Создать файлы проекта:

    mkdir src
    touch src/index.ts
  6. Установить зависимости для запуска кода:

    npm install --save-dev ts-node nodemon
  7. Добавить конфигурацию перезапуска кода в nodemon.json:

    {
      "watch": ["src"],
      "ext": ".ts,.js",
      "ignore": [],
      "exec": "npx ts-node ./src/index.ts"
    }
  8. Добавить скрипт запуска кода в package.json и исправить main:

    {
      "name": "orms",
      "version": "1.0.0",
      "main": "index.ts",
      "scripts": {
        "start:dev": "npx nodemon" // +
      },
      "keywords": [],
      "author": "",
      "license": "ISC",
      "description": "",
      "devDependencies": {
        "@types/node": "^20.12.12",
        "nodemon": "^3.1.0",
        "ts-node": "^10.9.2",
        "typescript": "^5.4.5"
      }
    }