Как использовать файл Common JS для tsconfig. json?

Question

Множество систем (Mocha, ESLint, NY C) дают вам возможность выбрать, в каком формате вы будете sh в своем файле конфигурации (commonjs / js, json, yml, et *) 1014 *).

Это может быть полезно, поскольку в Common JS (с использованием module.exports) вы можете иметь комментарии в файле конфигурации или другом коде в файле конфигурации, что обеспечивает большую гибкость.

Есть ли способ сделать это в TypeScript и использовать Common JS или module.exports, чтобы определить файл tsconfig, а не просто файл json?

Answer 1

Я бы оставил tsconfig.json как json и добавил бы необходимые комментарии, например, в README.md.

Другой вариант - добавить комментарии в json, например:

// tsconfig.json
{
  "//comment": "comment content",
  "compilerOptions": {
    ...
  },
}

Если вам нужна большая гибкость, вы можете добавить шаг сборки для генерации tsconfig.json из файла. js.

// tsconfig.js
// comments or code here

module.exports = {
  "compilerOptions": {
    "module": "commonjs",
  },
};

// tsconfigBuilder.js

const fs = require('fs');
const config = require('./tsconfig');

fs.writeFileSync('./tsconfig.json', JSON.stringify(config, null, 2));

Добавить скрипт в package.json для генерации tsconfig.json от tsconfig.js до шага компилятора.

// package.json

  "scripts": {
    "build-tsconfig": "node tsconfigBuilder.js",
    ...
  },

И все готово.