Giter VIP home page Giter VIP logo

typescript_custom_dts_issue's Introduction

Migrating Legacy JS Node Modules to TypeScript with Custom Type Definitions

This is a simple repository to demonstrate using TypeScript custom type definitions (.d.ts files) to help transition a JavaScript Node project to TypeScript.

Unfortunately, there is a TypeScript issue that prevents the TypeScript compiler from emitting custom type definitions from the input files to the output directory.

Build and Run

npm install
npm test

You will notice that npm test exits with an error because the script attempts to build the test TypeScript project, which references the src TypeScript project. The test project depends on the custom type definition in src, which the compiler does not emit to the src output directory, lib, so test fails to compile.

Build and Run with Custom Types

rm -rf lib test-lib
npm run test_with_types

The test_with_types script includes a step that copies the custom type definition files from src to lib. Now you will see that the the project builds correctly. However, this build requires an explicit compilation of src, then copying the .d.ts files, then compiling test, which defeats the purpose of project references with the -b flag for incremental builds.

typescript_custom_dts_issue's People

Contributors

restjohn avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.