Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

typescript-cached-transpile

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typescript-cached-transpile

[![npm version](https://badge.fury.io/js/typescript-cached-transpile.svg)](https://badge.fury.io/js/typescript-cached-transpile)

  • 0.0.1
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

typescript-cached-transpile

npm version

Monkey-patches the TypeScript compiler to use a disk cache for transpileModule.

Intended for use solely with ts-node in transpileOnly mode. It'll make things faster.

TS_NODE_TRANSPILE_ONLY=true TS_NODE_COMPILER=typescript-cached-transpile ts-node ./src/index.ts

When required, it returns a monkey-patched version of the peer typescript module. The only change is the transpileModule function. It will cache results on disk, so subsequent invocations should be much faster.

Caching requires, and will only work, when the following requirements are met:

  • no transformers
  • no diagnostics returned by the compiler
  • compiler version is the same
  • filename is the same
  • source code is the same
  • config object is the same, as determined by serializing to JSON and sha1 hashing
  • using transpileModule. Won't work if you're type-checking. (do that separately, e.g. tsc --noEmit)

If you need to programmatically customize the behavior, put your customizations in a JS file:

./my-cached-compiler.js
const {create} = require('typescript-cached-transpile');
module.exports = create({
    /* options here */
});

...and pass the absolute path to that file as ts-node's compiler option.

TS_NODE_TRANSPILE_ONLY=true TS_NODE_COMPILER=$PWD/my-cached-compiler.js ts-node ./src/index.ts

The cache directory can be set via environment variable TS_CACHED_TRANSPILE_CACHE. It should be an absolute path to avoid gotchas.

TS_NODE_TRANSPILE_ONLY=true TS_CACHED_TRANSPILE_CACHE=$PWD/.cache ts-node ./src/index.ts

FAQs

Package last updated on 11 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc