在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):panuhorsmalahti/gulp-tslint开源软件地址(OpenSource Url):https://github.com/panuhorsmalahti/gulp-tslint开源编程语言(OpenSource Language):JavaScript 69.0%开源软件介绍(OpenSource Introduction):gulp-tslintTypeScript linter plugin for Gulp. First install gulp-tslint npm install --save-dev gulp-tslint Peer dependenciesThe Usage: // Importing in ES6
import tslint from "gulp-tslint";
// or requiring in ES5
var tslint = require("gulp-tslint");
gulp.task("tslint", () =>
gulp.src("source.ts")
.pipe(tslint({
formatter: "verbose"
}))
.pipe(tslint.report())
); Types should work automatically. tslint.json is attempted to be read from near the input file. It must be available or supplied directly through the options. Failures generated by TSLint are added to The format in which failures are outputted may be controlled by specifying a TSLint formatter. The default formatter is "prose". The available formatters include:
Custom TSLint formatters may also be
used by specifying the If upgrading to gulp-tslint v6.0.0 or greater, it should be noted that reporters have been removed
in favour of using TSLint formatters directly. If you were previously specifying a reporter in calls
to If there is at least one failure a PluginError is emitted after execution of the reporters: [gulp] Error in plugin 'gulp-tslint': Failed to lint: input.ts You can prevent emiting the error by setting emitError in report options to false. gulp.task("invalid-noemit", () =>
gulp.src("input.ts")
.pipe(tslint({
formatter: "prose"
}))
.pipe(tslint.report({
emitError: false
}))
); You can summarize the gulp error message to the number of errors by setting summarizeFailureOutput in report options. gulp.task("invalid-noemit", () =>
gulp.src("input.ts")
.pipe(tslint({
formatter: "prose"
}))
.pipe(tslint.report({
summarizeFailureOutput: true
}))
); tslint.json can be supplied as a parameter by setting the configuration property. gulp.task("tslint-json", () =>
gulp.src("input.ts")
.pipe(tslint({
configuration: {
rules: {
"class-name": true,
// ...
}
}
}))
.pipe(tslint.report())
); You can also supply a file path to the configuration option, and the file name doesn't need to be tslint.json. .pipe(tslint({
// contains rules in the tslint.json format
configuration: "source/settings.json"
})) Report limitsYou can optionally specify a report limit in the .report options that will turn off reporting for files after the limit has been reached. If the limit is 0 or less, the limit is ignored, which is the default setting. gulp.task("tslint", () =>
gulp.src(["input.ts",])
.pipe(tslint({
formatter: "prose"
}))
.pipe(tslint.report({
reportLimit: 2
}))
); Allowing WarningsTSLint 5.0 introduced support for a "warning" severity for linting errors. By default, warnings cause gulp.task("tslint", () =>
gulp.src("input.ts")
.pipe(tslint({
formatter: "prose"
}))
.pipe(tslint.report({
allowWarnings: true
}))
); Specifying the tslint moduleIf you want to use a different version of tslint, you can supply it with the npm install tslint@next .pipe(tslint({
tslint: require("tslint")
})); Type checked rulesType checked rules require a TypeScript program object to be provided to the linter in the options. For more information see tslint documentation. var gulpTslint = require("gulp-tslint");
var tslint = require("tslint");
// NOTE: Ensure 'Linter.createProgram' is called inside the gulp task else the contents of the files will be cached
// if this tasks is called again (eg. as part of a 'watch' task).
gulp.task('lint', function() {
var program = tslint.Linter.createProgram("./tsconfig.json");
return gulp.src('src/**/*.ts', { base: '.' })
.pipe(gulpTslint({ program }));
} All default tslint optionsconst tslintOptions = {
configuration: {},
fix: false,
formatter: "prose",
formattersDirectory: null,
rulesDirectory: null,
tslint: null,
program: null
}; All default report optionsconst reportOptions = {
emitError: true,
reportLimit: 0,
summarizeFailureOutput: false,
allowWarnings: false
}; DevelopmentFork this repository, run npm install and send pull requests. The project can be build with |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论