rule.d.ts 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. import * as ts from "typescript";
  2. import { RuleWalker } from "../walker/ruleWalker";
  3. export interface IOptions {
  4. ruleArguments?: any[];
  5. ruleName: string;
  6. disabledIntervals: IDisabledInterval[];
  7. }
  8. export interface IDisabledInterval {
  9. startPosition: number;
  10. endPosition: number;
  11. }
  12. export interface IRule {
  13. getOptions(): IOptions;
  14. isEnabled(): boolean;
  15. apply(sourceFile: ts.SourceFile): RuleFailure[];
  16. applyWithWalker(walker: RuleWalker): RuleFailure[];
  17. }
  18. export declare class RuleFailurePosition {
  19. private position;
  20. private lineAndCharacter;
  21. constructor(position: number, lineAndCharacter: ts.LineAndCharacter);
  22. getPosition(): number;
  23. getLineAndCharacter(): ts.LineAndCharacter;
  24. toJson(): {
  25. character: number;
  26. line: number;
  27. position: number;
  28. };
  29. equals(ruleFailurePosition: RuleFailurePosition): boolean;
  30. }
  31. export declare class RuleFailure {
  32. private sourceFile;
  33. private fileName;
  34. private startPosition;
  35. private endPosition;
  36. private failure;
  37. private ruleName;
  38. constructor(sourceFile: ts.SourceFile, start: number, end: number, failure: string, ruleName: string);
  39. getFileName(): string;
  40. getRuleName(): string;
  41. getStartPosition(): RuleFailurePosition;
  42. getEndPosition(): RuleFailurePosition;
  43. getFailure(): string;
  44. toJson(): any;
  45. equals(ruleFailure: RuleFailure): boolean;
  46. private createFailurePosition(position);
  47. }