Have ideas to improve npm?Join in the discussion! »

    gulp-use-tsconfig

    1.5.3 • Public • Published

    gulp-useTsConfig

    Yet another typescript plugin. This one remove the boilerplate of using gulp-typeScript. For example, you can generate sourceMap without the burden of configuration gulp-sourcemaps plugin: you provide this plugin with a valid tsconfig.json, from your build task call useTsConfig build() and... you've done.

    Example

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

    Watch

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

    const gulp = require('gulp');
    const useTsConfig = require('gulp-use-tsconfig');
    
    const tsConfig = './tsconfig.json';
    
    gulp.task('watch', function() {
      return gulp.src(tsConfig)
        .pipe(useTsConfig.watch());
    });

    Lint

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

    gulp.task('lint', function() {
      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', function() {
      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.

    Restrictions:

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

    License

    MIT

    Install

    npm i gulp-use-tsconfig

    DownloadsWeekly Downloads

    297

    Version

    1.5.3

    License

    MIT

    Unpacked Size

    15 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar