Logo for jsDocs.io

gulp-tslint

  • Version 8.1.4
  • Published
  • 24.3 kB
  • 6 dependencies
  • MIT license

Install

npm i gulp-tslint
yarn add gulp-tslint
pnpm add gulp-tslint

Overview

TypeScript linter Gulp plugin

Index

Variables

Interfaces

Variables

variable tslintPlugin

const tslintPlugin: TslintPlugin;

  • Main plugin function

    Parameter pluginOptions

    contains the options for gulp-tslint. Optional.

    Returns

    {any}

Interfaces

interface PluginOptions

interface PluginOptions {}

    property configuration

    configuration?: any;

      property fix

      fix?: boolean;

        property formatter

        formatter?: string | Function;

          property formattersDirectory

          formattersDirectory?: string;

            property program

            program?: any;

              property rulesDirectory

              rulesDirectory?: string;

                property tslint

                tslint?: any;

                  interface ReportOptions

                  interface ReportOptions {}

                    property allowWarnings

                    allowWarnings?: boolean;

                      property emitError

                      emitError?: boolean;

                        property reportLimit

                        reportLimit?: number;

                          property summarizeFailureOutput

                          summarizeFailureOutput?: boolean;

                            interface TslintFile

                            interface TslintFile {}

                              property contents

                              contents: Buffer | any;

                                property path

                                path: string;

                                  property relative

                                  relative: string;

                                    property tslint

                                    tslint: any;

                                      method isNull

                                      isNull: () => boolean;

                                        method isStream

                                        isStream: () => boolean;

                                          interface TslintPlugin

                                          interface TslintPlugin {}

                                            property pluginOptions

                                            pluginOptions: PluginOptions;

                                              property report

                                              report: (options?: ReportOptions) => NodeJS.ReadWriteStream;

                                                call signature

                                                (pluginOptions?: PluginOptions): NodeJS.ReadWriteStream;

                                                  Package Files (1)

                                                  Dependencies (6)

                                                  Dev Dependencies (8)

                                                  Peer Dependencies (1)

                                                  Badge

                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/gulp-tslint.

                                                  • Markdown
                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/gulp-tslint)
                                                  • HTML
                                                    <a href="https://www.jsdocs.io/package/gulp-tslint"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>