TypeScript tslint.Linter類代碼示例

function lint(dir: string): void {
  const options = {
    rulesDirectory: join(paths.base_dir, "tslint", "rules"),
    formatter: "stylish",
    fix: argv.fix || false,
  }

  const program = Linter.createProgram(join(dir, "tsconfig.json"))
  const linter = new Linter(options, program)
  const files = Linter.getFileNames(program)

  for (const file of files) {
    const config = Configuration.findConfiguration("./tslint.json", file).results
    const contents = program.getSourceFile(file)!.getFullText()
    linter.lint(file, contents, config)
  }

  const result = linter.getResult()

  if (result.errorCount != 0) {
    for (const line of result.output.trim().split("\n"))
      log(line)

    if (argv.emitError)
      process.exit(1)
  }
}

function lint(dir: string): void {
  for (const file of scan(dir, [".ts"])) {
    const options = {
      rulesDirectory: join(paths.base_dir, "tslint", "rules"),
      formatter: "stylish",
      fix: argv.fix || false,
    }

    const linter = new Linter(options)
    const config = Configuration.findConfiguration("./tslint.json", file).results
    linter.lint(file, read(file)!, config)
    const result = linter.getResult()

    if (result.errorCount != 0) {
      for (const line of result.output.trim().split("\n"))
        log(line)
    }
  }
}

export default function lint() {
  const program = tslint.Linter.createProgram("./tsconfig.json");
  return gulp.src([project.transpiler.source])
    .pipe(gulpTsLint({
      tslint: tslint,
      formatter: 'prose',
      program: program
    }))
    .pipe(gulpTsLint.report());
}

  /** Runs TSLint with the no-template-variable TSLint rule.*/
  function runTSLint() {
    const program = Linter.createProgram(join(tmpDir, 'tsconfig.json'));
    const linter = new Linter({fix: false, rulesDirectory: [rulesDirectory]}, program);
    const config = Configuration.parseConfigFile(
        {rules: {'no-template-variable-assignment': true}, linterOptions: {typeCheck: true}});

    program.getRootFileNames().forEach(fileName => {
      linter.lint(fileName, program.getSourceFile(fileName) !.getFullText(), config);
    });

    return linter;
  }

  /**
   * Runs TSLint with the static-query timing TSLint rule. By default the rule fixes
   * are automatically applied.
   */
  function runTSLint(fix = true) {
    const program = Linter.createProgram(join(tmpDir, 'tsconfig.json'));
    const linter = new Linter({fix, rulesDirectory: [rulesDirectory]}, program);
    const config = Configuration.parseConfigFile(
        {rules: {'explicit-query-timing': true}, linterOptions: {typeCheck: true}});

    program.getRootFileNames().forEach(fileName => {
      linter.lint(fileName, program.getSourceFile(fileName) !.getFullText(), config);
    });

    return linter;
  }

export async function tslintAsync() {
  const program = Linter.createProgram('tsconfig.json');
  const linter = new Linter(lintOptions, program);

  // note: normally dependencies aren't part of your source files, but if you
  // import a file from a dependency (e.g. `import "cool-package/foo"`) this
  // will be in your files array → that's why we need `.filter(isSourceFile)`
  const files = Linter.getFileNames(program).filter(isSourceFile);

  files.forEach(file => {
    const fileContents = program.getSourceFile(file).getFullText();
    const conf = Configuration.findConfiguration(configPath, file).results;
    linter.lint(file, fileContents, conf);
  });

  const result = linter.getResult();
  const errors = result.output;
  const errorsCount = result.errorCount;
  const fixedFiles = uniq((result.fixes || []).map(({ fileName }) => fileName));

  return { errors, errorsCount, fixedFiles };
}

/**
 * A helper function for specs. Lints the given `source` string against the `ruleName` with
 *  `options`.
 *
 *  You're unlikely to use these in actual specs. Usually you'd use some of the following:
 *    - `assertAnnotated` or
 *    - `assertSuccess`.
 *
 * @param ruleName the name of the rule which is being tested
 * @param source the source code, as a string
 * @param options additional options for the lint rule
 * @returns {LintResult} the result of linting
 */
function lint(ruleName: string, source: string | ts.SourceFile, options: any): tslint.LintResult {
  let configuration = {
    extends: [],
    rules: new Map<string, Partial<tslint.IOptions>>(),
    jsRules: new Map<string, Partial<tslint.IOptions>>(),
    rulesDirectory: []
  };
  if (!options) {
    options = [];
  }
  const ops: Partial<tslint.IOptions> = { ruleName, ruleArguments: options, disabledIntervals: [] };
  configuration.rules.set(ruleName, ops);
  const linterOptions: tslint.ILinterOptions = {
    formatter: 'json',
    rulesDirectory: './dist/src',
    formattersDirectory: null,
    fix: false
  };

  let linter = new tslint.Linter(linterOptions, undefined);
  if (typeof source === 'string') {
    linter.lint('file.ts', source, configuration);
  } else {
    const rules = loadRules(convertRuleOptions(configuration.rules), linterOptions.rulesDirectory, false);
    const res = [].concat.apply([], rules.map(r => r.apply(source))) as tslint.RuleFailure[];
    const errCount = res.filter(r => !r.getRuleSeverity || r.getRuleSeverity() === 'error').length;
    return {
      errorCount: errCount,
      warningCount: res.length - errCount,
      output: '',
      format: null,
      fixes: [].concat.apply(res.map(r => r.getFix())),
      failures: res
    };
  }
  return linter.getResult();
}

/**
 * Runs TSLint on source files.
 */
export default function taskTslint(settings: IGulpSettings): any {
    "use strict";

    const gulpTslint = require("gulp-tslint");
    const tslint = require("tslint");

    const program = tslint.Linter.createProgram(Constants.files.src.tsconfig);

    return settings.gulp
        .src(
            [
                `${Constants.folders.src}/**/*.ts`,
                `!${Constants.folders.src}/**/*.d.ts`
            ],
            {
                base: "."
            })
        .pipe(gulpTslint({
            formatter: "verbose",
            program
        }))
        .pipe(gulpTslint.report());
}

const lintingFailures = absolutePathToFiles.reduce<RuleFailure[]>((failures, absPath) => {
  const source = fs.readFileSync(absPath, 'utf8')
  linter.lint(absPath, source, configuration)
  const results = linter.getResult()

  if (results.failureCount > 0) {
    return failures.concat(results.failures)
  } else {
    return failures
  }
}, [] as RuleFailure[])

    workSet.forEach(fileName => {
      cancellationToken.throwIfCancellationRequested();

      try {
        this.linter.lint(fileName, undefined, this.linterConfig);
      } catch (e) {
        if (
          fs.existsSync(fileName) &&
          // check the error type due to file system lag
          !(e instanceof Error) &&
          !(e.constructor.name === 'FatalError') &&
          !(e.message && e.message.trim().startsWith('Invalid source file'))
        ) {
          // it's not because file doesn't exist - throw error
          throw e;
        }
      }
    });