Détail du package

tsc-dts-fix

antongolub75MIT0.1.19

Applies some fixes to libdefs produced with tsc

readme

tsc-dts-fix

Applies some fixes to libdefs (d.ts) produced with tsc

lcov npm

Problem

Despite the fact that TS is actively developed, there are still a number of problems with its tsc compiler. In some situations, generated bundles require modification to work correctly in runtime. Other issues affect typings. This library is aimed to provide a workaroud for couple of them:

  1. Extra extensions in modules declarations force dependent projects to partially inherit tsconfig rules.
    <summary>Example</summary>

coderef-1

// a.ts
export * from './b.ts'
// b.ts
export const b = 'b'
// index.ts
export * from './a.ts'

tsc --emitDeclarationOnly --allowImportingTsExtensions

gives several dts:

// a.d.ts
export * from './b.ts'
// b.d.ts
export const b = 'b'
// index.d.ts
export * from './a.ts'

Meanwhile, coderef-2

export * from 'allow-ts-ext'

tsc --emitDeclarationOnly

1:15 - error TS5097: An import path can only end with a '.ts' extension when 'allowImportingTsExtensions' is enabled.
1 export * from './a.ts'
                ~~~~~~~~
Found 2 errors in 2 files.
Errors  Files
     1  ../allow-ts-ext/a.ts:1
     1  ../allow-ts-ext/index.ts:1

  1. Merging dts may cause name conflicts between local and external modules.
  2. https://github.com/microsoft/TypeScript/issues/4433
  3. https://stackoverflow.com/questions/75608981/get-rid-of-folder-prefix-in-declare-module-typescript-type-files
<summary>Example</summary> coderef ts // depseek.ts export const foo = 'bar' // index.ts export {foo} from './depseek' export {depseek} from 'depseek' shell tsc --emitDeclarationOnly --declaration --outFile index.d.ts gives: ts declare module "index" { export {foo} from "depseek"; export {depseek} from "depseek"; }

Solution

While the dts-bundle-generator and dts-bundle projects are focused on deep restructuring of declarations, I would still like to keep tsc as libdefs producer and assist it make some minor adjustments to module paths resolution:

  • fix relative paths
  • remap extensions
  • explicitly declare pkg entrypoints

Status

Working draft

Install

yarn add tsc-dts-fix -D

Usage

JS API

import {generateDts} from 'tsc-dts-fix'

const declarations = generateDts({
  input: 'index.ts',      // Compilation entrypoint: string | string[]
  compilerOptions: {},    // Standard ts.CompilerOptions,
  strategy: 'separate',   // Generator strategy:
                          //   'separate' – formats libdefs as separate files,
                          //   'bundle' – uses tsc to produce single dts file via `outFile` param,
                          //   'merge' – assembles separate dts chunks into single file.
  ext: '',                // Extension to remap, for ex '.js', '.cjs'.
                          // Default is '' which means to remove any existent. If `undefined`, no effect
  pkgName: 'pkg-name',    // Package name to prepend to module declarations.
  entryPoints: {
    '.': 'index.ts',      // Entry points map.
    '/cli': 'cli.ts'
  },
  conceal: true           // Restrict access to internal modules (technically replaces their names with randoms).
})

CLI

tsc-dts-fix --strategy='merge' --pkg-name='@foo/bar'

Alternatives

License

MIT