node package manager
Don’t reinvent the wheel. Reuse code within your team. Create a free org »

gulp-use-tsconfig

gulp-useTsConfig

Yet another typescript plugin. This one remove the boilerplate of using gulp-typeScript. For example, you can generate sourceMap without using any extra gulp-sourcemaps plugin. You provide it with a valid tsconfig.json and that's it.

New in 1.1.2:

  • Update dependencies
  • Update eslint config
  • Use only LF in source files

New in 1.1.1:

  • fix filter & outDir computing

New in 1.1.0:

  • lint support

Example

const gulp = require('gulp');
const useTsConfig = require('gulp-use-tsconfig');
 
const tsConfig = './tsconfig.json';
 
gulp.task('lint', () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.lint());
});
 
gulp.task('pre-build', () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.clean()); // Remoce all .js; .map and .d.ts files 
});
 
gulp.task('build', ['lint', 'pre-build'], () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.build());// generates .js and optionaly .map anod/or .d.ts files 
});
 
gulp.task('default', ['build']);

Install

npm install --save gulp-use-tsconfig

Usage

Build

"Pipes" your tsconfig to the plugin and call build method:

const gulp = require('gulp');
const useTsConfig = require('gulp-use-tsconfig');
 
const tsConfig = './tsconfig.json';
 
gulp.task('build', ['pre-build'], () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.build());// generates .js and optionaly .map anod/or .d.ts files 
});

gulp-use-tsconfig analyses your tsconfig.json and does the job.

Clean

"Pipes" your tsconfig to the plugin and call clean method:

const gulp = require('gulp');
const useTsConfig = require('gulp-use-tsconfig');
 
const tsConfig = './tsconfig.json';
 
gulp.task('pre-build', () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.clean()); // Remoce all .js; .map and .d.ts files 
});

Lint

"Pipes" your tsconfig to the plugin and call lint method:

gulp.task('lint', () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.lint());
});

Lint accepts an object configuration, with two properties:

{
  tsLintOptions : configuration of gulp-tsLint
  reporterOptions: configuration of gulp-tsLint reporter
}

Click here for more information about tslint

Another example using some configuration options:

gulp.task('lint', () => {
  return gulp.src(tsConfig)
    .pipe(useTsConfig.lint(
      {
        tsLintOptions: {
          formatter: 'prose',
        },
        reporterOptions: {
          summarizeFailureOutput: false,
          emitError: false,
        },
      }
    ));
});

Tsconfig.json

Folowing optons of tsconfig.json is directly managed by gulp-useTsConfig:

  • rootDir the root location of typescript files. Default: tsconfig.json location
  • include list of glob files to include. Default: none
  • files files to include. Default: none
  • allowJs If true, also inclue **/*.js and **/*.jsx. Default: false
  • exclude files to exclude. Default: none
  • outDir Output directory. Default: Default: tsconfig.json location
  • sourceMap Generates corresponding .map file. Default: false
  • inlineSourceMap Emit a single file with source maps instead of having a separate file. Default false
  • inlineSources Emit the source alongside the sourcemaps within a single file; requires. Default false
  • mapRoot Specifies the location where debugger should locate map files instead of generated locations. Default: undefined
  • declaration Generates corresponding .d.ts file. Default: false
  • declarationDir Output directory for generated .d.ts file. Default: undefined

If the "files" and "include" are both left unspecified, the compiled files are **/*.ts, **/*.d.ts and **/*.tsx.

Sorry, but outFile is not supported yet.

Restrictions:

Requires Node 6.0.0 or upper. Require typescript 2.x or upper.

License

MIT