Налаштуйте проект TypeScript із загальними залежностями для створення декількох простих вихідних файлів JavaScript

Зараз я пишу кілька сценаріїв для Bot Land . Bot Land - стратегічна гра в реальному часі, де замість того, щоб керувати своїми підрозділами за допомогою миші та клавіатури, ви пишете код, щоб керувати своїми ботами за допомогою API, а потім ваші боти йдуть на боротьбу з іншими ботами. Якщо ви знайомі з підрозділами в SC2, ви можете створити ботів, схожих на моргаючі сталкери, облогові цистерни, медики та ультраліски. (Це досить весела гра для інженерів програмного забезпечення, але це поза сферою цього питання.)

Контроль ботів має три рівні зростаючої складності: AI за замовчуванням, мова програмування, схожа на Scratch , та зменшений набір JavaScript під назвою BotLandScript. Хоча вбудований редактор для BotLandScript розумний, ви повинні завантажувати весь код у вигляді одного файлу з глобальними функціями верхнього рівня скрізь. Звичайно, через деякий час це стає болісним, якщо ваш код починає отримувати довгі і різні боти мають однакові функції.

Щоб полегшити написання коду для декількох ботів, зменшити шанс ненавмисних помилок при кодуванні в голому JS та збільшити шанси на побиття інших гравців, я створив вищевказаний проект TypeScript, щоб забезпечити загальну бібліотеку, а також код для кожного з моїх ботів . Поточна структура каталогу виглядає приблизно так:

lib/ 
  bot.land.d.ts
  common.ts
BlinkStalker/
  BlinkStalker.ts
  tsconfig.json
Artillery/
  Artillery.ts
  tsconfig.json
SmartMelee/
  SmartMelee.ts
  tsconfig.json

libє загальним кодом, який ділиться між ботами, і дає визначення TypeScript для API (не-TS) Bot Land API. Після цього кожен бот отримує власну папку, в якому один файл містить код бота, а інший - панель котлів tsconfig.json:

{
  "compilerOptions": {
    "target": "es3",
    "module": "none",
    "sourceMap": false,
    "outFile": "bot.js"
  },
  "files": [
    "MissileKite.ts"
  ],
  "include": [
    "../lib/**/*"
  ]
}

Коли кожен tsconfig.jsonпобудований, він створює відповідний, bot.jsякий містить перекладений код від самого бота, а також весь код у common.js. Ця настройка є неоптимальною з кількох причин, серед інших: вона вимагає багато дублікатів котла, ускладнює додавання нових ботів, включає багато непотрібного коду для кожного бота і вимагає, щоб кожен бот був побудований окремо.

Однак, базуючись на моєму дослідженні дотепер , не здається, що існує простий спосіб зробити те, що я хочу. Зокрема, використання нової tsc -bопції та посилань не працює, тому що для цього потрібно модулювати модуль, а Bot Land вимагає єдиного файлу з усіма функціями, визначеними на верхньому рівні.

Який найкращий спосіб досягти якомога більшої кількості наступного?

• Не потрібно нових котлів для додавання нового бота (наприклад, немає tsconfig.jsonна бота)
• Використовуйте importдля загальних функцій, щоб уникнути виведення невикористаного коду, але потім ...
• Все-таки виводите всі функції як один єдиний файл у певному форматі Bot Land
• Один крок збирання, який створює кілька вихідних файлів, по одному для кожного бота
• Бонус: інтеграція процесу складання з кодом VS. Наразі існує котельна плита tasks.jsonдля створення кожного підпроекту.

Я невпевнено вважаю, що відповідь, ймовірно, передбачає щось на кшталт Грунта tsc, але я не знаю про це, щоб бути впевненим.

Ось моя спроба відповісти на ваші вимоги.

Помітні файли:

• src/tsconfig-botland.jsonмістить налаштування для будь- якого сценарію bot.land (включаючи ваші власні декларації, до яких я перемістився types/bot-land/index.d.ts). Ви можете змінити strictналаштування, які я використовував.
• src/tsconfig.jsonмістить посилання на всіх ваших ботів. Це файл для редагування, коли ви хочете додати ще один бот-скрипт

Сценарій бота - це щонайменше два файли: мінімалістичний tsconfig.jsonта один чи більше .tsфайлів сценаріїв.

Наприклад src/AggroMiner/tsconfig.json:

