@moebius/ts-compiler-options

TypeScript Compiler Options Types

TypeScript declarations doesn't provide proper types for CompilerOptions that can be used to describe content of tsconfig.json file, instead, they provide internal representation of CompilerOptions, where enum values must be specified using numbers instead of strings. This modules closes this gap.

Typings in this module are based on both typings provided by TypeScript as well as official documentation.

If it's not working for your configuration or TypeScript version, please, create an issue.

Features

• provides CompilerOptions type that describes external compiler options as they are specified in tsconfig.json file and in online documentation with string enum values

• provides convertCompilerOptions utility function that converts compiler options from one format to another (both ways)

Installation

As development dependency

npm i -D @moebius/ts-compiler-options

As production dependency

npm i -S @moebius/ts-compiler-options typescript

Peer Dependencies

typescript package must be also installed in your project (we treat it as a peer dependency).

Usage

import {
  CompilerOptions,
  convertCompilerOptions,
  JsxEmit,
  ModuleKind,
  ModuleResolutionKind,
  NewLineKind,
  ScriptTarget,

} from '@moebius/ts-compiler-options';

const myOptions: CompilerOptions = {
  jsx: JsxEmit.React,
  module: ModuleKind.ES2015,
  moduleResolution: ModuleResolutionKind.Classic,
  newLine: NewLineKind.CarriageReturnLineFeed,
  outDir: '/dist',
  strict: true,
  target: ScriptTarget.ES2018,
};

console.log({ myOptions });

// Will produce:
//
// myOptions: {
//   jsx: 'react',
//   module: 'ES2015',
//   moduleResolution: 'Classic',
//   newLine: 'crlf',
//   outDir: '/dist',
//   strict: true,
//   target: 'ES2018',
// },
//

const convertedOptions = convertCompilerOptions(
  'external-to-internal',
  myOptions
);

console.log({ convertedOptions });

// Will produce:
//
// convertedOptions: {
//   jsx: 2,
//   module: 5,
//   moduleResolution: 1,
//   newLine: 0,
//   outDir: '/dist',
//   strict: true,
//   target: 5,
// },
//

const internalOptions = convertCompilerOptions(
  'internal-to-external',
  convertedOptions
);

// Will produce the same result as in first example
console.log({ internalOptions });

Support

If this library is useful to you, please add a star on GitHub repository.

Thank you!

License

The MIT License (MIT)

Copyright (c) 2019, MOEBIUS FOUNDATION, Slava Fomin II

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.