@moped/rule-ts

This module provides a sensible rule for handling typescript in webpack applications. It is part of the moped suite of utilities for creating composable configs for building node.js and react apps.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@moped/rule-ts
Minified + gzip package size for @moped/rule-ts in KB

Readme

rule-ts

This module provides a sensible rule for handling typescript in webpack applications. It is part of the moped suite of utilities for creating composable configs for building node.js and react apps.

In development, the result of transforming typescript files are cached in .cache/typescript and the transformation is parallelised across multiple threads. This also means that it does not type check in development. In production, it takes the slower approach of compiling every file individually. This is necessary to alow const enums to be stripped from the output.

Installation

yarn add --dev @moped/rule-ts

Usage

const createTsRule = require('@moped/rule-ts');

module.exports = {
  entry: __dirname + '/src/index.ts',
  output: {
    path: __dirname + '/build',
    filename: 'static/js/[name].[chunkhash:8].js',
    publicPath: '/',
  },
  resolve: {
    extensions: ['.ts', '.tsx', '.js', '.json'],
  },
  module: {
    rules: [createTsRule()],
  },
};

Usage with rule-file and rule-css

To use with other loaders, you have two options. You can use require instead of ES imports, this will effectively just give you an any. Alternatively, you can add a declaration for the type of module you want to import. e.g.

declare module '*.png' {
  export= string;
}

The wildcard allows this to match all .png files.

Type checking in development

To maximise reload times, this module does not actually do any type checking in development. You can use ForkTsCheckerWebpackPlugin in development to add type checking, without compromising build time.

Options

Options.environment

This can be 'development', 'production' or 'test'. If you don't provide it, it will default to the value of NODE_ENV. If neither are specified, an exception will be thrown. It will also throw an exception if any value other than 'development', 'production' and 'test' is used.

Options.srcDirectory

This is the directory that your source code lives in, it should not include your node_modules folder. It will default to src. Files outside of this folder are not transformed.

Options.babelPresets

An array of file names for babel presets. If you add this option, babel will be used to transform the code after it has been transformed by typescript. If you do not add this option, the code is only transformed by typescript. The babel transform will never use babelrc files.

Options.tsConfigFileName

The filename for your tsconfig file.

Options.tsCompilerOptions

Overrides for the compilerOptions section of your tsconfig. @moped/rule-ts automatically enables preserveConstEnums in development.

Options.disableSourceMaps

If you are building a very large application, generating source maps may become too slow, and might not be worth it. You can use this option to disable source maps. You can alternatively set the GENERATE_SOURCEMAP environment variable to false (this option is for compatibility with create-react-app).

Options.workers

If you have a very large number of modules, and a computer with many cores, you can pass a number of workers to make typescript compilation multi-threaded. This is not enabled by default, because it has a very big overhead. When I've experimented with this, it's usually been faster to leave it turned off.

N.B. If you enable workers, it is still only used in development. Also, workers prevent this module from reporting syntax errors, so you will need to use new ForkTsCheckerWebpackPlugin({ checkSyntacticErrors: true }) instead of new ForkTsCheckerWebpackPlugin() if using ForkTsCheckerWebpackPlugin.

Licence

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.