{
    "extends": "../tsconfig-botland",
    "compilerOptions": {
        "outFile": "../../build/AggroMiner.js"
    },
    "files": ["index.ts"],
    "include": ["**/*.ts", "../lib/**/*.ts"]
}

У більшості випадків, щоб запустити новий скрипт бота, слід:

1. скопіюйте будь-яку папку бота (тобто src/AggroMiner) у нову папку підsrc
2. edit src/<newBotFolder>/tsconfig.jsonдля редагування outFileімені вашого бота
3. відредагуйте src/tsconfig.jsonта додайте посилання наsrc/<newBotFolder>

Встановлено наступний npm/ yarnсценарій:

• build створити всіх ботів
• build-cleanякі очищають buildпапку перед запуском abuild
• formatзапустити Краще на всіх .tsфайлах підsrc
• lint запустити перевірку tslint на всіх скриптах бота

Тепер знижуємо свої вимоги:

• Не потрібно нових котлів для додавання нового бота (наприклад, немає tsconfig.json на бота)

Для цього знадобиться створити якийсь сценарій, який би перерахував папку / сценарії ваших ботів ... та встановив відповідний для бота tsconfig.jsonі запустіть tsc. Якщо це абсолютно не потрібно, мінімальна установка (описати вище) може бути достатньою.

• Використовуйте імпорт для загальних функцій, щоб уникнути виведення невикористаного коду, але потім ...

По-перше, майте на увазі, що якщо ви почнете використовувати будь-який модуль export/ importоператори, вам знадобиться додаткова третя сторона, щоб упакувати / потискати дерева, щоб досягти єдиного виводу файлу. З того, що я міг зібрати Bot.land, ваші сценарії працюють на сервері. Якщо б мертвий код не вплинув на продуктивність вашого бота, я б не дуже переймався.

• Все-таки виводите всі функції як один єдиний файл у певному форматі Bot Land

Зроблено.

• Один крок збирання, який створює кілька вихідних файлів, по одному для кожного бота

Зроблено.

• Бонус: інтеграція процесу складання з кодом VS. Наразі існує відповідна котла task.json для створення кожного підпроекту.

У npmсценарії повинен з'явитися в списку завдань VSC (принаймні вони роблять в шахті) , таким чином , роблячи tasks.jsonнепотрібним.

Ви фактично можете використовувати посилання на проекти. Виконайте ці дії, щоб отримати ті самі результати, які ви отримували для оригінальних файлів, з усіма функціями на верхньому рівні в одному файлі. Однак я не зміг знайти рішення імпортувати лише потрібні функції в боти. Тобто без використання імпорту та експорту.

У вашому tsconfig.json в корені

{
    "files": [],
    "references": [
        { "path": "./lib" }
        { "path": "./AggroMiner" }
        { "path": "./ArtilleryMicro" }
        { "path": "./MissileKite" }
        { "path": "./SmartMelee" }
        { "path": "./ZapKite" }
    ]
}

Далі в папку lib додайте tsconfig.json так

{
  "compilerOptions": {
    "declaration": true,
    "declarationMap": true,
    "composite": true,
    "rootDir": ".",
    "outFile": "../build/lib.js",
    "target": "es3",
    "removeComments": true,
    "sourceMap": false,
  },
  "files": [
    "data.ts",
    "movement.ts",
    "utils.ts"
  ]
}

Нам потрібно внести декілька налаштувань у data.ts, motion.ts та utils.ts, щоб ts не заважав нам помилкам компіляції.

data.ts

/// <reference path="./bot.land.d.ts"/>

(...)

рух.ц

/// <reference path="./data.ts"/>
/// <reference path="./utils.ts"/>
(...)

utils.ts

/// <reference path="./bot.land.d.ts"/>
(...)

Далі ми додаємо base.json в корінь (tsconfig.json ботів розширить його).

base.json

{
  "compilerOptions": {
    "declaration": true,
    "composite": true,
    "rootDir": ".",
    "target": "es3",
    "removeComments": true,
    "sourceMap": false,
  }
}

і tsconfig.json для ботів (адаптувати відповідно до ботів)

{
  "extends": "../base",
  "compilerOptions": {
    "outFile": "../build/AggroMiner.js",
  },
  "files": [
    "AggroMiner.ts"
  ],
  "references": [
      { "path": "../lib", "prepend": true } //note the prepend: true
  ]
}

Це воно. Тепер просто біжи

tsc -b